Neynar Documentation

Parse the Sign In With Farcaster URI

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

Parameter	Type	Description	Required
`uri`	`string`	Sign 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
}

Parameter	Description
`channelToken`	Connect relay channel token.
`params.uri`	Login URI of the relying connected app.
`params.domain`	Domain of the relying app.
`params.nonce`	Random nonce provided by the relying app.
`params.notBefore`	Time at which this message becomes valid.
`params.expirationTime`	Time at which this message expires.
`params.requestId`	A system specific identifier provided by the relying application.
`isError`	True when an error has occurred.
`error`	`Error` instance.