Type Alias: TokenPoolRemote

TokenPoolRemote = { inboundRateLimiterState: RateLimiterState; inboundStatus?: LaneStatus; outboundRateLimiterState: RateLimiterState; outboundStatus?: LaneStatus; remotePools: string[]; remoteToken: string; } & ({ fastInboundRateLimiterState: RateLimiterState; fastOutboundRateLimiterState: RateLimiterState; } | object)

Defined in: chain.ts:792

Remote token pool configuration for a specific destination chain.

Type Declaration

inboundRateLimiterState

inboundRateLimiterState: RateLimiterState

Inbound rate limiter state for tokens coming into this chain.

inboundStatus?

optional inboundStatus?: LaneStatus

Whether the pool lets transfers of the token come in from this remote chain now. Only pools with lane-level pauses and config records (multi-token pools) report it.

outboundRateLimiterState

outboundRateLimiterState: RateLimiterState

Outbound rate limiter state for tokens leaving this chain.

outboundStatus?

optional outboundStatus?: LaneStatus

Whether the pool lets transfers of the token go out to this remote chain now. Only pools with lane-level pauses and config records (multi-token pools) report it.

remotePools

remotePools: string[]

Addresses of remote token pools on the destination chain.

Remarks

Multiple pools may exist for:

• Redundancy (failover if one pool is unavailable)
• Capacity aggregation across pools
• Version management (different pool implementations)

remoteToken

remoteToken: string

Address of the remote token on the destination chain.

Remarks

Each entry represents the configuration needed to transfer tokens from the current chain to a specific destination chain.

The fastOutboundRateLimiterState and fastInboundRateLimiterState fields are present only for TokenPool v2.0+ contracts. These provide separate rate limits applied when Faster-Than-Finality (FTF) or FCR (safe finality) is used.