Available Guards

Freeze Token Payment

Overview

The Freeze Token Payment guard allows minting frozen Assets by charging the payer a specific amount of tokens from a certain mint account. Frozen Assets cannot be transferred or listed on any marketplaces until thawed.

Frozen Assets can be thawed by anyone as long as one of the following conditions is met:

  • The Candy Machine has minted out.
  • The Candy Machine was deleted.
  • The configured Freeze Period — which can be a maximum of 30 days — has passed.

The tokens are transferred to a "Freeze Escrow" account which must be initialized by the Candy Guard authority before minting can start. Once all Frozen Assets have been thawed, the funds can be unlocked and transferred to the configured destination account by the Candy Guard authority.

You may initialize the Freeze Escrow account, thaw Assets and unlock funds via the route instruction of this guard.

React Flow

Guard Settings

The Freeze Token Payment guard contains the following settings:

  • Amount: The number of tokens to charge the payer.
  • Mint: The address of the mint account defining the SPL Token we want to pay with.
  • Destination Associated Token Address (ATA): The address of the associated token account to eventually send the tokens to. We can get this address by finding the Associated Token Address PDA using the Mint attribute and the address of any wallet that should receive these tokens.

Set up a Candy Machine using the Freeze Token Payment guard

Here’s how we can create a Candy Machine using the Freeze Token Payment guard. Note that, in this example, we’re using Umi's identity as the destination wallet.

import { findAssociatedTokenPda } from "@metaplex-foundation/mpl-toolbox";

create(umi, {
  // ...
  guards: {
    freezeTokenPayment: some({
      amount: 300,
      mint: tokenMint.publicKey,
      destinationAta: findAssociatedTokenPda(umi, {
        mint: tokenMint.publicKey,
        owner: umi.identity.publicKey,
      }),
    }),
  },
});

Mint Settings

The Freeze Token Payment guard contains the following Mint Settings:

  • Mint: The address of the mint account defining the SPL Token we want to pay with.
  • Destination Associated Token Address (ATA): The address of the associated token account to eventually send the tokens to.

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.

Set up a Candy Machine using the Freeze Token Payment Guard

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

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

Route Instruction

The Freeze Token Payment route instruction supports the following features.

Initialize the Freeze Escrow

Path: initialize

When using the Freeze Token Payment guard, we must initialize the Freeze Escrow account before minting can start. This will create a PDA account derived from the Destination ATA attribute of the guard's settings.

The Freeze Escrow PDA account will keep track of several parameters such as:

  • How many Frozen Assets were minted through this guard.
  • When was the first Frozen Asset minted via this guard as the Freeze Period starts counting after that.

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

  • Path = initialize: Selects the path to execute in the route instruction.
  • Mint: The address of the mint account defining the SPL Token we want to pay with.
  • Destination Associated Token Address (ATA): The address of the associated token account to eventually send the tokens to.
  • Period: The amount of time in seconds that the Freeze Period should last. This can be a maximum of 30 days (2,592,000 seconds) and it will start from the very first Frozen Asset minted via this guard. The Freeze Period provides a safety mechanism to ensure Frozen Assets can eventually be thawed even if the Candy Machine never mints out.
  • Candy Guard Authority: The authority of the Candy Guard account as a Signer.
React Flow

Last but not least, the Freeze Escrow PDA account will receive the funds of all Frozen Assets minted through this guard.

React Flow

Initialize the Freeze Escrow

In the example below, we initialize the Freeze Escrow account with a maximum Freeze Period of 15 days and we use the current identity as the Core Candy Guard authority.

route(umi, {
  // ...
  guard: "freezeTokenPayment",
  routeArgs: {
    path: "initialize",
    mint: tokenMint.publicKey,
    destinationAta,
    period: 15 * 24 * 60 * 60, // 15 days.
    candyGuardAuthority: umi.identity,
  },
});

Thaw a Frozen Asset

Path: thaw

Frozen Assets can be thawed by anyone as long as one of the following conditions is met:

  • The Core Candy Machine has minted out.
  • The Core Candy Machine was deleted.
  • The configured Freeze Period — which can be a maximum of 30 days — has passed.

Note that since the tokens in the Freeze Escrow are not transferrable until all Assets are thawed, this creates an incentive for the treasury to thaw all Assets as soon as possible.

