Skip to main content
Version: 1.6.2

Type Alias: TokenPoolConfig

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

Defined in: chain.ts:469

Token pool configuration returned by Chain.getTokenPoolConfig.

Type Declaration​

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.