Class: WithdrawFromLockbox

Defined in: cct/evm/lockbox/operations/withdraw.ts:68

Withdraws tokens from an ERC20LockBox as one of its authorized callers (v2.0.0).

Extends

• EVMOperation<WithdrawFromLockboxParams>

Constructors

Constructor

new WithdrawFromLockbox(): WithdrawFromLockbox

Returns

WithdrawFromLockbox

Inherited from

EVMOperation<WithdrawFromLockboxParams>.constructor

Properties

name

readonly name: "withdrawFromLockbox" = 'withdrawFromLockbox'

Defined in: cct/evm/lockbox/operations/withdraw.ts:69

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

Overrides

EVMOperation.name

Methods

buildUnsigned()

protected buildUnsigned(chain: EVMChain, __namedParameters: WithdrawFromLockboxParams): Promise<UnsignedEVMTx>

Defined in: cct/evm/lockbox/operations/withdraw.ts:102

Confirms the target is a deployed, supported lockbox escrowing token, that it holds enough of it, and — with a known sender — that it accepts calls from that account.

Parameters

Parameter	Type
chain	EVMChain
__namedParameters	WithdrawFromLockboxParams

Returns

Promise<UnsignedEVMTx>

Remarks

The balance check runs without a sender, unlike the caller check: what the lockbox holds is a property of the lockbox, so it is worth catching for an offline builder too. It is advisory either way — every CCIP transfer through the pool moves that balance, so this catches "withdraw more than was ever deposited" rather than proving the amount still fits when the tx mines.

Throws

CCTParamsInvalidError if nothing at lockbox answers typeAndVersion(), if the lockbox escrows a different token, or if sender is not an authorized caller

Throws

CCTContractTypeInvalidError if lockbox is some other contract, e.g. the pool

Throws

CCTContractVersionUnsupportedError if it reports an unsupported version

Throws

CCTTxFailedError if the lockbox holds less than amount

Overrides

EVMOperation.buildUnsigned

---

execute()

execute(chain: EVMChain, params: EVMExecuteParams<WithdrawFromLockboxParams>): 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<WithdrawFromLockboxParams>

Returns

Promise<TransactionResult>

Inherited from

EVMOperation.execute

---

generate()

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

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

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

Parameters

Parameter	Type
chain	EVMChain
params	WithdrawFromLockboxParams

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

---

parse()

protected parse(params: WithdrawFromLockboxParams): WithdrawFromLockboxParams

Defined in: cct/operation.ts:42

Normalize validated params for the builder — defaults, conversions, derived values. Identity by default, so an op that needs no normalization declares nothing.

Parameters

Parameter	Type
params	WithdrawFromLockboxParams

Returns

WithdrawFromLockboxParams

Inherited from

EVMOperation.parse

---

prepare()

protected prepare(params: WithdrawFromLockboxParams): WithdrawFromLockboxParams

Defined in: cct/operation.ts:48

validate then parse — the single pre-RPC step, before any chain access.

Parameters

Parameter	Type
params	WithdrawFromLockboxParams

Returns

WithdrawFromLockboxParams

Inherited from

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

---

validate()

protected validate(__namedParameters: WithdrawFromLockboxParams): void

Defined in: cct/evm/lockbox/operations/withdraw.ts:72

Validates every param before any RPC; a zero amount reverts TokenAmountCannotBeZero.

Parameters

Parameter	Type
__namedParameters	WithdrawFromLockboxParams

Returns

void

Overrides

EVMOperation.validate