Token Payment Guard

The Token Payment guard allows minting by charging the payer some tokens from a configured mint account.

Both the number of tokens and the destination address can also be configured.

If the payer does not have the required amount of tokens to pay, minting will fail.

Transfer x Amount tokens

from the payer

Core Candy Machine

Owner: Core Candy Machine Core Program

Candy Guard

Owner: Core Candy Guard Program

GuardsToken Payment- Amount- Token Mint- Destination ATA...

Mint Account

Owner: Token Program

Token Account

Owner: Token Program

Destination Wallet

Owner: System Program

Mint from

Core Candy Guard Program

Access Control

Mint from

Core Candy Machine Program

Mint Logic

Asset

Guard Settings

The Token Payment guard contains the following settings:

Amount: The number of tokens to charge the payer.
Mint: The address of the mint account defining the SPL Token we want to pay with.
Destination Associated Token Address (ATA): The address of the associated token account to send the tokens to. We can get this address by finding the Associated Token Address PDA using the Token Mint attribute and the address of any wallet that should receive these tokens.

Set up a Core Candy Machine using the Token Payment guard

JavaScript

Note that, in this example, we’re using the current identity as the destination wallet.

import { findAssociatedTokenPda } from "@metaplex-foundation/mpl-toolbox";
create(umi, {
  // ...
  guards: {
    tokenPayment: some({
      amount: 300,
      mint: tokenMint.publicKey,
      destinationAta: findAssociatedTokenPda(umi, {
        mint: tokenMint.publicKey,
        owner: umi.identity.publicKey,
      })[0],
    }),
  },
});

Mint Settings

The Token Payment guard contains the following Mint Settings:

Mint: The address of the mint account defining the SPL Token we want to pay with.
Destination Associated Token Address (ATA): The address of the associated token account to send the tokens to.

Mint with the NFT Burn Guard

JavaScript

You may pass the Mint Settings of the Token Payment guard using the mintArgs argument like so.

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

Route Instruction

The Token Payment guard does not support the route instruction.

PreviousToken Gate Guard NextToken2022 Payment Guard

Last updated 10 months ago

import { findAssociatedTokenPda } from "@metaplex-foundation/mpl-toolbox"; create(umi, { // ... guards: { tokenPayment: some({ amount: 300, mint: tokenMint.publicKey, destinationAta: findAssociatedTokenPda(umi, { mint: tokenMint.publicKey, owner: umi.identity.publicKey, })[0], }), }, });