Class: GetLockbox

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

Reads the lockbox a v2.0.0 LockRelease pool escrows through — fixed in its constructor and immutable thereafter.

The address the lockbox liquidity ops need: a v2.0.0 pool cannot release until someone deposits into this lockbox, and depositing needs the lockbox's own address rather than the pool's. Also the check behind "is this pool wired to the lockbox I authorized", which is where a deployLockbox → deployTokenPool sequence goes wrong silently.

Extends

• EVMQuery<GetLockboxParams, GetLockboxResult>

Constructors

Constructor

new GetLockbox(): GetLockbox

Returns

GetLockbox

Inherited from

EVMQuery<GetLockboxParams, GetLockboxResult>.constructor

Properties

name

readonly name: "getLockbox" = 'getLockbox'

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

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

Overrides

EVMQuery.name

Methods

prepare()

protected prepare(params: GetLockboxParams): GetLockboxParams

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

Validates the pool address; nothing to convert for read.

Parameters

Parameter	Type
params	GetLockboxParams

Returns

GetLockboxParams

Throws

CCTParamsInvalidError if poolAddress is not a valid address

Overrides

EVMQuery.prepare

---

query()

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

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters

Parameter	Type
chain	EVMChain
params	GetLockboxParams

Returns

Promise<string>

Inherited from

EVMQuery.query

---

read()

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

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

Resolves the pool's type/version before the read, so a pool without the getter reports which of the three reasons applies rather than a bare call failure. Type first, then version: a BurnMint or siloed pool has no single lockbox at any version, while the version check is the narrower "this shape of pool, but too old".

Parameters

Parameter	Type
chain	EVMChain
__namedParameters	GetLockboxParams

Returns

Promise<string>

Throws

CCTContractTypeInvalidError if the pool is a BurnMint pool, or a SiloedLockReleaseTokenPool — see assertNonSiloedLockReleasePool

Throws

CCTOperationUnsupportedError below v2.0.0, where a LockRelease pool holds its liquidity itself — see getRebalancer / provideLiquidity for those versions

Throws

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides

EVMQuery.read