NFT Mint Limit Guard

The NFT Mint Limit guard restricts minting to holders of a specified NFT collection and limits the amount of mints that can be done for a provided Token Metadata NFT.

It can be considered as a combination of the NFT Gate and Mint Limit Guard, based on NFT Addresses instead of wallets.

The limit is set per NFT Collection, per candy machine and per identifier — provided in the settings — to allow multiple nft mint limits within the same Core Candy Machine.

Core Candy Machine

Owner: Core Candy Machine Core Program

Core Candy Guard

Owner: Core Candy Guard Program

GuardsNftMintLimit- Limit- ID- Required Collection...

NFT Mint Counter PDA

Seeds: candyGuard, candyMachine, id, mint

Mint from

Candy Guard Program

Access Control

Mint from

Core Candy Machine Program

Mint Logic

Asset

React Flow

Guard Settings

The Mint Limit guard contains the following settings:

• ID: A unique identifier for this guard. Different identifiers will use different counters to track how many items were minted by providing a given NFT. This is particularly useful when using groups of guards as we may want each of them to have a different mint limit.

• Limit: The maximum number of mints allowed per NFT for that identifier.

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

Set up a Candy Machine using the NFT Mint Limit guard

JavaScript

create(umi, {
  // ...
  guards: {
    nftMintLimit: some({
      id: 1,
      limit: 5,
      requiredCollection: requiredCollectionNft.publicKey,
    }),
  },
});

API References: create, MintLimit

Mint Settings

The NFT Mint Limit guard contains the following Mint Settings:

• ID: A unique identifier for this guard.

• Mint: The mint address of the NFT to provide as proof that the payer owns an NFT from the required collection.

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.

Mint with the NFT Mint Limit Guard

JavaScript

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

mintV1(umi, {
  // ...
  mintArgs: {
    nftMintLimit: some({ id: 1, mint: nftToVerify.publicKey }),
  },
});

Route Instruction

The NFT Mint Limit guard does not support the route instruction.