Skip to content

signIn

Request a Sign in with Farcaster (SIWF) credential from the user.

See the guide on authenticating users.

signing in a user

A users opens an app and is automatically signed in

Usage

import { sdk } from '@farcaster/frame-sdk'
 
await sdk.actions.signIn({ 
  nonce 
})

Parameters

nonce

  • Type: string

A random string used to prevent replay attacks, at least 8 alphanumeric characters.

Return Value

The SIWF message and signature.

type SignInResult = {
  signature: string;
  message: string;
}