Providers

This page has been updated for Wallets SDK V1. If you are using the previous version, see the previous version of this page or the V1 migration guide.

CrossmintProvider — SDK initialization (required for all Crossmint features)
CrossmintWalletProvider — Wallet creation and management

CrossmintProvider

Props

string

required

Your Crossmint client-side API key.

string

Application identifier, sent as x-app-identifier header.

ConsoleLogLevel

Minimum log level for console output (or “silent” to suppress all output). Logs below this level will not be written to the console. Set to “silent” to completely suppress console output. Defaults to “debug” (all logs shown) for backward compatibility.

string

Extension identifier, sent as x-extension-id header.

string

JWT token for authentication.

string

Override the base API URL.

Usage

import { CrossmintProvider } from "@crossmint/client-sdk-react-ui";

function App() {
    return (
        <CrossmintProvider apiKey="YOUR_CLIENT_API_KEY">
            {/* Your app content */}
        </CrossmintProvider>
    );
}

CrossmintWalletProvider

Props

UIConfig

Appearance configuration for wallet UI components.

Show properties

string

UiConfigColors

Show properties

string

UiConfigFonts

Show properties

string

required

string

"normal" | "italic" | "oblique"

string

boolean

string

{ onTransactionStart?: () => Promise<void>; onWalletCreationStart?: () => Promise<void> }

Lifecycle callbacks for wallet creation and transaction events.

Show properties

() => Promise<void>

Configuration for automatic wallet creation on login.

Show properties

Chain

required

The blockchain to create the wallet on (e.g. “base-sepolia”).

SignerConfigForChain

required

The recovery signer configuration (e.g. { type: "email" }). Used for wallet recovery and adding new signers.

SignerConfigForChain[]

Optional array of operational signers. Defaults to a device signer if omitted (e.g. [{ type: "device" }]).

string

Optional wallet alias.

WalletPlugin[]

Optional array of wallet plugins.

boolean

When true (default), built-in OTP signer UI prompts are shown during signing flows. When false, signing flows must be handled manually via the useWalletOtpSigner hook. Default: true.

boolean

Whether to show passkey helper UI. Default: true.

Usage

import {
    CrossmintProvider,
    CrossmintWalletProvider,
} from "@crossmint/client-sdk-react-ui";

function App() {
    return (
        <CrossmintProvider apiKey="YOUR_CLIENT_API_KEY">
            <CrossmintWalletProvider
                createOnLogin={{
                    chain: "base-sepolia",
                    recovery: { type: "email" },
                }}
            >
                {/* Your app content */}
            </CrossmintWalletProvider>
        </CrossmintProvider>
    );
}

Note: CrossmintWalletProvider must be nested inside CrossmintProvider.

Introduction

Quickstarts ⚡️

Concepts

Guides

API Reference

CrossmintProvider

Props

Usage

CrossmintWalletProvider

Props

Usage

​CrossmintProvider

​Props

​Usage

​CrossmintWalletProvider

​Props

​Usage

CrossmintProvider

Props

Usage

CrossmintWalletProvider

Props

Usage