Asset Burn Guard

The Asset Burn guard requires the minting wallet to hold an Asset from a specified collection and permanently burns that Asset as the cost of minting a new one from the Core Candy Machine.

Overview

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

To have the minter burn more than one Asset the Asset Burn Multi Guard can be used.

Guard Settings

The Asset Burn guard contains the following settings:

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

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

Mint Settings

The Asset Burn guard contains the following Mint Settings:

• Required Collection: The mint address of the required Collection.
• Address: The address of the Asset to burn. This must be part of the required collection and must belong to the minter.

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: {
    assetBurn: some({
      requiredCollection: requiredCollection.publicKey,
      asset: assetToBurn.publicKey,
    }),
  },
});

Route Instruction

The Asset Burn guard does not support the route instruction.

Notes

• The Asset being burned is permanently destroyed and cannot be recovered. The burn happens atomically during the mint transaction.
• The Asset must belong to the minting wallet and must be part of the specified collection. If either condition is not met, the mint transaction will fail.
• This guard burns exactly one Asset per mint. To require burning multiple Assets per mint, use the Asset Burn Multi guard instead.
• To gate minting on collection ownership without burning the Asset, use the Asset Gate guard instead.