Skip to main content

Token

Learn how to interact with your Token contract in the SDK.

Create a Token Contract​

Deploys a new Token contract 
const sdk = useSDK();

const contractAddress = await sdk.deployer.deployToken({
  name: "My Token",
  primary_sale_recipient: "your-address",
});

Getting the contract in your application​

To start using your Token contract inside your application, you need to use its contract address. You can get the contract address from the dashboard.

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

export default function Component() {
  const token = useToken("<YOUR-CONTRACT-ADDRESS>")

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

Minting Tokens​

Mint tokens to a specified wallet​

const toAddress = "{{wallet_address}}"; // Address of the wallet you want to mint the tokens to
const amount = "1.5"; // The amount of this token you want to mint

await contract.mintTo(toAddress, amount);

Mint tokens to many wallets in one transaction (batch)​

Mint Tokens To Many Wallets 
// Data of the tokens you want to mint
const data = [
  {
    toAddress: "{{wallet_address}}", // Address to mint tokens to
    amount: 0.2, // How many tokens to mint to specified address
  },
 {
   toAddress: "0x...",
   amount: 1.4,
 }
]

await contract.mintBatchTo(data);

Token Metadata​

Get the metadata about the token itself, such as the name, symbol, and decimals.

const token = await contract.token.get();

You can get the total supply of the token too.

const balance = await contract.token.totalSupply();

Token Balance​

Balance of the connected wallet​

Get Token Balance for the currently connected wallet 
const balance = await contract.token.balance();

Balance of a specified wallet​

Get Token Balance 
const { data: balance, isLoading, error } = useTokenBalance(<YourTokenContractInstance>);
View in React SDK Documentation

Token Allowance​

Allowance refers to how many tokens another address is allowed to spend from your wallet.

For example, our Marketplace contract asks you permission to increase your allowance when you make a bid on an auction listing.

Get allowance for the connected wallet​

Get the number of tokens that another wallet can spend on behalf of the connected wallet.

// Address of the wallet to check token allowance
const spenderAddress = "0x...";
const allowance = await contract.token.allowance(spenderAddress);

Get allowance for a specified wallet​

Get the number of tokens that another wallet can spend on behalf of the specified wallet.

// Address of the wallet who owns the funds
const owner = "{{wallet_address}}";
// Address of the wallet to check token allowance
const spender = "0x...";
const allowance = await contract.token.allowanceOf(owner, spender);

Set Allowance​

Specify how many tokens another wallet is allowed to spend on behalf of the connected wallet.

// Address of the wallet to allow transfers from
const spenderAddress = "0x...";
// The number of tokens to give as allowance
const amount = 100
await contract.token.setAllowance(spenderAddress, amount);

Transfer Tokens​

You can transfer tokens from one wallet to another or send tokens to a smart contract address.

Transfer from the connected wallet​

// Address of the wallet you want to send the tokens to
const toAddress = "0x...";
// The amount of tokens you want to send
const amount = 0.1;
await contract.token.transfer(toAddress, amount);

Transfer from the connected wallet in batch​

Transfer Tokens To Many Wallets 
// Data of the tokens you want to mint
const data = [
  {
    toAddress: "{{wallet_address}}", // Address to mint tokens to
    amount: 100, // How many tokens to mint to specified address
  },
 {
   toAddress: "0x...",
   amount: 100,
 }
]

await contract.token.transferBatch(data);

Transfer from a specified wallet​

Transfer Tokens From Address 
// Address of the wallet sending the tokens
const fromAddress = "{{wallet_address}}";
// Address of the wallet you want to send the tokens to
const toAddress = "0x...";
// The number of tokens you want to send
const amount = 1.2
// Note that the connected wallet must have approval to transfer the tokens of the fromAddress
await contract.token.transferFrom(fromAddress, toAddress, amount);

Burning Tokens​

Burning tokens takes a specified amount of tokens out of the circulating supply.

Burn from the connected wallet​

Burn from a specified wallet​

Burn Tokens 
// Address of the wallet sending the tokens
const holderAddress = "{{wallet_address}}";

// The amount of this token you want to burn
const amount = 1.2;

await contract.burnFrom(holderAddress, amount);