Asset Burn Multi Guard

The Asset Burn Multi guard requires the minting wallet to hold and permanently burn a configurable number of Assets from a specified collection as the cost of minting a new Asset from the Core Candy Machine.

Overview

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

It is similar to the Asset Burn Guard but can accept more than one asset to burn.

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.
• Number: The Amount of Assets that have to be burned in exchange for the new Asset.

create(umi, {
  // ...
  guards: {
    assetBurnMulti: some({
      requiredCollection: requiredCollection.publicKey,
      num: 2,
    }),
  },
});

Mint Settings

The Asset Burn Multi guard contains the following Mint Settings:

• Required Collection: The mint address of the required Collection.
• [Address]: An Array of Addresses of the Asset(s) to burn. These 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: {
    assetBurnMulti: some({
      requiredCollection: requiredCollection.publicKey,
      assets: [assetToBurn1.publicKey, assetToBurn2.publicKey],
    }),
  },
});

Route Instruction

The Asset Burn Multi guard does not support the route instruction.

Notes

• All Assets being burned are permanently destroyed and cannot be recovered. The burns happen atomically during the mint transaction.
• The number of Asset addresses provided in the assets array must match the num value configured in the guard settings. Providing fewer or more addresses will cause the transaction to fail.
• Each Asset must belong to the minting wallet and must be part of the specified collection. If any Asset fails either condition, the entire mint transaction will fail.
• To burn only a single Asset per mint, use the simpler Asset Burn guard instead.