Skip to main content
Version: 1.1.1

Type Alias: TokenPoolRemote

TokenPoolRemote = { inboundRateLimiterState: RateLimiterState; outboundRateLimiterState: RateLimiterState; remotePools: string[]; remoteToken: string; } & { customBlockConfirmationsInboundRateLimiterState: RateLimiterState; customBlockConfirmationsOutboundRateLimiterState: RateLimiterState; } | object

Defined in: chain.ts:294

Remote token pool configuration for a specific destination chain.

Type Declaration​

inboundRateLimiterState​

inboundRateLimiterState: RateLimiterState

Inbound rate limiter state for tokens coming into this chain.

outboundRateLimiterState​

outboundRateLimiterState: RateLimiterState

Outbound rate limiter state for tokens leaving this chain.

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 customBlockConfirmationsOutboundRateLimiterState and customBlockConfirmationsInboundRateLimiterState fields are present only for TokenPool v2.0+ contracts. These provide separate rate limits applied when Faster-Than-Finality (FTF) custom block confirmations are used.