Wander Docs
HomeGithub
  • ๐Ÿ‘‹Welcome to Wander
  • โ›๏ธDeveloper tooling
    • Wander Devtools
    • ArLocal Devtools
  • ๐Ÿ“šExternal libraries
    • Arweave Wallet Kit
    • arweave-js
  • ๐Ÿ”ญDemos
    • Applications
  • ๐ŸงชAPI
    • Intro
    • Events
    • Connect
    • Disconnect
    • Get active address
    • Get active public key
    • Get all addresses
    • Get wallet names
    • Sign Transaction
    • Dispatch Transaction
    • Sign DataItem
    • Batch Sign DataItem
    • Sign message
    • Verify message
    • Private hash
    • User Tokens
    • Token Balance
    • Encrypt
    • Decrypt
    • Crypto signature
    • Subscriptions
    • Retrive permissions
    • Retrive Gateway Config
  • ๐ŸŒWander.app
Powered by GitBook
On this page
  • Options
  • Result
  • Example usage

Was this helpful?

Edit on GitHub
  1. API

User Tokens

Wander Injected API userTokens() function

PreviousPrivate hashNextToken Balance

Last updated 3 months ago

Was this helpful?

Some applications may request access to the tokens in your wallet and their associated balances. The userTokens() function returns the from the API call.

Argument
Type
Description

options?

Optional settings for balance inclusion

Note: This function requires the permission.

Note: The options argument is optional. If not provided, the balance will not be included in the result.

Options

Currently Wander allows you to customize the balance fetching behavior (false by default):

export interface UserTokensOptions {
  fetchBalance?: boolean;
}

Result

The userTokens() function returns an array of token information objects. If the fetchBalance option is set to true, each token object will include its balance. The balance property of the token object may be null if there is an issue retrieving it.

export type UserTokensResult = Array<{
  Name?: string;
  Ticker?: string;
  Logo?: string;
  Denomination: number;
  processId: string;
  balance?: string | null;
}>

Example usage

// Connect to the extension and request access to the ACCESS_TOKENS permission
await window.arweaveWallet.connect(["ACCESS_TOKENS"]);

// Retrieve the list of tokens owned by the user
const tokens = await window.arweaveWallet.userTokens();
console.log("Tokens owned by the user:", tokens);

// Retrieve the list of tokens owned by the user, including their balances
const tokensWithBalances = await window.arweaveWallet.userTokens({ fetchBalance: true });
console.log("Tokens with their balances:", tokensWithBalances);

๐Ÿงช
UserTokensOptions
result
ACCESS_TOKENS