burn

Prepares a transaction to call the "burn" function on the contract.

Example


import { burn } from "thirdweb/extensions/erc20";
 
const transaction = burn({
 contract,
 amount: ...,
 overrides: {
   ...
 }
});
 
// Send the transaction
...


function burn(
  options: BaseTransactionOptions<
    BurnParams | { asyncParams: () => Promise<BurnParams> }
  >,
): PreparedTransaction<any, AbiFunction, PrepareTransactionOptions>;

Parameters

The options for the "burn" function.

Type


let options: BaseTransactionOptions<
  BurnParams | { asyncParams: () => Promise<BurnParams> }
>;

Returns


let returnType: PreparedTransaction<
  any,
  AbiFunction,
  PrepareTransactionOptions
>;

A prepared transaction object.