NFT Burn Guard

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.

Burn 1 NFT

from this collection

Candy Machine

Owner: Candy Machine Core Program

Candy Guard

Owner: Candy Guard Program

GuardsnftBurn- Required Collection...

Collection NFT

Mint Account

Owner: Token Metadata Program

Mint from

Candy Guard Program

Access Control

Mint from

Candy Machine Program

Mint Logic

Asset

React Flow

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.

Set up a Candy Machine using the NFT Burn guard

JavaScript

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

API References: create, NftBurn

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.

Mint with the NFT Burn Guard

JavaScript

You may pass the Mint Settings of the NFT Burn guard using the mintArgs argument like so.

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

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

API References: mintV1, NftBurnMintArgs

Route Instruction

The NFT Burn guard does not support the route instruction.