Wallet
Extended by
Type Parameters
| Type Parameter |
|---|
C extends Chain |
Constructors
new Wallet()
new Wallet<
C>(args,apiClient):Wallet<C>
Parameters
| Parameter | Type |
|---|---|
args | WalletContructorType<C> |
apiClient | WalletsApiClient |
Returns
Wallet<C>
Defined in
packages/wallets/src/wallets/wallet.ts:47
Properties
| Property | Type | Defined in |
|---|---|---|
address | string | packages/wallets/src/wallets/wallet.ts:41 |
chain | C | packages/wallets/src/wallets/wallet.ts:40 |
owner? | string | packages/wallets/src/wallets/wallet.ts:42 |
signer | Signer<keyof SignResultMap> | packages/wallets/src/wallets/wallet.ts:43 |
Methods
addDelegatedSigner()
addDelegatedSigner(
signer):Promise<void>
Add a delegated signer to the wallet
Parameters
| Parameter | Type | Description |
|---|---|---|
signer | object | The signer |
signer.signer | string | - |
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
| Parameter | Type | Description |
|---|---|---|
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
| Parameter | Type | Description |
|---|---|---|
params | object | The parameters |
params.page | number | The page number |
params.perPage | number | The 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<Textendsobject?true:false>>
Send a token to a wallet or user locator
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends undefined | TransactionInputOptions | 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 object ? true : false>>
The transaction