Available Guards
Asset Burn Multi Guard
This Guard is currently only available on devnet. Follow us on twitter to see when it's merged to mainnet!
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.
Set up a Candy Machine using the Asset Burn Multi guard
create(umi, {
// ...
guards: {
assetBurnMulti: some({
requiredCollection: requiredCollection.publicKey,
num: 2,
}),
},
});
API References: create, AssetBurnMulti
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.
Mint with the Asset Burn Multi Guard
You may pass the Mint Settings of the Asset Burn Multi guard using the mintArgs
argument like so.
mintV1(umi, {
// ...
mintArgs: {
assetBurnMulti: some({
requiredCollection: requiredCollection.publicKey,
assets: [assetToBurn1.publicKey, assetToBurn2.publicKey],
}),
},
});
API References: mintV1, AssetBurnMultiMintArgs
Route Instruction
The Asset Burn Multi guard does not support the route instruction.