@somnia-chain/markets-sdk

---

@somnia-chain/markets-sdk / index / WithdrawMarginParams

Interface: WithdrawMarginParams

Defined in: trade.ts:371

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

Properties

marginBank?

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

Defined in: trade.ts:373

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

---

pool?

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

Defined in: trade.ts:375

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

---

amount

amount: bigint

Defined in: trade.ts:377

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

---

gas?

optional gas?: bigint

Defined in: trade.ts:379

Gas ceiling for this tx.

Default Value

TraderConfig.gas (10,000,000)