typescript-sdk

Home > @3rdweb/sdk > BundleModule > burn

BundleModule.burn() method

Burn NFT

Signature:

burn(args: INFTBundleBatchArgs): Promise<TransactionReceipt>;

Parameters

Parameter Type Description
args INFTBundleBatchArgs  

Returns:

Promise<TransactionReceipt>

Remarks

Burn an NFT, permanently taking it out of circulation and reducing the supply.

Example

// The token ID of the NFT you want to burn
const tokenId = 0;
// The number of specified NFTs you want to burn
const amount = 1

await module.burn({ tokenId, amount });