Skip to main content

useToken() function​

Warning: This API is now obsolete.

This hook is deprecated and will be removed in a future major version. You should use instead.

- const token = useToken("0x1234...");
+ const token = useContract("0x1234...", "token").contract;

Hook for getting an instance of a Token contract. This contract supports ERC20 compliant tokens.

Example​

import { useContract } from '@thirdweb-dev/react'

export default function Component() {
  const { contract } = useContract("<YOUR-CONTRACT-ADDRESS>", "token")

  // Now you can use the token contract in the rest of the component

  // For example, this function will get the connected wallets token balance
  async function balance() {
    const balance = await contract.balance()
    return balance
  }

  ...
}

Signature:

export declare function useToken(
  contractAddress: RequiredParam<string>,
): import("@thirdweb-dev/sdk").Token | undefined;

Parameters​

ParameterTypeDescription
contractAddressRequiredParam<string>the address of the Token contract, found in your thirdweb dashboard

Returns:

import("@thirdweb-dev/sdk").Token | undefined