Token Gate Guard

The Token Gate guard restricts minting to token holders of a configured mint account. If the payer does not have the required amount of tokens, minting will fail.

Check that the

payer's token account

contains x amount tokens

Core Candy Machine

Owner: Core Candy Machine Core Program

Core Candy Guard

Owner: Core Candy Guard Program

GuardsToken Gate- Amount- Token Mint...

Mint Account

Owner: Token Program

Mint from

Core Candy Guard Program

Access Control

Mint from

Core Candy Machine Program

Mint Logic

Asset

React Flow

Guard Settings

The Token Gate guard contains the following settings:

• Amount: The number of tokens required.

• Mint: The address of the mint account defining the SPL Token we want to gate with.

Set up a Candy Machine using the Token Gate guard

JavaScript

create(umi, {
  // ...
  guards: {
    tokenGate: some({
      amount: 300,
      mint: tokenMint.publicKey,
    }),
  },
});

API References: create, TokenGate

Mint Settings

The Token Gate guard contains the following Mint Settings:

• Mint: The address of the mint account defining the SPL Token we want to gate with.

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 Token Gate Guard

JavaScript

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

mintV1(umi, {
  // ...
  mintArgs: {
    tokenGate: some({ mint: tokenMint.publicKey }),
  },
});

API References: mintV1, TokenGateMintArgs

Route Instruction

The Token Gate guard does not support the route instruction.