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/wallets/wallet.ts:83
Extended by
Type Parameters
| Type Parameter |
|---|
C extends Chain |
Constructors
new Wallet()
new Wallet<C>(args, apiClient): Wallet<C>
Defined in: packages/wallets/src/wallets/wallet.ts:98
Parameters
| Parameter | Type |
|---|
args | WalletContructorType<C> |
apiClient | WalletsApiClient |
Returns
Wallet<C>
Properties
Accessors
apiClient
Get Signature
get apiClient(): WalletsApiClient
Defined in: packages/wallets/src/wallets/wallet.ts:206
Returns
WalletsApiClient
recovery
Get Signature
get recovery(): SignerConfigForChain<C>
Defined in: packages/wallets/src/wallets/wallet.ts:219
Experimental
Get the recovery signer config
Returns
SignerConfigForChain<C>
The recovery signer config
This API is experimental and may change in the future
signer
Get Signature
get signer(): SignerAdapter<keyof SignResultMap> | undefined
Defined in: packages/wallets/src/wallets/wallet.ts:112
Returns
SignerAdapter<keyof SignResultMap> | undefined
Methods
addSigner()
addSigner<T>(signer, options?): Promise<T extends PrepareOnly<true> ? AddSignerReturnType<C> : Signer>
Defined in: packages/wallets/src/wallets/wallet.ts:614
Add a signer to the wallet.
Always uses the recovery signer internally to approve the registration.
If the signer being added is the current operational signer, it will be reassembled with the new locator.
Otherwise, the original signer is restored after the operation.
Type Parameters
| Type Parameter | Default type |
|---|
T extends AddSignerOptions | undefined | undefined |
Parameters
| Parameter | Type | Description |
|---|
signer | SignerConfigForChain<C> | ServerSignerConfig | ExternalWalletRegistrationConfig | The signer configuration object |
options? | T | The options for the operation |
Returns
Promise<T extends PrepareOnly<true> ? AddSignerReturnType<C> : Signer>
approve()
approve<T>(params): Promise<ApproveResult<T>>
Defined in: packages/wallets/src/wallets/wallet.ts:568
Approve a transaction or signature
Type Parameters
| Type Parameter |
|---|
T extends ApproveParams |
Parameters
| Parameter | Type | Description |
|---|
params | T | The parameters |
Returns
Promise<ApproveResult<T>>
The transaction or signature
approveTransaction()
approveTransaction(params): Promise<Error>
Defined in: packages/wallets/src/wallets/wallet.ts:544
Parameters
| Parameter | Type | Description |
|---|
params | ApproveParams | The parameters |
Returns
Promise<Error>
The transaction
Deprecated
Use approve instead.
Approve a transaction
balances()
balances(tokens?): Promise<Balances<C>>
Defined in: packages/wallets/src/wallets/wallet.ts:236
Get the wallet balances - always includes USDC and native token (ETH/SOL)
Parameters
| Parameter | Type | Description |
|---|
tokens? | string[] | Additional tokens to request (optional: native token and usdc are always included) |
Returns
Promise<Balances<C>>
The balances returns nativeToken, usdc, tokens
Throws
If the balances cannot be retrieved
isSignerApproved()
isSignerApproved(signerLocator): Promise<boolean>
Defined in: packages/wallets/src/wallets/wallet.ts:866
Check if a signer is approved and usable for the current wallet chain.
Parameters
| Parameter | Type | Description |
|---|
signerLocator | string | The locator of the signer to check |
Returns
Promise<boolean>
true if the signer is approved for this chain
needsRecovery()
needsRecovery(): boolean
Defined in: packages/wallets/src/wallets/wallet.ts:875
Whether the wallet needs recovery (signer registration) before the next transaction.
Returns
boolean
true if recovery is needed
nfts()
nfts(params): Promise<unknown>
Defined in: packages/wallets/src/wallets/wallet.ts:394
Get the wallet NFTs
Parameters
| Parameter | Type | Description |
|---|
params | { page: number; perPage: number; } | The parameters |
params.page | number | The page number |
params.perPage | number | The number of NFTs per page |
Returns
Promise<unknown>
The NFTs
recover()
recover(): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:891
Register a device signer with the wallet using the recovery signer.
Generates a new device key and registers it on-chain.
Returns early if the device signer’s locator is already approved on-chain.
Returns
Promise<void>
send()
send<T>(to, token, amount, options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
Defined in: packages/wallets/src/wallets/wallet.ts:461
Send a token to a wallet or user locator
Type Parameters
| Type Parameter | Default type |
|---|
T extends SendTokenTransactionOptions | undefined | undefined |
Parameters
| Parameter | Type | Description |
|---|
to | string | UserLocator | The recipient (address or user locator) |
token | string | The token (address or currency symbol) |
amount | string | The amount to send (decimal units) |
options? | T | The options for the transaction |
Returns
Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
The transaction
signerIsRegistered()
signerIsRegistered(signerLocator): Promise<boolean>
Defined in: packages/wallets/src/wallets/wallet.ts:856
Check if a signer is registered in this wallet.
Parameters
| Parameter | Type | Description |
|---|
signerLocator | string | The locator of the signer to check |
Returns
Promise<boolean>
true if the signer is registered
signers()
signers(): Promise<Signer[]>
Defined in: packages/wallets/src/wallets/wallet.ts:995
List the signers for this wallet.
Returns full signer objects with status.
For EVM wallets, only signers with an approval (pending or completed) for the wallet’s chain are included.
Returns
Promise<Signer[]>
The signers
stagingFund()
stagingFund(amount, chain?): Promise<FundWalletResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:286
Funds the wallet with Crossmint’s stablecoin (USDXM).
Note: This method is only available in staging environments and exclusively supports USDXM tokens.
It cannot be used in production environments.
Parameters
| Parameter | Type | Description |
|---|
amount | number | The amount of USDXM to fund the wallet with |
chain? | Chain | Optional chain to fund on. If not provided, uses the wallet’s default chain |
Returns
Promise<FundWalletResponse>
The funding response
Throws
If the funding operation fails or if called in a production environment
transaction()
transaction(transactionId): Promise<WalletsTransactionV2025ResponseDto>
Defined in: packages/wallets/src/wallets/wallet.ts:420
Get a transaction by id
Parameters
| Parameter | Type |
|---|
transactionId | string |
Returns
Promise<WalletsTransactionV2025ResponseDto>
The transaction
Throws
If the transaction cannot be retrieved
transactions()
transactions(): Promise<GetTransactionsResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:407
Get the wallet transactions
Returns
Promise<GetTransactionsResponse>
The transactions
Throws
If the transactions cannot be retrieved
transfers()
transfers(params?): Promise<WalletsActivityResponseUnstableDto>
Defined in: packages/wallets/src/wallets/wallet.ts:433
Get the wallet transfers
Parameters
| Parameter | Type |
|---|
params? | { status: "successful" | "failed"; tokens: string; } |
params.status? | "successful" | "failed" |
params.tokens? | string |
Returns
Promise<WalletsActivityResponseUnstableDto>
The transfers
Throws
If the transfers cannot be retrieved
useSigner()
useSigner(signer): Promise<void>
Defined in: packages/wallets/src/wallets/wallet.ts:758
Set the active signer for this wallet.
Accepts a signer config object. The locator is inferred internally.
Works for both registered signers and the recovery signer.
For passkey signers: if no id is provided, the wallet will auto-select the passkey
if exactly one passkey signer is registered. If multiple passkeys exist, an id must be specified.
For device signers: if no device key is found locally, the signer will be created
automatically during the next transaction (via recovery).
For external-wallet signers: the config object must include an onSign callback
(applies to both registered and recovery signers).
Parameters
| Parameter | Type | Description |
|---|
signer | SignerConfigForChain<C> | The signer config object to use |
Returns
Promise<void>
