Skip to main content
Version: 1.16.0

Class: GetSiloedLockbox

Defined in: cct/evm/token-pool/operations/get-siloed-lockbox.ts:41

Reads the lockbox a lane escrows through: the exact lookup the pool makes on every transfer on that lane, and the address depositToLockbox / withdrawFromLockbox need to fund it. getAllSiloedLockboxConfigs is the non-throwing way to see every lane at once.

Extends​

Constructors​

Constructor​

new GetSiloedLockbox(): GetSiloedLockbox

Returns​

GetSiloedLockbox

Inherited from​

EVMQuery<GetSiloedLockboxParams, GetSiloedLockboxResult>.constructor

Properties​

name​

readonly name: "getSiloedLockbox" = 'getSiloedLockbox'

Defined in: cct/evm/token-pool/operations/get-siloed-lockbox.ts:42

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

Overrides​

EVMQuery.name

Methods​

prepare()​

protected prepare(params: GetSiloedLockboxParams): GetSiloedLockboxParams

Defined in: cct/evm/token-pool/operations/get-siloed-lockbox.ts:49

Validates the pool address and lane; nothing to convert for read.

Parameters​

ParameterType
paramsGetSiloedLockboxParams

Returns​

GetSiloedLockboxParams

Throws​

CCTParamsInvalidError if poolAddress is not a valid address, or remoteChainSelector is not a uint64

Overrides​

EVMQuery.prepare


query()​

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

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainEVMChain
paramsGetSiloedLockboxParams

Returns​

Promise<string>

Inherited from​

EVMQuery.query


read()​

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

Defined in: cct/evm/token-pool/operations/get-siloed-lockbox.ts:66

Resolves the pool's type/version before the read, so a pool without the getter reports which of the two reasons applies rather than a bare call failure.

Parameters​

ParameterType
chainEVMChain
__namedParametersGetSiloedLockboxParams

Returns​

Promise<string>

Throws​

CCTContractTypeInvalidError if the pool is not a SiloedLockReleaseTokenPool (a non-siloed pool's single lockbox is getLockbox)

Throws​

CCTOperationUnsupportedError below v2.0.0, where a siloed pool holds its silos itself

Throws​

CCTParamsInvalidError if no lockbox is bound to the lane (the pool's LockBoxNotConfigured revert)

Throws​

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides​

EVMQuery.read