Token Burn Guard

The Token Burn guard requires the minter to permanently burn a configured amount of SPL tokens before the mint transaction is allowed to proceed.

Overview

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.

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.

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

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.

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

Route Instruction

The Token Burn guard does not support the route instruction.

Notes

• Burned tokens are permanently destroyed and cannot be recovered. Ensure the configured Amount accurately reflects the intended cost per mint.
• This guard uses the original SPL Token program. For Token-2022 mints, use the corresponding Token-2022 guard variant instead.
• The payer must hold at least the configured Amount of tokens in their associated token account at the time of minting; otherwise the transaction will fail.