1auth SDK Documentation

Interactive documentation and live previews for the @1auth/sdk package. Click any component to see detailed documentation and code examples.

Guides

SDK Integration Guide

Complete guide to integrating the 1auth SDK into your application.

Merchant Authentication

How to authenticate your app to send intents and transactions.

Dialog API Reference

PostMessage protocol documentation for the dialog system.

React Components

Authenticate

Component

Interactive demo for passkey authentication and message signing.

PayButton

Component

A one-click payment button that handles authentication and intent signing automatically.

BatchQueueProvider

Component

Context provider for managing batched transaction queues with localStorage persistence.

BatchQueueWidget

Component

Floating widget UI showing queued transactions with sign-all functionality.

Hooks

useBatchQueue

Hook

Hook to access batch queue context for adding, removing, and signing batched calls.

Client

signTypedData

Client

Sign EIP-712 typed data with human-readable preview and verification.

PasskeyProviderClient

Client

Main SDK client for authentication, signing, and intent execution via passkeys.

createPasskeyWalletClient

Client

Create a viem-compatible WalletClient that uses passkeys for signing transactions.

Quick Start

Installation

pnpm add @1auth/sdk

Basic Usage

import { PasskeyProviderClient, PayButton } from '@1auth/sdk';

const client = new PasskeyProviderClient({
  providerUrl: 'https://auth.example.com',
  clientId: 'my-app',
});