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.
Defined in: packages/wallets/src/sdk.ts:11
Methods
createDeviceSigner()
createDeviceSigner(deviceKeyStorage, address?): Promise<DeviceSignerConfig>
Defined in: packages/wallets/src/sdk.ts:67
Parameters
| Parameter | Type |
|---|
deviceKeyStorage | DeviceSignerKeyStorage |
address? | string |
Returns
Promise<DeviceSignerConfig>
createPasskeySigner()
createPasskeySigner(passkeyName): Promise<{ id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }>
Defined in: packages/wallets/src/sdk.ts:71
Parameters
| Parameter | Type |
|---|
passkeyName | string |
Returns
Promise<{ id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }>
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
| Type Parameter |
|---|
C extends Chain |
Parameters
| Parameter | Type | Description |
|---|
options | WalletCreateArgs<C> | Wallet creation options |
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
| Type Parameter |
|---|
C extends Chain |
Parameters
| Parameter | Type |
|---|
args | WalletArgsFor<C> |
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
| Type Parameter |
|---|
C extends Chain |
Parameters
| Parameter | Type |
|---|
walletLocator | string |
args | WalletArgsFor<C> |
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
| Parameter | Type | Description |
|---|
crossmint | Crossmint | Crossmint data (use createCrossmint to initialize) |
Returns
CrossmintWallets
A new CrossmintWallets instance
