Interface: WithdrawMarginParams

Defined in: packages/sdk/src/trade.ts:546

Inputs to Trader.withdrawMargin — pull free collateral back out of the MarginBank (the bank margin-checks the withdrawal on-chain).

Properties

optional marginBank?: `0x${string}`

Defined in: packages/sdk/src/trade.ts:548

MarginBank address (from the PerpMarket row), or pass pool to resolve it.

optional pool?: `0x${string}`

Defined in: packages/sdk/src/trade.ts:550

A PerpPool — its marginBank() is read (and cached) when marginBank is omitted.

amount: bigint

Defined in: packages/sdk/src/trade.ts:552

Collateral amount to withdraw, raw units. Must be ≤ withdrawable (margin-checked on-chain).

optional gas?: bigint

Defined in: packages/sdk/src/trade.ts:554

Gas ceiling for this tx.