burn

Description

The burn function is used to burn a specified amount of tokens from the account of the sender.

Parameters

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

Example

import { ContractType } from "@openformat/sdk";

const contract = sdk.getContract({
  contractAddress: "0x123...",
  type: ContractType.Token,
});

const params = {
  amount: 10,
};
await contract.burn(params);