Type Alias: TokenPoolConfig

TokenPoolConfig = { minBlockConfirmations?: number; router: string; token: string; tokenTransferFeeConfig?: TokenTransferFeeConfig; typeAndVersion?: string; }

Defined in: chain.ts:399

Token pool configuration returned by Chain.getTokenPoolConfig.

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.

Properties

minBlockConfirmations?

optional minBlockConfirmations?: number

Defined in: chain.ts:417

Min custom block confirmations for Faster-Than-Finality (FTF), if TokenPool version \>= v2.0.0 and FTF is supported on this lane. 0 indicates FTF is supported but not enabled for this token; >0 indicates FTF is enabled with this many minimum confirmations.

---

router

router: string

Defined in: chain.ts:403

Address of the CCIP router this pool is registered with.

---

token

token: string

Defined in: chain.ts:401

Address of the token managed by this pool.

---

tokenTransferFeeConfig?

optional tokenTransferFeeConfig?: TokenTransferFeeConfig

Defined in: chain.ts:423

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

Defined in: chain.ts:410

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

Remarks

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