Skip to main content
Version: 1.16.1

Class: GetRateLimitAdmin

Defined in: cct/evm/token-pool/operations/get-rate-limit-admin.ts:27

Reads a token pool's rate-limit admin: the account besides the owner allowed to call setChainRateLimiterConfigs. Set with setRateLimitAdmin before v2.0.0 and with setDynamicConfig on v2.0.0.

Extends​

Constructors​

Constructor​

new GetRateLimitAdmin(): GetRateLimitAdmin

Returns​

GetRateLimitAdmin

Inherited from​

EVMQuery<GetRateLimitAdminParams, GetRateLimitAdminResult>.constructor

Properties​

name​

readonly name: "getRateLimitAdmin" = 'getRateLimitAdmin'

Defined in: cct/evm/token-pool/operations/get-rate-limit-admin.ts:28

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

Overrides​

EVMQuery.name

Methods​

prepare()​

protected prepare(params: GetRateLimitAdminParams): GetRateLimitAdminParams

Defined in: cct/evm/token-pool/operations/get-rate-limit-admin.ts:31

Parameters​

ParameterType
paramsGetRateLimitAdminParams

Returns​

GetRateLimitAdminParams

Throws​

CCTParamsInvalidError if poolAddress is not a valid address

Overrides​

EVMQuery.prepare


query()​

query(chain: EVMChain, params: GetRateLimitAdminParams): Promise<string>

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainEVMChain
paramsGetRateLimitAdminParams

Returns​

Promise<string>

Inherited from​

EVMQuery.query


read()​

protected read(chain: EVMChain, __namedParameters: GetRateLimitAdminParams): Promise<string>

Defined in: cct/evm/token-pool/operations/get-rate-limit-admin.ts:42

Resolves the pool's version to pick the getter: getRateLimitAdmin() on v1.5.0 to v1.6.1, getDynamicConfig()'s rateLimitAdmin on v2.0.0.

Parameters​

ParameterType
chainEVMChain
__namedParametersGetRateLimitAdminParams

Returns​

Promise<string>

Throws​

CCTContractTypeInvalidError if the pool's reported type is not supported

Throws​

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides​

EVMQuery.read