Skip to main content
Version: 1.15.0

Type Alias: RateLimitConfig

RateLimitConfig = { capacity: bigint; enabled: true; rate: bigint; } | { capacity?: bigint; enabled: false; rate?: bigint; }

Defined in: cct/solana/token-pool/operations/set-chain-rate-limit.ts:34

Configuration for one direction of a token pool rate limiter.

Union Members​

Type Literal​

{ capacity: bigint; enabled: true; rate: bigint; }

capacity​

capacity: bigint

Maximum token amount in the bucket (u64), at least rate.

enabled​

enabled: true

Whether this directional rate limit is enforced.

rate​

rate: bigint

Token amount restored to the bucket per second (u64), no greater than capacity.


Type Literal​

{ capacity?: bigint; enabled: false; rate?: bigint; }

capacity?​

optional capacity?: bigint

Must be zero when provided; defaults to zero.

enabled​

enabled: false

Whether this directional rate limit is enforced.

rate?​

optional rate?: bigint

Must be zero when provided; defaults to zero.

Remarks​

For a mint with 6 decimals, pass 1_000_000n to represent one token.