Methods

createWallet()

createWallet<C>(options): Promise<Wallet<C>>

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

Defined in

packages/wallets/src/sdk.ts:50


getOrCreateWallet()

getOrCreateWallet<C>(options): Promise<Wallet<C>>

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

Defined in

packages/wallets/src/sdk.ts:31


getWallet()

getWallet<C>(walletLocator, options): Promise<Wallet<C>>

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

Defined in

packages/wallets/src/sdk.ts:41


from()

static from(crossmint): CrossmintWallets

Initialize the Wallets SDK

Parameters

ParameterTypeDescription
crossmintCrossmintCrossmint data (use createCrossmint to initialize)

Returns

CrossmintWallets

A new CrossmintWallets instance

Defined in

packages/wallets/src/sdk.ts:21