Asset Payment

Overview

The Asset Payment guard allows minting by charging the payer a Core Asset from a specified Asset collection. The Asset will be transferred to a predefined destination.

If the payer does not own an Asset from the required collection, minting will fail.

To have the minter pay more than one Asset the Asset Payment Multi Guard can be used.

Guard Settings

The Asset Payment guard contains the following settings:

• Required Collection: The mint address of the required Collection. The Asset we use to pay with must be part of this collection.
• Destination: The address of the wallet that will receive all Assets.

create(umi, {
  // ...
  guards: {
    assetPayment: some({
      requiredCollection: requiredCollection.publicKey,
      destination: umi.identity.publicKey,
    }),
  },
});

Mint Settings

The Asset Payment guard contains the following Mint Settings:

• Asset Adress: The address of the Asset to pay with. This must be part of the required collection and must belong to the minter.
• Collection Address: The Address of the Collection that is used for payment.
• Destination: The address of the wallet that will receive all Assets.

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 Core Candy Guard’s program documentation for more details.

mintV1(umi, {
  // ...
  mintArgs: {
    assetPayment: some({
      requiredCollection: publicKey(requiredCollection),
      destination,
      asset: assetToSend.publicKey,
    }),
  },
});

Route Instruction

The Asset Payment guard does not support the route instruction.