Type Alias: WithdrawLiquidityParams

WithdrawLiquidityParams = { amount: bigint; poolAddress: string; sender?: string; }

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

Parameters for WithdrawLiquidity.

Properties

amount

amount: bigint

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

Amount of the pool's token to withdraw (uint256), in the token's smallest unit.

---

poolAddress

poolAddress: string

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

LockRelease pool 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.

---

sender?

optional sender?: string

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

The pool's rebalancer, which also receives the tokens. Sets tx.from for offline / multisig signing, and when supplied is checked against the pool's on-chain getRebalancer() before any calldata is built. Optional for WithdrawLiquidity.generate; WithdrawLiquidity.execute defaults it to the signing wallet.