Skip to content

webAuthn

Connector for a WebAuthn EOA.

Install

bash
pnpm add accounts@catalog:
bash
npm install accounts@catalog:
bash
yarn add accounts@catalog:
bash
bun add accounts@catalog:

Usage

wagmi.config.ts
ts
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { webAuthn } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [webAuthn()], 
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

Use webAuthn({ authUrl: '/api/webauthn' }) if you want registration and authentication challenges to come from a server endpoint instead of the default local browser ceremony.

webAuthn is a thin wagmi wrapper around the root accounts package.

Parameters

authUrl (optional)

  • Type: string

URL of a server-backed WebAuthn handler.

ceremony (optional)

  • Type: WebAuthnCeremony

Custom WebAuthn ceremony implementation.

icon (optional)

  • Type: `data:image/${string}`

Optional connector icon override.

name (optional)

  • Type: string

Optional connector display name.

rdns (optional)

  • Type: string

Optional reverse-DNS identifier.

authorizeAccessKey (optional)

  • Type: () => { expiry: number, ... }

Default access-key authorization parameters to attach to wallet_connect.

Released under the MIT License.