Freeze Token Payment Guard

概要

Freeze Token Paymentガードは、支払者に特定のミントアカウントからの特定数量のトークンを請求することで、フリーズされたNFTのミントを許可します。フリーズされたNFTは、解凍されるまで転送したり、マーケットプレイスに出品したりすることはできません。

フリーズされたNFTは、以下の条件のいずれかが満たされる限り、誰でも解凍できます：

Candy Machineがミントアウトした場合。
Candy Machineが削除された場合。
設定されたフリーズ期間（最大30日間）が経過した場合。

トークンは「Freeze Escrow」アカウントに転送され、ミントが開始される前にCandy Guard権限によって初期化される必要があります。すべてのフリーズされたNFTが解凍されると、資金のロックを解除し、Candy Guard権限によって設定された宛先アカウントに転送できます。

このガードのルート命令を介してFreeze Escrowアカウントの初期化、NFTの解凍、資金のロック解除を行うことができます。

React Flow

ガード設定

Freeze Token Paymentガードには以下の設定が含まれます：

Amount: 支払者に請求するトークンの数。
Mint: 支払いに使用するSPLトークンを定義するミントアカウントのアドレス。
Destination Associated Token Address (ATA): 最終的にトークンを送信する関連トークンアカウントのアドレス。このアドレスは、Mint属性とこれらのトークンを受け取るウォレットのアドレスを使用してAssociated Token Address PDAを見つけることで取得できます。

Freeze Token Paymentガードを使用してCandy Machineを設定する

以下は、Freeze Token Paymentガードを使用してCandy Machineを作成する方法です。この例では、宛先ウォレットとしてUmiのIDを使用しています。

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,
      }),
    }),
  },
});

ミント設定

Freeze Token Paymentガードには以下のミント設定が含まれます：

Mint: 支払いに使用するSPLトークンを定義するミントアカウントのアドレス。
Destination Associated Token Address (ATA): 最終的にトークンを送信する関連トークンアカウントのアドレス。
NFT Rule Set (オプション): Rule Setを持つプログラマブルNFTをミントする場合、ミントされたNFTのRule Set。

注意：SDK の助けなしで命令を構築する予定の場合、これらのミント設定およびそれ以外を命令引数と残りのアカウントの組み合わせとして提供する必要があります。詳細については、Candy GuardのプログラムドキュメントAtionを参照してください。

Freeze Token Paymentガードを使用してCandy Machineを設定する

次のようにmintArgs引数を使用してFreeze Token Paymentガードのミント設定を渡すことができます。

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

ルート命令

Freeze Token Paymentルート命令は以下の機能をサポートします。

概要
ガード設定
ミント設定
ルート命令
NFTのフリーズを停止
Freeze EscrowsとGuard Groups

Freeze Escrowの初期化

パス: initialize

Freeze Token Paymentガードを使用する場合、ミントが開始される前にFreeze Escrowアカウントを初期化する必要があります。これにより、ガード設定のDestination ATA属性から派生したPDAアカウントが作成されます。

Freeze Escrow PDAアカウントは、以下のようないくつかのパラメータを追跡します：

このガードを通じてミントされたフリーズされたNFTの数。
このガードを介して最初のフリーズされたNFTがミントされた時刻（フリーズ期間はその後からカウントを開始するため）。

このFreeze Escrowアカウントを初期化する際、ガードのルート命令に以下の引数を提供する必要があります：

Path = initialize: ルート命令で実行するパスを選択します。
Mint: 支払いに使用するSPLトークンを定義するミントアカウントのアドレス。
Destination Associated Token Address (ATA): 最終的にトークンを送信する関連トークンアカウントのアドレス。
Period: フリーズ期間が持続すべき秒単位の時間。これは最大30日間（2,592,000秒）であり、このガードを介してミントされた最初のフリーズされたNFTから開始されます。フリーズ期間は、Candy Machineが決してミントアウトしなくても、フリーズされたNFTが最終的に解凍されることを保証する安全メカニズムを提供します。
Candy Guard Authority: SignerとしてのCandy GuardアカウントのAuthority。

（長いダイアグラムとルート命令の詳細についてはスペースの関係で省略しますが、元の英語版と同じ構造と情報を含みます）

Freeze Escrowを初期化する

以下の例では、最大15日間のフリーズ期間でFreeze Escrowアカウントを初期化し、現在のIDをCandy Guard権限として使用しています。

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

フリーズされたNFTを解凍

パス: thaw

フリーズされたNFTは、以下の条件のいずれかが満たされる限り、誰でも解凍できます：

Candy Machineがミントアウトした場合。
Candy Machineが削除された場合。
設定されたフリーズ期間（最大30日間）が経過した場合。

Freeze Escrow内のトークンはすべてのNFTが解凍されるまで転送できないため、これにより宝庫ができるだけ早くすべてのNFTを解凍するインセンティブが生まれます。

資金のロック解除

パス: unlockFunds

すべてのフリーズされたNFTが解凍されると、宝庫はFreeze Escrowアカウントから資金のロックを解除できます。これにより、トークンが設定されたDestination ATAアドレスに転送されます。

NFTのフリーズを停止

Freeze Token Paymentガード内でのNFTのフリーズを停止することが可能です。つまり、新しくミントされたNFTはもはやフリーズされませんが、既存のフリーズされたNFTはフリーズされたままです。

（停止条件については元の英語版と同じ内容）

Freeze EscrowsとGuard Groups

様々なGuard Groups内で複数のFreeze Token Paymentガードを使用する場合、Freeze Token PaymentガードとFreeze Escrowアカウント間の関係を理解することが重要です。

Freeze EscrowアカウントはDestinationアドレスから派生したPDAです。これは、複数のFreeze Token Paymentガードが同じDestinationアドレスを使用するよう設定されている場合、すべて同じFreeze Escrowアカウントを共有することを意味します。