useBurnToken

Description

Hook to mint an ERC20 token

Parameters

Name	Type	Description
amount	number	The amount of tokens to be burned.
[overrides]	Overrides	Optional overrides for the contract call.

Example

import { useContract, useBurnToken } from "@openformat/react";

// address of a created token (ERC20) contract. You can get this from the subgraph.
const address = "0x123...";

// the amount of tokens you want to burn.
const amount = 5;

// returns an instance of the token.
const { data: token } = useContract(address);

const { data, burn, isLoading, error } = useBurnToken(token);

async function handleBurn() {
  await burn({ amount: amount });
}