@farcaster/quick-auth
TypeScript icon, indicating that this package has built-in type declarations

0.0.6 • Public • Published

@farcaster/quick-auth

A client for interacting with a Farcaster Quick Auth server.

Installation

npm install @auth-server/client
# or
yarn add @auth-server/client
# or
pnpm add @auth-server/client

Usage

import { createClient } from '@farcaster/quick-auth';

// Get a nonce
const domain = 'your-domain.com';
const client = createClient();
const nonce = await client.getNonce();

// Generate a SIWF message using nonce and domain (not shown)

// Verify a SIWF message and get a JWT token
const token = await client.verifySiwf({
  message,
  signature,
  domain
});

// Use the return JWT as an Bearer token and validate on your server
const token = await client.verifyToken({
  token,
  domain
});

Readme

Keywords

none

Package Sidebar

Install

npm i @farcaster/quick-auth

Weekly Downloads

8,679

Version

0.0.6

License

MIT

Unpacked Size

25.8 kB

Total Files

44

Last publish

Collaborators

  • sds
  • ecm_merkle
  • aditiharini
  • caheart_mm
  • varunsrin
  • daddeo
  • sanjayprabhu