Type alias FreezeTokenPaymentGuardSettings

FreezeTokenPaymentGuardSettings: {
    mint: PublicKey;
    amount: SplTokenAmount;
    destinationAta: PublicKey;

The freezeTokenPayment guard allows minting frozen NFTs by charging the payer a specific amount of tokens from a certain mint acount. Frozen NFTs cannot be transferred or listed on any marketplaces until thawed.

The funds are transferred to a freeze escrow until all NFTs are thaw, at which point, they can be transferred (unlocked) to the configured destination account.

This object defines the settings that should be provided when creating and/or updating a Candy Machine if you wish to enable this guard.


FreezeTokenPaymentGuardRouteSettings to learn more about the instructions that can be executed against this guard.

Type declaration

  • mint: PublicKey

    The mint address of the required tokens.

  • amount: SplTokenAmount

    The amount of tokens required to mint an NFT.

  • destinationAta: PublicKey

    The associated token address to send the tokens to.

Generated using TypeDoc