Type Alias: TokenPoolConfig

TokenPoolConfig = { lockBox?: string; previousPool?: string; previousPoolTypeAndVersion?: string; router: string; token: string; tokenTransferFeeConfig?: TokenTransferFeeConfig; typeAndVersion?: string; } & Partial<FinalityAllowed>

Defined in: chain.ts:493

Token pool configuration returned by Chain.getTokenPoolConfig.

Type Declaration

lockBox?

optional lockBox?: string

For LockReleaseTokenPool v2+, the address of the associated LockBox contract.

previousPool?

optional previousPool?: string

For Proxy TokenPools, the address of the previous pool implementation (if any).

previousPoolTypeAndVersion?

optional previousPoolTypeAndVersion?: string

For Proxy TokenPools, the typeAndVersion() string of the previous pool implementation (if any).

router

router: string

Address of the CCIP router this pool is registered with.

token

token: string

Address of the token managed by this pool.

tokenTransferFeeConfig?

optional tokenTransferFeeConfig?: TokenTransferFeeConfig

Token transfer fee configuration from the pool contract. Only present when TokenTransferFeeOpts is provided to Chain.getTokenPoolConfig and the pool supports it (v2.0+).

typeAndVersion?

optional typeAndVersion?: string

Version identifier string (e.g., "BurnMintTokenPool 1.5.1").

Remarks

May be undefined for older pool implementations that don't expose this method.

Remarks

Contains the core configuration of a token pool including the token it manages, the router it's registered with, and optionally its version identifier.