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

Interface: SweepExpiredAtLevelParams

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

Permissionless keeper drain: walk ONE price level from the best order on a side, cleaning up to maxCount expired orders. The complement of CancelExpiredOrdersParams when you have a price level rather than a list of ids (e.g. draining a locked market's book so its pool can be released). Each cleaned order's escrow returns to its owner.

Properties

pool

pool: `0x${string}`

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

BinaryPool (or SpotPool) address to sweep.

isBid

isBid: boolean

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

True to sweep the bid side, false the ask side.

price

price: bigint

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

The exact price level to sweep (raw pool price units).

maxCount

maxCount: bigint

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

Max number of expired orders to clean in this call.

gas?

optional gas?: bigint

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

Gas ceiling for this tx.

Default Value

TraderConfig.gas (10,000,000)