Type Alias: TokenPoolConfig

TokenPoolConfig = { connectionPolicyStore?: string; decimals?: number; feePolicyStore?: string; lockBox?: string; poolConfigManager?: string; previousPool?: string; previousPoolTypeAndVersion?: string; router: string; securityPolicyStore?: string; token: string; tokenTransferFeeConfig?: TokenTransferFeeConfig; typeAndVersion?: string; } & Partial<FinalityAllowed>

Defined in: chain.ts:836

Token pool configuration returned by Chain.getTokenPoolConfig.

Type Declaration

connectionPolicyStore?

optional connectionPolicyStore?: string

For multi-token pools, the ConnectionPolicyStore behind TokenPoolConfig.poolConfigManager. It stores the connection and remote pool records, token profiles and pauses, and emits their configuration events.

decimals?

optional decimals?: number

The decimals the pool declares for its token (getTokenDecimals(), pool v1.5.1+).

Remarks

The authoritative source when the token doesn't implement the optional ERC-20 decimals() view — the pool uses exactly these decimals for its own conversion. Absent for pools that predate getTokenDecimals() (v1.5.0 and earlier), which stay readable without it.

feePolicyStore?

optional feePolicyStore?: string

For multi-token pools, the FeePolicyStore behind TokenPoolConfig.poolConfigManager. It stores the fee and destination overhead records, and emits their configuration events.

lockBox?

optional lockBox?: string

For LockReleaseTokenPool v2+, the address of the associated LockBox contract; for a multi-token pool, the lock box of a token with the Lock flavor.

poolConfigManager?

optional poolConfigManager?: string

For multi-token pools, the PoolConfigManager that holds the configuration of each token.

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.

securityPolicyStore?

optional securityPolicyStore?: string

For multi-token pools, the SecurityPolicyStore behind TokenPoolConfig.poolConfigManager. It stores the rate limit and security (CCV and hook) records, and emits their configuration and rate limit consumption events.

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 TokenPoolConfigOpts.destChainSelector 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.