@somnia-chain/markets-sdk


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

Interface: GetAutoPullRequirementParams

Defined in: packages/sdk/src/spot/poolReads.ts:16

Identifies an order shape to price for funding — see SomniaMarketsClient.getAutoPullRequirement.

Properties

pool

pool: `0x${string}`

Defined in: packages/sdk/src/spot/poolReads.ts:18

SpotPool to ask.


owner

owner: `0x${string}`

Defined in: packages/sdk/src/spot/poolReads.ts:20

Account whose vault balance the shortfall is measured against.


isBid

isBid: boolean

Defined in: packages/sdk/src/spot/poolReads.ts:22

True = buy base (input is quote); false = sell base (input is base).


price

price: bigint

Defined in: packages/sdk/src/spot/poolReads.ts:24

Limit price, raw quote units per whole base.


quantity

quantity: bigint

Defined in: packages/sdk/src/spot/poolReads.ts:26

Base quantity, raw base units.


builderFeeBpsTimes1k?

optional builderFeeBpsTimes1k?: bigint

Defined in: packages/sdk/src/spot/poolReads.ts:31

Builder fee in bps × 1000 (the contract's own encoding — 2500 = 2.5 bps).

Default Value

ts
0n (no builder)