Type Alias: TokenPoolConfig

TokenPoolConfig = { feeAdmin?: string; minBlockConfirmations?: number; owner: string; proposedOwner?: string; rateLimitAdmin?: string; 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

feeAdmin?

optional feeAdmin?: string

Defined in: chain.ts:431

Address of the fee admin (EVM v2.0+ only).

Remarks

The fee admin can configure token transfer fees. Only available on EVM pools v2.0+ (from getDynamicConfig()).

---

minBlockConfirmations?

optional minBlockConfirmations?: number

Defined in: chain.ts:438

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.

---

owner

owner: string

Defined in: chain.ts:405

Current owner of the token pool.

---

proposedOwner?

optional proposedOwner?: string

Defined in: chain.ts:407

Proposed new owner (if an ownership transfer is pending).

---

rateLimitAdmin?

optional rateLimitAdmin?: string

Defined in: chain.ts:423

Address of the rate limit admin, if set.

Remarks

The rate limit admin can update rate limiter configs without being the pool owner. Not available on Aptos (setRateLimitAdmin is unsupported). A zero-address value indicates no rate limit admin is set.

---

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:444

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:414

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

Remarks

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