Skip to main content
Defined in: packages/wallets/src/wallets/wallet.ts:60

​
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:69

​
Parameters

ParameterType
argsWalletContructorType<C>
apiClientWalletsApiClient

​
Returns

Wallet<C>

​
Properties

PropertyTypeDefined in
addressstringpackages/wallets/src/wallets/wallet.ts:62
alias?stringpackages/wallets/src/wallets/wallet.ts:64
chainCpackages/wallets/src/wallets/wallet.ts:61
owner?stringpackages/wallets/src/wallets/wallet.ts:63
signerSignerpackages/wallets/src/wallets/wallet.ts:65

​
Methods

​
addDelegatedSigner()

addDelegatedSigner<T>(params): Promise<T extends PrepareOnly<true> ? AddDelegatedSignerReturnType<C> : void>
Defined in: packages/wallets/src/wallets/wallet.ts:465 Add a delegated signer to the wallet

​
Type Parameters

Type ParameterDefault type
T extends AddDelegatedSignerOptions | undefinedundefined

​
Parameters

ParameterType
params{ options: T; signer: string | { id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }; }
params.options?T
params.signerstring | { id: string; name: string; publicKey: { x: string; y: string; }; type: "passkey"; }

​
Returns

Promise<T extends PrepareOnly<true> ? AddDelegatedSignerReturnType<C> : void>

​
approve()

approve<T>(params): Promise<ApproveResult<T>>
Defined in: packages/wallets/src/wallets/wallet.ts:423 Approve a transaction or signature

​
Type Parameters

Type Parameter
T extends ApproveParams

​
Parameters

ParameterTypeDescription
paramsTThe parameters

​
Returns

Promise<ApproveResult<T>> The transaction or signature

​
approveTransaction()

approveTransaction(params): Promise<Error>
Defined in: packages/wallets/src/wallets/wallet.ts:399

​
Parameters

ParameterTypeDescription
paramsApproveParamsThe 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:118 Get the wallet balances - always includes USDC and native token (ETH/SOL)

​
Parameters

ParameterTypeDescription
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

​
delegatedSigners()

delegatedSigners(): Promise<DelegatedSigner[]>
Defined in: packages/wallets/src/wallets/wallet.ts:554 List the delegated signers for this wallet.

​
Returns

Promise<DelegatedSigner[]> The delegated signers

​
experimental_activity()

experimental_activity(): Promise<WalletsV1Alpha2ActivityResponseDto>
Defined in: packages/wallets/src/wallets/wallet.ts:312 Experimental Get the wallet activity

​
Returns

Promise<WalletsV1Alpha2ActivityResponseDto> The activity This API is experimental and may change in the future

​
Throws

If the activity cannot be retrieved

​
experimental_apiClient()

experimental_apiClient(): WalletsApiClient
Defined in: packages/wallets/src/wallets/wallet.ts:101 Experimental Get the API client

​
Returns

WalletsApiClient The API client This API is experimental and may change in the future

​
experimental_nfts()

experimental_nfts(params): Promise<WalletNftsResponseDto>
Defined in: packages/wallets/src/wallets/wallet.ts:272 Experimental Get the wallet NFTs

​
Parameters

ParameterTypeDescription
params{ page: number; perPage: number; }The parameters
params.pagenumberThe page number
params.perPagenumberThe number of NFTs per page

​
Returns

Promise<WalletNftsResponseDto> The NFTs This API is experimental and may change in the future

​
experimental_transaction()

experimental_transaction(transactionId): Promise<WalletsTransactionV2025ResponseDto>
Defined in: packages/wallets/src/wallets/wallet.ts:298 Get a transaction by id

​
Parameters

ParameterType
transactionIdstring

​
Returns

Promise<WalletsTransactionV2025ResponseDto> The transaction

​
Throws

If the transaction cannot be retrieved

​
experimental_transactions()

experimental_transactions(): Promise<GetTransactionsResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:285 Get the wallet transactions

​
Returns

Promise<GetTransactionsResponse> The transactions

​
Throws

If the transactions cannot be retrieved

​
send()

send<T>(to, token, amount, options?): Promise<Transaction<T extends PrepareOnly<true> ? true : false>>
Defined in: packages/wallets/src/wallets/wallet.ts:335 Send a token to a wallet or user locator

​
Type Parameters

Type ParameterDefault type
T extends SendTokenTransactionOptions | undefinedundefined

​
Parameters

ParameterTypeDescription
tostring | UserLocatorThe recipient (address or user locator)
tokenstringThe token (address or currency symbol)
amountstringThe amount to send (decimal units)
options?TThe options for the transaction

​
Returns

Promise<Transaction<T extends PrepareOnly<true> ? true : false>> The transaction

​
stagingFund()

stagingFund(amount, chain?): Promise<FundWalletResponse>
Defined in: packages/wallets/src/wallets/wallet.ts:166 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

ParameterTypeDescription
amountnumberThe amount of USDXM to fund the wallet with
chain?ChainOptional 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