Token Gate Guard

The Token Gate guard restricts minting to wallets that hold a minimum amount of a configured SPL token, without burning or transferring those tokens.

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

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

Route Instruction

The Token Gate guard does not support the route instruction.

Notes

• The Token Gate guard only checks that the payer holds the required token balance -- it does not burn or transfer any tokens. For guards that consume tokens, see Token Burn or Token Payment.
• This guard uses the original SPL Token program. It does not support Token-2022 mints.
• The token balance check occurs at the time of minting. If the payer's balance drops below the required Amount between guard evaluation and transaction execution, the mint will fail.