Skip to main content

Mint Limit

Overview

The Mint Limit guard allows specifying a limit on the number of NFTs each wallet can mint.

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

CandyMachinesV3-GuardsMintLimit.png

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 a given wallet. 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 wallet for that identifier.

JS SDK

Here’s how we can set up a Candy Machine using the Mint Limit guard via the JS SDK.

const { candyMachine } = await metaplex.candyMachines().create({
// ...
guards: {
mintLimit: {
id: 1,
limit: 5,
},
},
});

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

Mint Settings

The Mint Limit guard does not need Mint Settings.

However, if you’re planning on constructing instructions without the help of our SDKs, you will need to add the Mint Counter PDA to the remaining accounts of the mint instruction. See the Candy Guard’s program documentation for more details.

Route Instruction

The Mint Limit guard does not support the route instruction.