Skip to main content
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.
Defined in: packages/wallets/src/sdk.ts:11

Methods

createDeviceSigner()

createDeviceSigner(deviceKeyStorage, address?): Promise<DeviceSignerConfig>
Defined in: packages/wallets/src/sdk.ts:67

Parameters

Returns

Promise<DeviceSignerConfig>

createPasskeySigner()

createPasskeySigner(passkeyName): Promise<RegisterSignerPasskeyParams>
Defined in: packages/wallets/src/sdk.ts:71

Parameters

Returns

Promise<RegisterSignerPasskeyParams>

createWallet()

createWallet<C>(options): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:63 Create a new wallet. Works on both client and server side. Either a signer or recovery must be provided. If no signer is provided but recovery is set, the wallet will be read-only.

Type Parameters

Parameters

Returns

Promise<Wallet<C>> A new wallet

getWallet()

Call Signature

getWallet<C>(args): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:40 Get an existing wallet. Works on both client and server side. On client side, provide wallet args directly. On server side, provide the wallet locator string and wallet args.
Type Parameters
Parameters
Returns
Promise<Wallet<C>> A wallet if found, throws WalletNotAvailableError if not found

Call Signature

getWallet<C>(walletLocator, args): Promise<Wallet<C>>
Defined in: packages/wallets/src/sdk.ts:41 Get an existing wallet. Works on both client and server side. On client side, provide wallet args directly. On server side, provide the wallet locator string and wallet args.
Type Parameters
Parameters
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:27 Initialize the Wallets SDK

Parameters

Returns

CrossmintWallets A new CrossmintWallets instance