Type alias FreezeTokenPaymentRouteArgsUnlockFunds

FreezeTokenPaymentRouteArgsUnlockFunds: {
    candyGuardAuthority: Signer;
    destinationAta: PublicKey<string>;
    mint: PublicKey<string>;
    path: "unlockFunds";
}

The unlockFunds path transfers all of the escrow funds to the configured destination token address once all NFTs have been thawed.

route(umi, {
  // ...
  guard: 'freezeTokenPayment',
  routeArgs: {
    path: 'unlockFunds',
    mint: tokenMint.publicKey,
    destinationAta,
    candyGuardAuthority,
  },
});

Type declaration

  • candyGuardAuthority: Signer

    The authority of the Candy Guard as a Signer.

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

    Selects the path to execute in the route instruction.

Settings

Member Visibility

Theme

Generated using TypeDoc