Token Gate

Overview

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.

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.

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

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 Candy Guard’s program documentation for more details.

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

Route Instruction

The Token Gate guard does not support the route instruction.