Skip to main content

NFT Payment

info

A newer version of this page is available in the Developer Hub. Click here to read it.

Overview​

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

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

CandyMachinesV3-GuardsNFTPayment.png

Guard Settings​

The NFT Payment guard contains the following settings:

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

JavaScript — Umi library (recommended)

Here’s an example of how to set up a Candy Machine using the NFT Payment guard. You may use any wallet as a destination but, in this example, we’ll use the address of the current identity.

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

API References: create, NftPayment

JavaScript — SDK

Here’s an example of how to set up a Candy Machine using the NFT Payment guard. You may use any wallet as a destination but, in this example, we’ll use the address of the current identity.

const { candyMachine } = await metaplex.candyMachines().create({
  // ...
  guards: {
    nftPayment: {
      requiredCollection: requiredCollectionNft.address,
      destination: metaplex.identity().publicKey,
    },
  },
});

API References: Operation, Input, Output, Transaction Builder, Guard Settings.

Mint Settings​

The NFT Payment guard contains the following Mint Settings:

  • Destination: The address of the wallet that will receive all NFTs.
  • Mint: The mint address of the NFT to pay with. This must be part of the required collection and must belong to the minter.
  • Token Standard: The token standard of the NFT used to pay.
  • Token Account (optional): You may optionally provide the token account linking the NFT with its owner explicitly. By default, the associated token account of the payer will be used.
  • Rule Set (optional): The Rule Set of the NFT used to pay, if we are paying using a Programmable NFT with a Rule Set.

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.

JavaScript — Umi library (recommended)

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

import { TokenStandard } from "@metaplex-foundation/mpl-token-metadata";

mintV2(umi, {
  // ...
  mintArgs: {
    nftPayment: some({
      destination,
      mint: nftToPayWith.publicKey,
      tokenStandard: TokenStandard.NonFungible,
    }),
  },
});

API References: mintV2, NftPaymentMintArgs

JavaScript — SDK

When minting via the JS SDK, simply provide the mint address of the NFT to pay with via the mint attribute like so.

const { nft } = await metaplex.candyMachines().mint({
  // ...
  guards: {
    nftPayment: {
      mint: nftToPayWith.address,
    },
  },
});

You may also provide the tokenAccount attribute explicitly should the NFT not use an associated token account.

API References: Operation, Input, Output, Transaction Builder, Mint Settings.

Route Instruction​

The NFT Payment guard does not support the route instruction.