NFT Gate

Overview

The NFT Gate guard restricts minting to holders of a specified NFT collection.

Guard Settings

The NFT Gate guard contains the following settings:

• Required Collection: The mint address of the required NFT Collection. The NFT we provide as proof when minting must be part of this collection.

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

Mint Settings

The NFT Gate guard contains the following Mint Settings:

• Mint: The mint address of the NFT to provide as proof that the payer owns an NFT from the required collection.
• 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.

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: {
    nftGate: some({ mint: nftToBurn.publicKey }),
  },
});

Route Instruction

The NFT Gate guard does not support the route instruction.