Skip to main content
Version: 1.15.0

Class: GetAllowlist

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

Reads the sender allowlist a token pool enforces.

Extends​

Constructors​

Constructor​

new GetAllowlist(): GetAllowlist

Returns​

GetAllowlist

Inherited from​

EVMQuery<GetAllowlistParams, GetAllowlistResult>.constructor

Properties​

name​

readonly name: "getAllowlist" = 'getAllowlist'

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

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

Overrides​

EVMQuery.name

Methods​

prepare()​

protected prepare(params: GetAllowlistParams): GetAllowlistParams

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

Parameters​

ParameterType
paramsGetAllowlistParams

Returns​

GetAllowlistParams

Throws​

CCTParamsInvalidError if poolAddress is not a valid address

Overrides​

EVMQuery.prepare


query()​

query(chain: EVMChain, params: GetAllowlistParams): Promise<GetAllowlistResult>

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainEVMChain
paramsGetAllowlistParams

Returns​

Promise<GetAllowlistResult>

Inherited from​

EVMQuery.query


read()​

protected read(chain: EVMChain, __namedParameters: GetAllowlistParams): Promise<GetAllowlistResult>

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

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

Parameters​

ParameterType
chainEVMChain
__namedParametersGetAllowlistParams

Returns​

Promise<GetAllowlistResult>

Throws​

CCTContractTypeInvalidError if the pool's reported type is not supported

Throws​

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides​

EVMQuery.read