@somnia-chain/markets-sdk / index / SweepExpiredAtLevelParams
Interface: SweepExpiredAtLevelParams
Defined in: trade.ts:261
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: trade.ts:263
BinaryPool (or SpotPool) address to sweep.
isBid
isBid:
boolean
Defined in: trade.ts:265
True to sweep the bid side, false the ask side.
price
price:
bigint
Defined in: trade.ts:267
The exact price level to sweep (raw pool price units).
maxCount
maxCount:
bigint
Defined in: trade.ts:269
Max number of expired orders to clean in this call.
gas?
optionalgas?:bigint
Defined in: trade.ts:271
Gas ceiling for this tx.
Default Value
TraderConfig.gas (10,000,000)