Skip to main content
Version: 1.15.0

Class: GetRateLimiterState

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

Read a RateLimiter contract's config from the ACS.

Extends​

Constructors​

Constructor​

new GetRateLimiterState(): GetRateLimiterState

Returns​

GetRateLimiterState

Inherited from​

CantonQuery< GetRateLimiterStateParams, GetRateLimiterStateResult, ParsedGetRateLimiterState >.constructor

Properties​

name​

readonly name: "getRateLimiterState" = 'getRateLimiterState'

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

camelCase id; matches the token-manager facade method and error context.

Overrides​

CantonQuery.name

Methods​

prepare()​

protected prepare(p: GetRateLimiterStateParams): ParsedGetRateLimiterState

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

Validates the rate-limiter target + owner.

Parameters​

ParameterType
pGetRateLimiterStateParams

Returns​

ParsedGetRateLimiterState

Overrides​

CantonQuery.prepare


query()​

query(chain: CantonChain, params: GetRateLimiterStateParams): Promise<GetRateLimiterStateResult>

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainCantonChain
paramsGetRateLimiterStateParams

Returns​

Promise<GetRateLimiterStateResult>

Inherited from​

CantonQuery.query


read()​

protected read(chain: CantonChain, p: ParsedGetRateLimiterState): Promise<GetRateLimiterStateResult>

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

Reads the RateLimiter contract from the ACS by InstanceAddress and decodes its createArgument. Throws when the contract is not active or not visible.

Parameters​

ParameterType
chainCantonChain
pParsedGetRateLimiterState

Returns​

Promise<GetRateLimiterStateResult>

Overrides​

CantonQuery.read