Skip to main content

Token

The Token contract is suited for projects in which you want to create your own currency. This currency can be purchased and traded between users on an exchange, utilized to buy and sell NFTs in a marketplace, and much more.

The Token contract is compliant with the ERC20 standard.

You could use the Token contract to:

  • Create your own cryptocurrency
  • Sell your NFTs on the Marketplace in your custom token
  • Reward users with tokens for some action they take
Learn more

How thirdweb pre-built contracts work and how to create one

Create a Token Contract​

Learn how to create any of thirdweb's pre-built contracts in the Deploying Contracts page.

Getting the contract in your application​

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

import { ThirdwebSDK } from "@thirdweb-dev/sdk";

const sdk = new ThirdwebSDK("rinkeby");
const contract = sdk.getToken("{{contract_address}}");

Minting Tokens​

Using the dashboard​

You can mint new tokens on the dashboard by clicking the Mint button.

Token Dashboard

Using the SDK​

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);
View in Javascript SDK Documentation

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

// 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);
View in Javascript SDK Documentation

Token Metadata​

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

const token = await contract.token.get();
View in Javascript SDK Documentation

You can get the total supply of the token too.

const balance = await contract.token.totalSupply();
View in Javascript SDK Documentation

Token Balance​

Balance of the connected wallet​

const balance = await contract.token.balance();
View in Javascript SDK Documentation

Balance of a specified wallet​

// Address of the wallet to check token balance
const walletAddress = "{{wallet_address}}";
const balance = await contract.token.balanceOf(walletAddress);
View in Javascript 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 amount of tokens that another wallet is allowed to 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);
View in Javascript SDK Documentation

Get allowance for a specified wallet​

Get the amount of tokens that another wallet is allowed to 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);
View in Javascript SDK Documentation

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);
View in Javascript SDK Documentation

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);
View in Javascript SDK Documentation

Transfer from the connected wallet in batch​

// 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);
View in Javascript SDK Documentation

Transfer from a specified wallet​

// 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);
View in Javascript SDK Documentation

Burning Tokens​

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

Burn from the connected wallet​

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

await contract.burn(amount);
View in Javascript SDK Documentation

Burn from a specified wallet​

// 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);
View in Javascript SDK Documentation