Allocation Guard

Overview

The Allocation guard allows specifying a limit on the number of Assets each guard group can mint.

The limit is set per identifier — provided in the settings — to allow multiple allocations within the same Core Candy Machine.

Guard Settings

The Allocation 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 on the guard group.

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

Mint Settings

The Allocation guard contains the following Mint Settings:

• ID: A unique identifier for this guard.

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: {
    allocation: some({ id: 1 }),
  },
});

Route Instruction

The Allocation guard route instruction supports the following features.

Initialize the Allocation Tracker

When using the Allocation guard, we must initialize the Allocation Tracker account before minting can start. This will create a PDA account derived from the id attribute of the guard's settings.

The Allocation Tracker PDA account will keep track of the number of mints in a guard group and it will block any mint within that group once the limit has been reached.

When initializing this Allocation Tracker account, we must provide the following arguments to the route instruction of the guard:

• ID: The id of the Allocation of the guard's settings.
• Candy Guard Authority: The authority of the Core Candy Guard account as a Signer.

route(umi, {
  // ...
  guard: 'allocation',
  routeArgs: {
    id: 1,
    candyGuardAuthority: umi.identity,
  },
})

route(umi, {
  // ...
  guard: 'allocation',
  routeArgs: {
    id: 1,
    candyGuardAuthority: umi.identity,
  },
  group: some('GROUPA'),
})

Allocation Accounts

When the Allocation Guard is used a allocationTracker Account is created after the route instruction was run. For validation purposes it can be fetched like this:

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

const allocationTracker = await safeFetchAllocationTrackerFromSeeds(umi, {
  id: 1, // The allocation id you set in your guard config
  candyMachine: candyMachine.publicKey,
  // or candyMachine: publicKey("Address") with your CM Address
  candyGuard: candyMachine.mintAuthority,
  // or candyGuard: publicKey("Address") with your candyGuard Address
});