Create Wallet

Create a wallet using Crossmint’s APIs

Prerequisites

• API Key: Ensure you have an API key with the scopes: wallets.create.

Create a Wallet

React

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

const { getOrCreateWallet } = useWallet();

const wallet = await getOrCreateWallet({
    chain: "solana",
    signer: {
        type: "email",
        email: "[e-mail]"
    },
});

Parameters

chain · string · required

The chain to use the wallet on.

See all supported chains for more details. On staging only testnet chains are supported.

Note: For EVM-compatible chains, wallets are created for all chains as part of the shared address space derived from the same private key. However, to interact with a specific chain using the SDK, you must instantiate a wallet object per chain. This allows the SDK to correctly route interactions to the appropriate network configuration.

signer · Signer · required

The signer to use the wallet with.

alias · string

An optional identifier for the wallet, used to organize multiple wallets on the same chain.

Aliases are:

• Unique per wallet type and chain.
• Must use only lowercase letters, numbers, underscores, or hyphens (a-z, 0-9, _, -).
• No spaces or empty strings allowed.

Examples: trading, long-term-holdings, treasury

options · WalletOptions

The options to use the wallet with.

Show experimental_callbacks

A set of callbacks to be called when the wallet is created or a transaction is initiated.

Show properties

onWalletCreationStart · function

A function to be called when the wallet is about to be created.

onTransactionStart · function

A function to be called when a transaction is initiated.

Returns

wallet · Wallet

The created wallet.