Token

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

Create a Token Contract

Deploys a new Token contract

React

const sdk = useSDK();

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

View in React SDK Documentation

Javascript

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

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

await sdk
    .deployer
    .DeployToken(new 	TokenContractDeployMetadata()
    { name = "My Collection", primary_sale_recipient = "0x..." });

---

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.

React

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
}

Javascript

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

const sdk = new ThirdwebSDK("{{chainName}}");
const contract = await sdk.getContract("{{contract_address}}", "token");

Python

from thirdweb import ThirdwebSDK

# You can customize this to a supported network or your own RPC URL
network = "mumbai"

# Now we can create a new instance of the SDK
sdk = ThirdwebSDK(network)

# If you want to send transactions, you can instantiate the SDK with a private key instead:
#   sdk = ThirdwebSDK.from_private_key(PRIVATE_KEY, network)

contract = sdk.get_token("{{contract_address}}")

View in Python SDK Documentation

Go

import (
	"github.com/thirdweb-dev/go-sdk/v2/thirdweb"
)

privateKey = "..."

sdk, err := thirdweb.NewThirdwebSDK("mumbai", &thirdweb.SDKOptions{
	PrivateKey: privateKey,
})

contract, err := sdk.GetToken("{{contract_address}}")

View in Go SDK Documentation

Unity

Contract contract = sdk.GetContract("{{contract_address}}");

---

Minting Tokens

Mint tokens to a specified wallet

React

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 React SDK Documentation

Javascript

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

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

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

await contract.ERC20.MintTo(toAddress, amount);

---

Mint tokens to many wallets in one transaction (batch)

Mint Tokens To Many Wallets

React

// 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 React SDK Documentation

Javascript

// 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

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Token Metadata

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

React

const token = await contract.get();

View in React SDK Documentation

Javascript

const token = await contract.get();

View in Javascript SDK Documentation

Python

token = contract.get()
print(token)

View in Python SDK Documentation

Go

currency, err := contract.Get()
symbol := currency.Symbol

View in Go SDK Documentation

Unity

var token = await contract.ERC20.Get();

You can get the total supply of the token too.

React

const balance = await contract.totalSupply();

View in React SDK Documentation

Javascript

const balance = await contract.totalSupply();

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

var balance = await contract.ERC20.TotalSupply();

---

Token Balance

Balance of the connected wallet

Get Token Balance for the currently connected wallet

React

const balance = await contract.balance();

View in React SDK Documentation

Javascript

const balance = await contract.balance();

View in Javascript SDK Documentation

Python

balance = contract.balance()
print(balance)

View in Python SDK Documentation

Go

balance, err := contract.Balance()
 balanceValue := balance.DisplayValue

View in Go SDK Documentation

Unity

var balance = await contract.ERC20.Balance();

---

Balance of a specified wallet

Get Token Balance

React

const { data: balance, isLoading, error } = useTokenBalance(contract, "{{wallet_address}}");

View in React SDK Documentation

Javascript

// Address of the wallet to check token balance
const walletAddress = "{{wallet_address}}";
const balance = await contract.balanceOf(walletAddress);

View in Javascript SDK Documentation

Python

address = "{{wallet_address}}"
balance = contract.balance_of(address)
print(balance)

View in Python SDK Documentation

Go

address := "{{wallet_address}}"
	balance, err := contract.BalanceOf()
 balanceValue := balance.DisplayValue

View in Go SDK Documentation

Unity

// Address of the Wallet to check token balance
var walletAddress = "{{wallet_address}}";
var balance = await contract.ERC20.BalanceOf(walletAddress);

---

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.

React

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

View in React SDK Documentation

Javascript

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

View in Javascript SDK Documentation

Python

spender = "{{wallet_address}}"
allowance = contract.allowance(spender)

View in Python SDK Documentation

Go

spender := "0x..."

allowance, err := contract.Allowance(spender)
allowanceValue := allowance.DisplayValue

View in Go SDK Documentation

Unity

// Address of the Wallet to check token allowance
var spenderAddress = "0x...";
var allowance = await contract.ERC20.Allowance(spenderAddress);

---

Get allowance for a specified wallet

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

React

// 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.allowanceOf(owner, spender);

View in React SDK Documentation

Javascript

// 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.allowanceOf(owner, spender);

View in Javascript SDK Documentation

Python

# Address of the wallet who owns the funds
address = "{{wallet_address}}"

# Address of the wallet to check the token allowance
spender = "0x..."

allowance = contract.allowance_of(address, spender)
print(allowance)

View in Python SDK Documentation

Go

address := "{{wallet_address}}"
spender := "0x..."

allowance, err := contract.AllowanceOf(address, spender)
allowanceValue := allowance.DisplayValue

View in Go SDK Documentation

Unity

// Address of the Wallet who owns the funds
var owner = "{{wallet_address}}";
// Address of the Wallet to check token allowance
var spender = "0x...";
var allowance = await contract.ERC20.AllowanceOf(owner, spender);

---

Set Allowance

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

React

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

View in React SDK Documentation

Javascript

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

View in Javascript SDK Documentation

Python

spender = "0x..."
amount = 100
contract.set_allowance(spender, amount)

View in Python SDK Documentation

Go

spender := "0x..."
amount := 1

tx, err := contract.SetAllowance(context.Background(), spender, amount)

View in Go SDK Documentation

Unity

// Address of the Wallet to allow transfers from
var spenderAddress = "0x...";
// The number of tokens to give as allowance
var amount = "100";
await contract.ERC20.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

Transfer from the connected wallet in batch

Transfer Tokens To Many Wallets

React

// 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.transferBatch(data);

View in React SDK Documentation

Javascript

// 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.transferBatch(data);

View in Javascript SDK Documentation

Python

from thirdweb.types.currency import TokenAmount

data = [
    TokenAmount("{{wallet_address}}", 0.1),
    TokenAmount("0x...", 0.2),
]

contract.transfer_batch(data)

View in Python SDK Documentation

Go

args = []*thirdweb.TokenAmount{
	&thirdweb.TokenAmount{
		ToAddress: "0x...",
		Amount:    1
	}
	&thirdweb.TokenAmount{
		ToAddress: "0x...",
		Amount:    2
	}
}

tx, err := contract.TransferBatch(context.Background(), args)

View in Go SDK Documentation

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!

---

Transfer from a specified wallet

Burning Tokens

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

Burn from the connected wallet

Burn Tokens

React

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

await contract.burnTokens(amount);

View in React SDK Documentation

Javascript

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

await contract.burnTokens(amount);

View in Javascript SDK Documentation

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

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

await contract.ERC20.Burn(amount);

---

Burn from a specified wallet

Burn Tokens

React

// 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 React SDK Documentation

Javascript

// 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

Python

This feature is missing a code snippet or might not be supported yet.
Check the Python SDK Reference for more information.
Reach out on Discord for further assistance!

Go

This feature is missing a code snippet or might not be supported yet.
Check the Go SDK Reference for more information.
Reach out on Discord for further assistance!

Unity

This feature is missing a code snippet or might not be supported yet.
Check the Unity SDK Reference for more information.
Reach out on Discord for further assistance!