Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

Parse the Sign In With Farcaster URI provided by a connected app user. Returns the parsed parameters. Your app should use these to construct a Sign In With Farcaster message. Returns an error if URI is invalid. 
const params = walletClient.parseSignInURI({
  uri: 'farcaster://connect?channelToken=23W59BKK&nonce=ESsxs6MaFio7OvqWb&siweUri=https%3A%2F%2Fexample.com%2Flogin&domain=example.com',
});

​
Parameters

ParameterTypeDescriptionRequired
uristringSign In With Farcaster URI.Yes

​
Returns

{
  channelToken: string
  params: {
    domain: string
    uri: string
    nonce: string
    notBefore?: string
    expirationTime?: string
    requestId?: string
  }
  isError: boolean
  error: Error
}
ParameterDescription
channelTokenConnect relay channel token.
params.uriLogin URI of the relying connected app.
params.domainDomain of the relying app.
params.nonceRandom nonce provided by the relying app.
params.notBeforeTime at which this message becomes valid.
params.expirationTimeTime at which this message expires.
params.requestIdA system specific identifier provided by the relying application.
isErrorTrue when an error has occurred.
errorError instance.