Interface: ChainRateLimiterConfig

Defined in: token-admin/types.ts:889

Rate limiter configuration for a specific remote chain.

Used by SetChainRateLimiterConfigParams to update rate limits on an already-configured remote chain. Unlike RemoteChainConfig, this does not include pool/token address fields — only rate limits.

Example

TypeScript

const config: ChainRateLimiterConfig = {
  remoteChainSelector: 16015286601757825753n,
  outboundRateLimiterConfig: { isEnabled: true, capacity: '100000000000000000000000', rate: '167000000000000000000' },
  inboundRateLimiterConfig: { isEnabled: true, capacity: '100000000000000000000000', rate: '167000000000000000000' },
}

Properties

customBlockConfirmations?

optional customBlockConfirmations?: boolean

Defined in: token-admin/types.ts:904

Whether to set the custom block confirmations (FTF) rate limits.

• false (default): sets the default rate limits (normal finality transfers)
• true: sets the FTF (Faster-Than-Finality) rate limits bucket

Only applies to EVM v2.0+ pools. Ignored on v1.5/v1.6 pools and non-EVM chains.

---

inboundRateLimiterConfig

inboundRateLimiterConfig: RateLimiterConfig

Defined in: token-admin/types.ts:895

Inbound rate limiter (remote → local).

---

outboundRateLimiterConfig

outboundRateLimiterConfig: RateLimiterConfig

Defined in: token-admin/types.ts:893

Outbound rate limiter (local → remote).

---

remoteChainSelector

remoteChainSelector: bigint

Defined in: token-admin/types.ts:891

Remote chain selector (uint64 as string).