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

Interface: UnifiedStopOrder

Defined in: packages/sdk/src/unified/structs.ts:263

A stop / take-profit order resting OFF the book on the market's SpotStopOrderRegistry, human units. Fires as a market or limit order when the pool's mark price crosses triggerPrice.

Properties

id

id: string

Defined in: packages/sdk/src/unified/structs.ts:265

Registry order id (decimal string) — pass to SomniaMarkets.cancelStopOrder.

symbol

symbol: string

Defined in: packages/sdk/src/unified/structs.ts:267

The spot tradable the stop targets.

type

type: "limit" | "market"

Defined in: packages/sdk/src/unified/structs.ts:269

Execution style at trigger time.

side

side: "buy" | "sell"

Defined in: packages/sdk/src/unified/structs.ts:271

Direction of the triggered order.

amount

amount: number

Defined in: packages/sdk/src/unified/structs.ts:273

Order size, human base units.

triggerPrice

triggerPrice: number

Defined in: packages/sdk/src/unified/structs.ts:275

Mark price that arms the trigger, human quote units.

triggerDirection

triggerDirection: "above" | "below"

Defined in: packages/sdk/src/unified/structs.ts:277

Which side of the mark the trigger arms on.

price?

optional price?: number

Defined in: packages/sdk/src/unified/structs.ts:279

Limit price of the triggered order (limit stops only), human quote units.

status

status: UnifiedStopOrderStatus

Defined in: packages/sdk/src/unified/structs.ts:281

Lifecycle state — see UnifiedStopOrderStatus.

triggeredOrderId?

optional triggeredOrderId?: string

Defined in: packages/sdk/src/unified/structs.ts:283

The spot order id the trigger produced, once it fired.

timestamp?

optional timestamp?: number

Defined in: packages/sdk/src/unified/structs.ts:285

Creation time (ms).

datetime?

optional datetime?: string

Defined in: packages/sdk/src/unified/structs.ts:287

ISO-8601 of timestamp.

txHash?

optional txHash?: string

Defined in: packages/sdk/src/unified/structs.ts:289

Tx hash of the create, when known (write results only).

info

info: unknown

Defined in: packages/sdk/src/unified/structs.ts:291

The native registry row / write result.