CrossmintWallets

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

Parameter	Type	Description
options	WalletArgsFor<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

Parameter	Type	Description
options	WalletArgsFor<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

Parameter	Type	Description
walletLocator	string	Wallet locator
options	WalletArgsFor<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

Parameter	Type	Description
crossmint	Crossmint	Crossmint data (use createCrossmint to initialize)

Returns

CrossmintWallets

A new CrossmintWallets instance