Asset Mint Limit Guard

Overview

The Asset Mint Limit guard restricts minting to holders of a specified collection and limits the amount of mints that can be done for a provided Core Asset. It can be considered as a combination of the NFT Gate for Core Assets and Mint Limit Guard, based on Asset Addresses instead of wallets.

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

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 Asset. 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 Asset for that identifier.
• Required Collection: The address of the required Collection. The Asset we provide as proof when minting must be part of this collection.

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

Mint Settings

The NFT Mint Limit guard contains the following Mint Settings:

• ID: A unique identifier for this guard.
• Asset: The address of the Asset to provide as proof that the payer owns an Asset 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.

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

Route Instruction

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

AssetMintLimit Accounts

When the AssetMintLimit Guard is used a AssetMintCounter Account is created for each Core NFT Asset, CandyMachine and id combination. For validation purposes it can be fetched like this:

import { 
  findAssetMintCounterPda,
  fetchNftMintCounter
 } from "@metaplex-foundation/mpl-core-candy-machine";

const pda = findAssetMintCounterPda(umi, {
  id: 1, // The nftMintLimit id you set in your guard config
  mint: asset.publicKey, // The address of the nft your user owns
  candyMachine: candyMachine.publicKey,
  // or candyMachine: publicKey("Address") with your CM Address
  candyGuard: candyMachine.mintAuthority
  // or candyGuard: publicKey("Address") with your candyGuard Address
});
      
const nftMintCounter = fetchAssetMintCounter(umi, pda)