To thaw a Frozen Asset, we must provide the following arguments to the route instruction of the guard:

  • Path = thaw: Selects the path to execute in the route instruction.
  • Mint: The address of the mint account defining the SPL Token we want to pay with.
  • Destination Associated Token Address (ATA): The address of the associated token account to eventually send the tokens to.
  • Asset Adress: The mint address of the Frozen Asset to thaw.
  • Asset Owner: The address of the owner of the Frozen Asset to thaw.
React Flow

Set up a Candy Machine using the Freeze Token Payment guard

In the example below, we thaw a Frozen Asset that belongs to the current identity.

route(umi, {
  // ...
  guard: "freezeTokenPayment",
  routeArgs: {
    path: "thaw",
    mint: tokenMint.publicKey,
    destinationAta,
    AssetMint: AssetMint.publicKey,
    AssetOwner: umi.identity.publicKey,
    AssetTokenStandard: candyMachine.tokenStandard,
  },
});

Unlock Funds

Path: unlockFunds

Once all Frozen Assets have been thawed, the treasury can unlock the funds from the Freeze Escrow account. This will transfer the tokens to the configured Destination ATA address.

To unlock the funds, we must provide the following arguments to the route instruction of the guard:

  • Path = unlockFunds: Selects the path to execute in the route instruction.
  • Mint: The address of the mint account defining the SPL Token we want to pay with.
  • Destination Associated Token Address (ATA): The address of the associated token account to eventually send the tokens to.
  • Candy Guard Authority: The authority of the Core Candy Guard account as a Signer.
React Flow

Set up a Candy Machine using the Freeze Token Payment Guard

In the example below, we unlock the funds from the Freeze Escrow account using the current identity as the Candy Guard authority.

route(umi, {
  // ...
  guard: 'freezeTokenPayment',
  routeArgs: {
    path: 'unlockFunds',
    destination,
    candyGuardAuthority: umi.identity,
  },
})

API References: route, freezeTokenPaymentRouteArgsUnlockFunds

Stop Freezing Assets

It is possible to stop the freezing of Assets within a Freeze Token Payment guard. In other words, new-minted Assets will no longer be frozen but existing Frozen Assets will remain frozen.

There are several ways of achieving this, which can be separated into two categories:

  • ☀️ Can Thaw: Existing Frozen Assets can be thawed by anyone using the thaw path of the route instruction.
  • ❄️ Cannot Thaw: Existing Frozen Assets cannot be thawed yet and we have to wait for one "Can Thaw" condition to be met.

With that in mind, here is the exhaustive list of ways to stop freezing Assets and whether or not each of them allows thawing existing Frozen Assets:

  • The Candy Machine has minted out → ☀️ Can Thaw.
  • The configured Freeze Period — which can be a maximum of 30 days — has passed → ☀️ Can Thaw.
  • The Candy Machine account was deleted → ☀️ Can Thaw.
  • The Candy Guard account was deleted → ❄️ Cannot Thaw.
  • The Freeze Token Payment guard was removed from the settings → ❄️ Cannot Thaw.

Freeze Escrows and Guard Groups

When using multiple Freeze Token Payment guards within various Guard Groups, it is important to understand the relationship between a Freeze Token Payment guard and a Freeze Escrow account.

The Freeze Escrow account is a PDA derived from a Destination address. This means that if multiple Freeze Token Payment guards are configured to use the same Destination address, they will all share the same Freeze Escrow account.

Therefore, they will also share the same Freeze Period and all funds will be collected by the same escrow account. This also means, we only need to call the initialize route instruction once per configured Destination address.This implies that the route instruction is only required once per the configured Destination address. Same applies for unlockFunds. To thaw you can use whichever label you like provided that those shared the same escrow account.

It is also possible to use multiple Freeze Token Payment guards with different Destination addresses. In this case, each Freeze Token Payment guard will have its own Freeze Escrow account and its own Freeze Period.

The example below illustrates a Candy Machine with three Freeze Token Payment guards in three groups such that:

  • Groups 1 and 2 share the same Destination address and therefore the same Freeze Escrow account.
  • Group 3 has its own Destination address and therefore its own Freeze Escrow account.
React Flow
Previous
Freeze Sol Payment
Next
Gatekeeper