Hooks

React hooks for React SDK reference for Crossmint wallets

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.

useWallet()

Returns

createDeviceSigner · (address: string) => Promise<DeviceSignerConfig> | undefined

Creates a Device Signer

createPasskeySigner · (passkeyName: string) => Promise<RegisterSignerPasskeyParams>

Creates a Passkey Signer

createWallet · (props: ClientSideWalletCreateArgs<C>) => Promise<Wallet | undefined>

Creates a new wallet.

Show parameters

chain · Chain

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

recovery · SignerConfigForChain

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

signers · SignerConfigForChain[]

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

alias · string

Optional wallet alias.

plugins · WalletPlugin[]

Optional array of wallet plugins.

error · WalletContextError | null

Detail about the last failure, or null when there is no error.

getWallet · (props: Pick<ClientSideWalletArgsFor<C>, "chain" | "alias">) => Promise<Wallet | undefined>

Retrieves an existing wallet.

Show parameters

chain · Chain

The blockchain of the wallet to retrieve (e.g. “base-sepolia”).

alias · string

Optional wallet alias to look up.

status · "not-loaded" | "in-progress" | "loaded" | "error"

Current wallet status.

wallet · Wallet<Chain> | undefined

The current wallet instance, or undefined if no wallet is loaded.

Show parameters

constructor · unknown

address · string

alias · string

chain · C

owner · string

apiClient · unknown

recovery · unknown

signer · unknown

addSigner · unknown

approve · unknown

approveTransaction · unknown

balances · unknown

isSignerApproved · unknown

needsRecovery · unknown

nfts · unknown

recover · unknown

removeSigner · unknown

send · unknown

signerIsRegistered · unknown

signers · unknown

stagingFund · unknown

transaction · unknown

transactions · unknown

transfers · unknown

useSigner · unknown

waitForInit · unknown

Usage

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

function WalletActions() {
    const { wallet, status } = useWallet();

    if (status === "in-progress") return <p>Loading wallet...</p>;
    if (!wallet) return <p>No wallet</p>;

    const handleSend = async () => {
        const tx = await wallet.send("0x...", "usdc", "10");
        console.log("Transaction:", tx.explorerLink);
    };

    const handleBalances = async () => {
        const balances = await wallet.balances();
        console.log("USDC:", balances.usdc.amount);
        console.log("Native:", balances.nativeToken.amount);
    };

    return (
        <div>
            <p>Wallet: {wallet.address}</p>
            <button onClick={handleBalances}>Check Balances</button>
            <button onClick={handleSend}>Send USDC</button>
        </div>
    );
}

---

Wallet Methods

The wallet instance returned by useWallet() provides methods for token transfers, balances, signing, and more.

Since the React SDK wraps the Wallets SDK, see the Wallets SDK Reference for complete documentation.

Method	Description
wallet.addSigner()	Add a signer to the wallet. Always uses the recovery signer internally to approve the registration. If the signer being added is the current operational signer, it will be reassembled with the new locator. Otherwise, the original signer is restored after the operation.
wallet.balances()	Get the wallet balances - always includes USDC and native token (ETH/SOL)
wallet.isSignerApproved()	Check if a signer is approved and usable for the current wallet chain.
wallet.needsRecovery()	Whether the wallet needs recovery (signer registration) before the next transaction.
wallet.nfts()	Get the wallet NFTs
wallet.recover()	Register a device signer with the wallet using the recovery signer. Generates a new device key and registers it on-chain. Returns early if the device signer’s locator is already approved on-chain.
wallet.removeSigner()	Remove a signer from the wallet. Always uses the recovery signer internally to approve the removal.
wallet.send()	Send a token to a wallet or user locator
wallet.signerIsRegistered()	Check if a signer is registered in this wallet.
wallet.signers()	List the signers for this wallet. Returns full signer objects with status. For EVM wallets, only signers with an approval (pending or completed) for the wallet’s chain are included.
wallet.stagingFund()	Funds the wallet with Crossmint’s stablecoin (USDXM). Note: This method is only available in staging environments and exclusively supports USDXM tokens. It cannot be used in production environments.
wallet.transaction()	Get a transaction by id
wallet.transactions()	Get the wallet transactions
wallet.transfers()	Get the wallet transfers
wallet.useSigner()	Set the active signer for this wallet. Accepts a signer config object. The locator is inferred internally. Works for both registered signers and the recovery signer. For passkey signers: if no id is provided, the wallet will auto-select the passkey if exactly one passkey signer is registered. If multiple passkeys exist, an id must be specified. For device signers: if no device key is found locally, the signer will be created automatically during the next transaction (via recovery). For external-wallet signers: the config object must include an onSign callback (applies to both registered and recovery signers).
wallet.waitForInit()	Wait for the wallet’s internal signer initialization to complete. After this resolves, needsRecovery() reflects the true state.

Chain-specific:

• EVMWallet — getViemClient(), sendTransaction(), signMessage(), signTypedData()
• SolanaWallet — sendTransaction()
• StellarWallet — migrate(), sendTransaction(), upgrade()