Type alias FreezeTokenPaymentRouteArgsInitialize

FreezeTokenPaymentRouteArgsInitialize: {
    candyGuardAuthority: Signer;
    destinationAta: PublicKey<string>;
    mint: PublicKey<string>;
    path: "initialize";
    period: number;
}

The initialize path creates the freeze escrow account that will hold the funds until all NFTs are thawed. It must be called before any NFTs can be minted.

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

Type declaration

  • candyGuardAuthority: Signer

    The authority of the Candy Guard as a Signer.

  • destinationAta: PublicKey<string>
  • mint: PublicKey<string>
  • path: "initialize"

    Selects the path to execute in the route instruction.

  • period: number

    The freeze period in seconds (maximum 30 days).

Settings

Member Visibility

Theme

Generated using TypeDoc