Skip to main content
Version: 1.16.0

Interface: GetRateLimiterStateResult

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:21

Result of getRateLimiterState: the rate limiter's config.

Properties​

capacity​

capacity: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:37

Bucket capacity (max tokens).


direction​

direction: "outbound" | "inbound"

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:31

Direction the limiter applies to.


instanceId​

instanceId: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:23

Rate-limiter instance ID.


isEnabled​

isEnabled: boolean

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:35

Whether the limiter is enabled.


mode​

mode: "defaultFinality" | "customFinality"

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:33

Finality mode.


observers​

observers: string[]

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:43

Observer parties (EDS auto-detection).


poolInstanceId​

poolInstanceId: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:25

Instance ID of the pool this limiter serves.


poolOwner​

poolOwner: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:27

Pool owner party (signatory of the RateLimiter contract).


rate​

rate: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:39

Refill rate (tokens per second).


remoteChainSelector​

remoteChainSelector: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:29

Remote chain selector this limiter applies to.


tokens​

tokens: string

Defined in: cct/canton/token-pool/operations/get-rate-limiter-state.ts:41

Current available tokens in the bucket.