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.

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.

create(umi, {
  // ...
  guards: {
    nftBurn: some({ requiredCollection: requiredCollectionNft.publicKey }),
  },
});

Mint Settings

The NFT Burn guard contains the following Mint Settings:

• Required Collection: The mint address of the required NFT Collection.
• Mint: The mint address of the NFT to burn. This must be part of the required collection and must belong to the minter.
• Token Standard: The token standard of the NFT to burn.
• 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.

import { TokenStandard } from "@metaplex-foundation/mpl-token-metadata";

mintV2(umi, {
  // ...
  mintArgs: {
    nftBurn: some({
      requiredCollection: requiredCollectionNft.publicKey,
      mint: nftToBurn.publicKey,
      tokenStandard: TokenStandard.NonFungible,
    }),
  },
});

Route Instruction

The NFT Burn guard does not support the route instruction.