Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt

Use this file to discover all available pages before exploring further.

You are viewing docs for the previous version of the Wallets SDK. We recommend upgrading to V1. See the updated version of this page or the V1 migration guide.
Defined in: packages/wallets/src/sdk.ts:9

​
Methods

​
createWallet()

createWallet<C>(options): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:54 Create a new wallet, can only be called on the server side

​
Type Parameters

Type Parameter
C extends Chain

​
Parameters

ParameterTypeDescription
optionsWalletArgsFor<C>Wallet options

​
Returns

Promise<Wallet<C>> A new wallet

​
getOrCreateWallet()

getOrCreateWallet<C>(options): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:35 Get or create a wallet, can only be called on the client side

​
Type Parameters

Type Parameter
C extends Chain

​
Parameters

ParameterTypeDescription
optionsWalletArgsFor<C>Wallet options

​
Returns

Promise<Wallet<C>> An existing wallet or a new wallet

​
getWallet()

getWallet<C>(walletLocator, options): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:45 Get an existing wallet by its locator, can only be called on the server side

​
Type Parameters

Type Parameter
C extends Chain

​
Parameters

ParameterTypeDescription
walletLocatorstringWallet locator
optionsWalletArgsFor<C>Wallet options

​
Returns

Promise<Wallet<C>> A wallet if found, throws WalletNotAvailableError if not found

​
from()

static from(crossmint): CrossmintWallets
Defined in: packages/wallets/src/sdk.ts:25 Initialize the Wallets SDK

​
Parameters

ParameterTypeDescription
crossmintCrossmintCrossmint data (use createCrossmint to initialize)

​
Returns

CrossmintWallets A new CrossmintWallets instance