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

Interface: SpotOrderRequest

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

One order inside a Trader.placeSpotOrders batch — the per-order fields of PlaceSpotOrderParams, minus everything the batch supplies once (pool, token context, gas).

Properties

isBid

isBid: boolean

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

True = buy the base asset (pay quote); false = sell base (pay base/native).

price

price: bigint

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

Limit price — raw quote units per whole base token. For a MARKET order pass a crossing price (best opposite level ± slippage); it bounds the escrow.

quantity

quantity: bigint

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

Base quantity, raw base units.

orderType?

optional orderType?: number

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

0 limit (default) or 2 market (IOC). See ORDER_TYPE.

selfMatchingOption?

optional selfMatchingOption?: number

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

Self-match behaviour when this order crosses your OWN resting order, default 0 (CANCEL_TAKER). Set per rung: a ladder that crosses its own quotes can keep the incoming order and drop the resting one instead. See SELF_MATCHING_OPTION.

expireTimestampNs?

optional expireTimestampNs?: bigint

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

Order expiry in ns. Defaults to ~50y (GTC).

userData?

optional userData?: bigint

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

Opaque 64-bit tag carried on the order — for market-maker bookkeeping.

builder?

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

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

Routing/builder frontend address to attribute this rung to. Requires the trader to have opted this builder in via Trader.approveBuilder on the batch's pool. Omit (or zero) for no routing fee.

builderFeeBpsTimes1k?

optional builderFeeBpsTimes1k?: bigint

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

Per-order builder/routing fee in the pool's native bps×1000 unit (≤ the pool's maxBuilderFee ceiling AND ≤ the trader's approval). 0 = none.