Function callCandyGuardRouteOperation

Calls the special "route" instruction on a specific guard.

This allows guards to provide additional features such as creating PDAs that verify a payer before the mint instruction is executed or freezing and thawing minted NFTs.

The "route" instruction must select a specific guard on a specific group (if groups are enabled) since it is possible for the same type of guard to have different settings based on its group.

Additionally, it is possible for a guard to support multiple "paths" within their "route" instruction. The route settings of the guard will usually use the path property to distinguish them.

const { nft } = await metaplex
  .candyMachines()
  .callGuardRoute({
    candyMachine,
    guard: 'allowList',
    settings: {
      path: 'proof',
      merkleProof: getMerkleProof(data, leaf)
    },
  };