Tokens

Tokens Class

The tokens class is designed to manage token data and operations related to vaults and wallets.

Properties

  • tokens.vault: Provides access to vault token data.

    • raw: An object containing raw token data and a map of token data for vaults.

      • list: A signal holding an array of raw token data in the vault.

      • map: A signal holding a map of raw token data in the vault, indexed by token address.

    • formatted: An object containing formatted token data and a map of token data for vaults.

      • list: A signal holding an array of formatted token data in the vault.

      • map: A signal holding a map of formatted token data in the vault, indexed by token address.

  • tokens.wallet: Provides access to wallet token data.

    • raw: An object containing raw token data and a map of token data for wallets.

      • list: A signal holding an array of raw token data in the wallet.

      • map: A signal holding a map of raw token data in the wallet, indexed by token address.

    • formatted: An object containing formatted token data and a map of token data for wallets.

      • list: A signal holding an array of formatted token data in the wallet.

      • map: A signal holding a map of formatted token data in the wallet, indexed by token address.

Methods

  • unwatchTokens(): Removes all listeners from the token service, and clears all token data in the vaults and wallets.

  • watchTokens({ wallet, vault }): Watches token data for the given wallet and vault addresses, updating token data in the vaults and wallets when a token transfer occurs.

    • wallet: String, the wallet address.

    • vault: String, the vault address.

Example Usage

  1. Import the tokens class:

import { tokens, watchTokens, unwatchTokens } from './tokens';

  1. Watch token data for a specific wallet and vault:

const walletAddress = '0x...';
const vaultAddress = '0x...';

watchTokens({ wallet: walletAddress, vault: vaultAddress });

  1. Access raw and formatted token data:

// Access raw token data in the wallet
const walletRawTokens = tokens.wallet.raw.list.value;

// Access formatted token data in the wallet
const walletFormattedTokens = tokens.wallet.formatted.list.value;

// Access raw token data in the vault
const vaultRawTokens = tokens.vault.raw.list.value;

// Access formatted token data in the vault
const vaultFormattedTokens = tokens.vault.formatted.list.value;

  1. Stop watching token data:

unwatchTokens();

This documentation provides a basic overview of the tokens class's properties and methods, as well as example usage to help you understand how to use the class in your application.

PreviousSessionNextNFTs

Last updated