{s}omniamarkets

@somnia-chain/markets-sdk


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

Interface: PlacePerpOrderParams

Defined in: trade.ts:328

Inputs to Trader.placePerpOrder — a perp limit or market order on a PerpPool. Margin is locked from the signer's MarginBank balance (no escrow transfer in this tx) — Trader.depositMargin first.

Properties

pool

pool: `0x${string}`

Defined in: trade.ts:330

PerpPool address.


isBid

isBid: boolean

Defined in: trade.ts:332

True = buy/long the synthetic base; false = sell/short.


price

price: bigint

Defined in: trade.ts:337

Limit price — raw quote (collateral) units per whole base. For a MARKET order pass a crossing price; it bounds the margin lock.


quantity

quantity: bigint

Defined in: trade.ts:339

Base quantity, raw base units.


expireTimestampNs?

optional expireTimestampNs?: bigint

Defined in: trade.ts:341

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


orderType?

optional orderType?: number

Defined in: trade.ts:343

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


gas?

optional gas?: bigint

Defined in: trade.ts:345

Gas ceiling for this tx.

Default Value

TraderConfig.gas (10,000,000)