Skip to main content
Version: 1.15.0

Interface: GetRateLimiterStateResult

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

Result of getRateLimiterState: the rate limiter's config.

Properties​

capacity​

capacity: string

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

Bucket capacity (max tokens).

direction​

direction: "outbound" | "inbound"

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

Direction the limiter applies to.

instanceId​

instanceId: string

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

Rate-limiter instance ID.

isEnabled​

isEnabled: boolean

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

Whether the limiter is enabled.

mode​

mode: "defaultFinality" | "customFinality"

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

Finality mode.

observers​

observers: string[]

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

Observer parties (EDS auto-detection).

poolInstanceId​

poolInstanceId: string

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

Instance ID of the pool this limiter serves.

poolOwner​

poolOwner: string

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

Pool owner party (signatory of the RateLimiter contract).

rate​

rate: string

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

Refill rate (tokens per second).

remoteChainSelector​

remoteChainSelector: string

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

Remote chain selector this limiter applies to.

tokens​

tokens: string

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

Current available tokens in the bucket.