Skip to main content

NFT Burn

Overview

The NFT Burn guard restricts the mint to holders of a predefined NFT Collection and burns the holder's NFT. Thus, the mint address of the NFT to burn must be provided by the payer when minting.

CandyMachinesV3-GuardsNFTBurn.png

Guard Settings

The NFT Burn guard contains the following settings:

  • Required Collection: The mint address of the required NFT Collection. The NFT we use to mint with must be part of this collection.

JS SDK

Here’s an example of how to set up a Candy Machine using the NFT Burn guard.

const { candyMachine } = await metaplex.candyMachines().create({
// ...
guards: {
nftBurn: {
requiredCollection: requiredCollectionNft.address,
},
},
});

API References: Operation, Input, Output, Transaction Builder, Guard Settings.

Mint Settings

The NFT Burn guard contains the following Mint Settings:

  • Mint: The mint address of the NFT to burn. This must be part of the required collection and must belong to the payer.
  • Token Account (optional): You may optionally provide the token account linking the NFT with its owner explicitly. By default, the associated token account of the payer will be used.

Note that, if you’re planning on constructing instructions without the help of our SDKs, you will need to provide these Mint Settings and more as a combination of instruction arguments and remaining accounts. See the Candy Guard’s program documentation for more details.

JS SDK

When minting via the JS SDK, simply provide the mint address of the NFT to burn via the mint attribute like so.

const { nft } = await metaplex.candyMachines().mint({
// ...
guards: {
nftBurn: {
mint: nftToBurn.address,
},
}
});

You may also provide the tokenAccount attribute explicitly should the NFT not use an associated token account.

API References: Operation, Input, Output, Transaction Builder, Mint Settings.

Route Instruction

The NFT Burn guard does not support the route instruction.