Skip to content

status

Obtiene el estado actual de una solicitud de autenticación de Farcaster.

Devuelve el estado actual de la solicitud, ya sea 'pending' si la mini app de billetera de Farcaster del usuario aún no ha enviado una firma, o 'completed' una vez que la mini app de billetera ha devuelto una respuesta.

En el estado 'completed', la respuesta incluye el mensaje generado de "Iniciar sesión con Farcaster", una firma de la dirección de custodia del usuario, el fid verificado del usuario e información de su perfil.

ts
const status = await appClient.status({
  channelToken: '210f1718-427e-46a4-99e3-2207f21f83ec',
});

Parámetros

ParámetroTipoDescripciónRequeridoEjemplo
channelTokenstringToken de canal de Farcaster Auth.8d0494d9-e0cf-402b-ab0a-394ac7fe07a0

Retorna

ts
{
    response: Response
    data: {
      state: "pending";
      nonce: string;
    } | {
      state: "completed";
      nonce: string;
      url: string;
      message: string;
      signature: `0x${string}`;
      fid: number;
      username?: string;
      bio?: string;
      displayName?: string;
      pfpUrl?: string;
      verifications?: Hex[];
      custody?: Hex;
    }
    isError: boolean
    error: Error
}
ParámetroDescripción
responseRespuesta HTTP del servidor de retransmisión de Connect.
data.stateEstado de la solicitud de inicio de sesión, ya sea "pending" o "complete".
data.nonceNonce aleatorio utilizado en el mensaje SIWE. Si no proporcionas un nonce personalizado como argumento al hook, debes leer este valor.
data.messageEl mensaje SIWE generado.
data.signatureFirma hexadecimal producida por la billetera Warpcast del usuario.
data.fidID de Farcaster del usuario.
data.usernameNombre de usuario de Farcaster.
data.bioBiografía de Farcaster del usuario.
data.displayNameNombre para mostrar de Farcaster del usuario.
data.pfpUrlURL de la foto de perfil de Farcaster del usuario.
data.custodyDirección de custodia del FID del usuario.
data.verificationsLista de direcciones verificadas del usuario.
isErrorVerdadero cuando ha ocurrido un error.
errorInstancia de Error.