Type Alias: WithdrawFromLockboxParams

WithdrawFromLockboxParams = { amount: bigint; lockbox: string; recipient: string; sender?: string; token: string; }

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

Parameters for WithdrawFromLockbox.

Remarks

There is no remoteChainSelector: ERC20LockBox v2.0.0 ignores it, so the op always encodes IGNORED_CHAIN_SELECTOR (zero).

Properties

amount

amount: bigint

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

Amount to withdraw (uint256), in the token's smallest unit. MaxUint256 withdraws the lockbox's entire balance of token.

---

lockbox

lockbox: string

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

ERC20LockBox to withdraw from. Must be non-zero — it is the tx to, and a call to 0x0 hits no code, so it would mine as a successful no-op.

---

recipient

recipient: string

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

Account the tokens are sent to. Must be non-zero — the lockbox rejects the zero address.

---

sender?

optional sender?: string

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

The withdrawing account, which must be an authorized caller of the lockbox. Sets tx.from for offline / multisig signing, and when supplied is checked against the lockbox before any calldata is built. Optional for WithdrawFromLockbox.generate; WithdrawFromLockbox.execute defaults it to the signing wallet, so the check always runs on a broadcast tx.

---

token

token: string

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

Token to withdraw; must be the one the lockbox escrows, or it reverts UnsupportedToken.