Token Burn Guard

The Token Burn guard allows minting by burning some of the payer’s tokens from a configured mint account.

If the payer does not have the required amount of tokens to burn, minting will fail.

Burn tokens from

the payer's token account

Core Candy Machine

Owner: Core Candy Machine Core Program

Candy Guard

Owner: Core Candy Guard Program

GuardsToken Burn- Amount- Mint...

Mint Account

Owner: Token Program

Mint from

Core Candy Guard Program

Access Control

Mint from

Core Candy Machine Program

Mint Logic

Asset

React Flow

Guard Settings

The Token Burn guard contains the following settings:

• Amount: The number of tokens to burn.

• Mint: The address of the mint account defining the SPL Token we want to burn.

Set up a Candy Machine using the NFT Burn guard

JavaScript

create(umi, {
  // ...
  guards: {
    tokenBurn: some({
      amount: 300,
      mint: tokenMint.publicKey,
    }),
  },
});

API References: create, TokenBurn

Mint Settings

The Token Burn guard contains the following Mint Settings:

• Mint: The address of the mint account defining the SPL Token we want to burn.

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 Token Burn guard using the mintArgs argument like so.

mintV1(umi, {
  // ...
  mintArgs: {
    tokenBurn: some({ mint: tokenMint.publicKey }),
  },
});

API References: mintV1, TokenBurnMintArgs

Route Instruction

The Token Burn guard does not support the route instruction.