Skip to main content
Version: 1.17.0

Type Alias: PoolProgramRef

PoolProgramRef = { poolProgramAddress?: string; }

Defined in: cct/solana/programs/token-pool.ts:42

Identifies the program of an existing token pool.

Remarks​

Operations throw CCTParamsInvalidError if poolProgramAddress is omitted and the mint has no canonical pool, or both, and CCIPTokenPoolStateNotFoundError if no pool state exists under the given poolProgramAddress.

Properties​

poolProgramAddress?​

optional poolProgramAddress?: string

Defined in: cct/solana/programs/token-pool.ts:48

Token pool program that owns the pool. Omit for a burn-mint or lock-release pool at the canonical program address, which is resolved on-chain from tokenAddress; set it for a custom program or where the pool programs are deployed elsewhere.