Skip to main content
Version: 1.15.0

Class: GetAllowlistEnabled

Defined in: cct/evm/token-pool/operations/get-allowlist-enabled.ts:29

Reads whether a token pool enforces a sender allowlist.

Extends​

Constructors​

Constructor​

new GetAllowlistEnabled(): GetAllowlistEnabled

Returns​

GetAllowlistEnabled

Inherited from​

EVMQuery< GetAllowlistEnabledParams, GetAllowlistEnabledResult >.constructor

Properties​

name​

readonly name: "getAllowlistEnabled" = 'getAllowlistEnabled'

Defined in: cct/evm/token-pool/operations/get-allowlist-enabled.ts:33

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

Overrides​

EVMQuery.name

Methods​

prepare()​

protected prepare(params: GetAllowlistEnabledParams): GetAllowlistEnabledParams

Defined in: cct/evm/token-pool/operations/get-allowlist-enabled.ts:36

Parameters​

ParameterType
paramsGetAllowlistEnabledParams

Returns​

GetAllowlistEnabledParams

Throws​

CCTParamsInvalidError if poolAddress is not a valid address

Overrides​

EVMQuery.prepare


query()​

query(chain: EVMChain, params: GetAllowlistEnabledParams): Promise<boolean>

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainEVMChain
paramsGetAllowlistEnabledParams

Returns​

Promise<boolean>

Inherited from​

EVMQuery.query


read()​

protected read(chain: EVMChain, __namedParameters: GetAllowlistEnabledParams): Promise<boolean>

Defined in: cct/evm/token-pool/operations/get-allowlist-enabled.ts:47

Resolves which contract holds the allowlist, then reads its flag. No getter call when a v2.0.0 pool has no hooks bound.

Parameters​

ParameterType
chainEVMChain
__namedParametersGetAllowlistEnabledParams

Returns​

Promise<boolean>

Throws​

CCTContractTypeInvalidError if the pool's reported type is not supported

Throws​

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides​

EVMQuery.read