Class: WithdrawLiquidity

Defined in: cct/evm/token-pool/operations/withdraw-liquidity.ts:58

Withdraws tokens from a LockRelease pool to its rebalancer (v1.5.0–v1.6.1).

Extends

• EVMOperation<WithdrawLiquidityParams>

Constructors

Constructor

new WithdrawLiquidity(): WithdrawLiquidity

Returns

WithdrawLiquidity

Inherited from

EVMOperation<WithdrawLiquidityParams>.constructor

Properties

name

readonly name: "withdrawLiquidity" = 'withdrawLiquidity'

Defined in: cct/evm/token-pool/operations/withdraw-liquidity.ts:59

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

Overrides

EVMOperation.name

Methods

buildUnsigned()

protected buildUnsigned(chain: EVMChain, params: WithdrawLiquidityParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/token-pool/operations/withdraw-liquidity.ts:93

Resolves the pool's type/version, floor-matches the encoder, then confirms sender (when given) is the pool's rebalancer.

Parameters

Parameter	Type
chain	EVMChain
params	WithdrawLiquidityParams

Returns

Promise<UnsignedEVMTx>

Remarks

The rebalancer check lives here, not in execute, so the offline / multisig path gets it too rather than being handed a transaction that reverts once signed.

Throws

CCTContractTypeInvalidError if the pool is a BurnMint pool

Throws

CCTOperationUnsupportedError on a v2.0.0 pool, which escrows through an ERC20LockBox instead

Throws

CCTParamsInvalidError if sender is given and is not the pool's rebalancer

Throws

CCTTxFailedError if the pool's withdrawable liquidity is below amount

Throws

CCTContractVersionUnsupportedError if the pool reports an unknown version

Overrides

EVMOperation.buildUnsigned

---

execute()

execute(chain: EVMChain, params: EVMExecuteParams<WithdrawLiquidityParams>): Promise<TransactionResult>

Defined in: cct/evm/operation.ts:150

generate, then sign and submit; returns the confirmed tx hash.

Parameters

Parameter	Type
chain	EVMChain
params	EVMExecuteParams<WithdrawLiquidityParams>

Returns

Promise<TransactionResult>

Inherited from

EVMOperation.execute

---

generate()

generate(chain: EVMChain, params: WithdrawLiquidityParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/operation.ts:110

Run prepare and buildUnsigned, applying optional sender; no signing.

Parameters

Parameter	Type
chain	EVMChain
params	WithdrawLiquidityParams

Returns

Promise<UnsignedEVMTx>

Remarks

Also pins every built transaction to chain.network.chainId (no RPC, known at construction). This is the one point every CCT builder and both execute paths pass through; unpinned, ethers would infer the chain from the eventual signer's provider.

Inherited from

EVMOperation.generate

---

prepare()

protected prepare(params: WithdrawLiquidityParams): WithdrawLiquidityParams

Defined in: cct/evm/token-pool/operations/withdraw-liquidity.ts:71

Validates the pool address and amount before any RPC; a zero amount moves nothing.

Parameters

Parameter	Type
params	WithdrawLiquidityParams

Returns

WithdrawLiquidityParams

Overrides

EVMOperation.prepare

---

resolveWalletSender()

protected resolveWalletSender(wallet: unknown, sender?: string): Promise<string>

Defined in: cct/evm/operation.ts:130

Resolves the address a signed submission is authorized against: the signing wallet's own. The chain gates on msg.sender, and submit clears any builder-set tx.from before populating the tx (so ethers' own from/signer guard never fires) — an explicit sender that differs from the wallet would therefore let an op's pre-tx checks authorize one address while a different one actually signs, passing every local guard and reverting on-chain. Ops that gate on an on-chain role call this from execute; build with generateUnsigned* instead when the eventual signer isn't known yet, where sender is trusted as given.

Parameters

Parameter	Type
wallet	unknown
sender?	string

Returns

Promise<string>

Throws

CCIPWalletInvalidError if wallet is not a valid signer

Throws

CCTParamsInvalidError if sender is given and is not the wallet's address

Inherited from

EVMOperation.resolveWalletSender