Extended by

Type Parameters

Type Parameter
C extends Chain

Constructors

new Wallet()

new Wallet<C>(args, apiClient): Wallet<C>

Parameters

ParameterType
argsWalletContructorType<C>
apiClientWalletsApiClient

Returns

Wallet<C>

Defined in

packages/wallets/src/wallets/wallet.ts:47

Properties

PropertyTypeDefined in
addressstringpackages/wallets/src/wallets/wallet.ts:41
chainCpackages/wallets/src/wallets/wallet.ts:40
owner?stringpackages/wallets/src/wallets/wallet.ts:42
signerSigner<keyof SignResultMap>packages/wallets/src/wallets/wallet.ts:43

Methods

addDelegatedSigner()

addDelegatedSigner(signer): Promise<void>
Add a delegated signer to the wallet

Parameters

ParameterTypeDescription
signerobjectThe signer
signer.signerstring-

Returns

Promise<void> The delegated signer

Defined in

packages/wallets/src/wallets/wallet.ts:235

balances()

balances(tokens?, chains?): Promise<Balances>
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)
chains?Chain[]The chains (optional)

Returns

Promise<Balances> The balances returns nativeToken, usdc, tokens

Throws

If the balances cannot be retrieved

Defined in

packages/wallets/src/wallets/wallet.ts:80

delegatedSigners()

delegatedSigners(): Promise<DelegatedSigner[]>

Returns

Promise<DelegatedSigner[]>

Defined in

packages/wallets/src/wallets/wallet.ts:265

experimental_activity()

experimental_activity(): Promise<WalletsV1Alpha2ActivityResponseDto>
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

Defined in

packages/wallets/src/wallets/wallet.ts:186

experimental_nfts()

experimental_nfts(params): Promise<GetNftsResponse>
Experimental Get the wallet NFTs

Parameters

ParameterTypeDescription
paramsobjectThe parameters
params.pagenumberThe page number
params.perPagenumberThe number of NFTs per page

Returns

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

Defined in

packages/wallets/src/wallets/wallet.ts:164

experimental_transactions()

experimental_transactions(): Promise<GetTransactionsResponse>
Get the wallet transactions

Returns

Promise<GetTransactionsResponse> The transactions

Defined in

packages/wallets/src/wallets/wallet.ts:176

send()

send<T>(to, token, amount, options?): Promise<Transaction<T extends object ? true : false>>
Send a token to a wallet or user locator

Type Parameters

Type ParameterDefault type
T extends undefined | TransactionInputOptionsundefined

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 object ? true : false>> The transaction

Defined in

packages/wallets/src/wallets/wallet.ts:202