🪙Getting Token Information

Retrieve token lists, user balances, allowances, and more.

Get supported tokens

Query	Description	Parameters
getSupportedTokens	Fetches a list of all supported tokens by chain.	chains (ChainId[], optional): Specify which chains to pull the query for.

Example

import { getSupportedTokens } from '@{PLACEHOLDER}/sdk';

try {
  //Request all supported tokens for Arbitrum and Optimism
  const tokens = await getSupportedTokens({
    chains: [42161, 10],
  });
} catch (error) {
  console.error('Error: ', error);
}

Get token information

Query	Description	Parameters
getTokenInfo	Fetches a token's information.	chain (ChainId): Specify the chain ID where the token is deployed. token (string): Specify the contract address of the token.

Example

import { getTokenInfo } from '@{PLACEHOLDER}/sdk';

try {
  //Request token information for BOOP on Arbitrum
  const token = await getTokenInfo(42161, 0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3);
} catch (error) {
  console.error('Error: ', error);
}

Get user balance

Query	Description	Parameters
getUserBalance	Fetch a wallet's balance for a specific token.	address(string): A wallet address. token (Token): Specify which token to query balances for.

Example

import { getTokenInfo, getUserBalance } from '@{PLACEHOLDER}/sdk';

try {
  //Request user balance for BOOP on Arbitrum
  const token = await getTokenInfo(42161, 0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3);
  const balance = await getUserBalance(0x912CE59144191C1204E64559FE8253a0e49E6548, token);
} catch (error) {
  console.error('Error: ', error);
}

Get user balances

Query	Description	Parameters
getUserBalances	Fetch all token balances for a wallet.	address (string): Address of the wallet. tokens (Token[]): Specify which tokens to query balances for.

Example

import { getTokenInfo, getUserBalances } from '@{PLACEHOLDER}/sdk';

try {
  //Request all balances for wallet 0x912CE59144191C1204E64559FE8253a0e49E6548.
  const token = await getTokenInfo(42161, 0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3);
  const balances = await getUserBalances(0x912CE59144191C1204E64559FE8253a0e49E6548);
} catch (error) {
  console.error('Error: ', error);
}

Get Allowance

Query	Description	Parameters
getAllowance	Fetches the user's allowance for a token.	token (string): Specify the token to query for. address (string): The address of the wallet to query.

Example

import { getAllowance } from '@{PLACEHOLDER}/sdk';

try {
  //Request allowance for BOOP on Arbitrum for wallet 0x912CE59144191C1204E64559FE8253a0e49E6548.
  const allowance = await getAllowance(0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3, 0x912CE59144191C1204E64559FE8253a0e49E6548);
} catch (error) {
  console.error('Error: ', error);
}

Set Allowance

Query	Description	Parameters
setAllowance	Sets the token allowance for a specific token and spender address.	token (Token): Token to set the allowance for. address (string): User's wallet address. amount (BigInt): Amount of tokens to allow.

Example

import { setAllowance } from '@{PLACEHOLDER}/sdk';

const allowanceRequest = {
  address: '0x912CE59144191C1204E64559FE8253a0e49E6548',
  amount: 1000000,
  token: {
    address: '0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3',
    chainId: 42161,
  },
};

try {
  //Set allowance for wallet 0x912CE59144191C1204E64559FE8253a0e49E6548 for BOOP on arbitrum.
  const tx = await setAllowance(allowanceRequest);
} catch (error) {
  console.error('Error: ', error);
}

Revoke Allowance

Query	Description	Parameters
revokeAllowance	Revoke an allowance for token.	token (Token): Token to set the allowance for. address (string): User's wallet address.

Example

import { revokeAllowance } from '@{PLACEHOLDER}/sdk';

const revokeAllowanceRequest = {
  token: {
    address: '0x13A7DeDb7169a17bE92B0E3C7C2315B46f4772B3',
    chainId: 42161,
  },
  address: '0x912CE59144191C1204E64559FE8253a0e49E6548',
};

try {
  //Revoke allowance for wallet 0x912CE59144191C1204E64559FE8253a0e49E6548 for BOOP on arbitrum.
  const tx = await revokeAllowance(revokeAllowanceRequest);
} catch (error) {
  console.error('Error: ', error);
}