@lifi/perps-types 17.0.0 → 18.1.0

package/src/market.ts

@@ -1,4 +1,5 @@
 import type { Asset } from './asset.js'
+import type { DecimalString } from './decimal.js'
 import type { PositionMarginAdjustment } from './enums.js'
 
 /**
@@ -9,7 +10,7 @@ import type { PositionMarginAdjustment } from './enums.js'
  */
 export interface FundingInfo {
   /** Funding rate as a decimal fraction. */
-  rate: string
+  rate: DecimalString
   /** Next funding timestamp in Unix milliseconds. */
   nextFundingTime: number
 }
@@ -43,14 +44,14 @@ export interface BaseMarket {
    * describe the tick. Format prices through the provider's `formatOrderPrice`
    * rather than applying this field directly.
    */
-  priceIncrement?: string
+  priceIncrement?: DecimalString
   /**
    * Exact size lot as a plain decimal string (e.g. `'0.05'`). Present when the
    * venue's grid is not a power of ten, where `szDecimals` alone cannot
    * describe the lot. Format sizes through the provider's `formatOrderSize`
    * rather than applying this field directly.
    */
-  sizeIncrement?: string
+  sizeIncrement?: DecimalString
 }
 
 /**
@@ -60,17 +61,22 @@ export interface BaseMarket {
  */
 export interface PerpsMarket extends BaseMarket {
   maxLeverage: number
+  /**
+   * The display leverage the venue applies to a market with no stored user
+   * setting. Absent when the venue publishes no default.
+   */
+  defaultLeverage?: number
   /**
    * Minimum order notional in USD for this market, as a plain decimal string.
    * Lighter applies it to resting (post-only) orders only. Separate from the
    * venue-wide `Provider.minOrderValueUsd`, which is a `number`; parse this
    * string before comparing the two.
    */
-  minOrderValueUsd?: string
+  minOrderValueUsd?: DecimalString
   /** Maximum market-order notional in USD, as a plain decimal string. */
-  maxMarketOrderUsd?: string
+  maxMarketOrderUsd?: DecimalString
   /** Maximum limit-order notional in USD, as a plain decimal string. */
-  maxLimitOrderUsd?: string
+  maxLimitOrderUsd?: DecimalString
   onlyIsolated: boolean
   /** Whether individual position margin can be added and/or removed. */
   positionMarginAdjustment: PositionMarginAdjustment
@@ -145,16 +151,16 @@ export interface MarketContext {
   /** Opaque provider market identifier for this context frame. */
   marketId: string
   /** Current order-book midpoint, as a decimal quote string. */
-  midPrice: string
+  midPrice: DecimalString
   /** Provider mark price, as a decimal quote string. */
-  markPrice: string
-  oraclePrice?: string
-  prevDayPrice?: string
-  priceChange24h?: string
-  volume24h?: string
-  marketCap?: string
+  markPrice: DecimalString
+  oraclePrice?: DecimalString
+  prevDayPrice?: DecimalString
+  priceChange24h?: DecimalString
+  volume24h?: DecimalString
+  marketCap?: DecimalString
   /** Quote-asset open-interest notional as a decimal string. */
-  openInterest?: string
+  openInterest?: DecimalString
   funding?: FundingInfo
 }
 
@@ -171,11 +177,11 @@ export interface PricesResponse {
  */
 export interface Candle {
   t: number
-  o: string
-  h: string
-  l: string
-  c: string
-  v: string
+  o: DecimalString
+  h: DecimalString
+  l: DecimalString
+  c: DecimalString
+  v: DecimalString
 }
 
 /** Response containing candles for one provider market and interval. @public */
@@ -210,8 +216,8 @@ export type OhlcvInterval =
 
 /** One price/size level in an order book; both values are decimal strings. @public */
 export interface OrderbookLevel {
-  price: string
-  size: string
+  price: DecimalString
+  size: DecimalString
 }
 
 /** Snapshot of bids and asks for one market. `timestamp` is Unix milliseconds. @public */
@@ -227,8 +233,8 @@ export interface OrderbookResponse {
 export interface Trade {
   provider: string
   marketId: string
-  price: string
-  size: string
+  price: DecimalString
+  size: DecimalString
   timestamp: number
   side: 'buy' | 'sell'
   id?: string

package/src/portfolioHistory.ts

@@ -1,3 +1,5 @@
+import type { DecimalString } from './decimal.js'
+
 /** Lookback window of a portfolio history read. @public */
 export type PortfolioHistoryRange = '24h' | '7d' | '30d' | 'all'
 
@@ -9,9 +11,9 @@ export type PortfolioHistoryRange = '24h' | '7d' | '30d' | 'all'
 export interface PortfolioHistoryPoint {
   /** Unix milliseconds. */
   timestamp: number
-  accountValue: string
+  accountValue: DecimalString
   /** Cumulative PnL from the start of the requested window. */
-  pnl: string
+  pnl: DecimalString
 }
 
 /**
@@ -22,6 +24,6 @@ export interface PortfolioHistoryPoint {
 export interface PortfolioHistoryResponse {
   range: PortfolioHistoryRange
   points: PortfolioHistoryPoint[]
-  volume?: string
-  totalPnl?: string
+  volume?: DecimalString
+  totalPnl?: DecimalString
 }

package/src/quote.ts

@@ -1,4 +1,5 @@
 import type { FeeTier } from './account.js'
+import type { DecimalString } from './decimal.js'
 import type { FundingInfo } from './market.js'
 
 /** Side of the quoted market order, using lowercase wire values. @public */
@@ -26,20 +27,20 @@ export interface Quote {
   type: TradeType
   side: QuoteSide
   /** Input notional in USD. */
-  sizeUsd: string
+  sizeUsd: DecimalString
   /** Base amount the book filled for `sizeUsd` (or the most obtainable when the book is too thin). */
-  baseSize: string
-  markPrice: string
+  baseSize: DecimalString
+  markPrice: DecimalString
   /** Volume-weighted average fill price from the book walk. */
-  expectedFillPrice: string
+  expectedFillPrice: DecimalString
   /** VWAP deviation from `markPrice` in basis points; non-negative. */
-  priceImpactBps: string
+  priceImpactBps: DecimalString
   /** Base maker/taker fee fractions (not bps) for the public tier. */
   feeTier: FeeTier
   /** Always `true` in v1 — quotes use the public base tier, never a per-account tier. */
   isDefaultFeeTier: boolean
   /** Taker fee on the filled notional in USD: `filledNotional * feeTier.taker`. */
-  feeUsd: string
+  feeUsd: DecimalString
   /** Current funding for perps; `null` for spot. */
   funding: FundingInfo | null
   /** `true` when the book could not fill the full `sizeUsd` — `baseSize`/fill reflect the best obtainable. */

package/src/referral.ts

@@ -1,4 +1,5 @@
 import type { Pagination } from './account.js'
+import type { DecimalString } from './decimal.js'
 import type { Address } from './primitives.js'
 import type { PerpsTypedData, TypedDataParameter } from './typedData.js'
 
@@ -71,9 +72,9 @@ export interface OwnedReferralCodeEligibility {
    * Executed notional the address must reach, as a decimal string in the
    * backend's reporting currency. Absent when the backend does not disclose it.
    */
-  requiredNotional?: string
+  requiredNotional?: DecimalString
   /** The address's executed notional so far, in the same units as `requiredNotional`. */
-  currentNotional?: string
+  currentNotional?: DecimalString
 }
 
 /**
@@ -125,7 +126,7 @@ export interface ReferralActivityItem {
    * Executed notional recorded against this attachment, as a decimal string in
    * the backend's reporting currency.
    */
-  notional: string
+  notional: DecimalString
 }
 
 /**
@@ -217,8 +218,7 @@ export interface OnboardTypedData extends PerpsTypedData {
  * @public
  */
 export interface CreateReferralCodeParams {
-  /** Desired code; omit to let the backend generate one. */
-  code?: string
+  code: string
 }
 
 /**

package/src/subscriptions.ts

@@ -6,6 +6,7 @@ import type {
   Order,
   Position,
 } from './account.js'
+import type { DecimalString } from './decimal.js'
 import type {
   Candle,
   MarketContext,
@@ -152,7 +153,7 @@ export type PositionsEvent = { channel: 'positions'; data: Position[] }
  */
 export type SpotBalancesEvent = {
   channel: 'spotBalances'
-  data: (Balance & { locked: string })[]
+  data: (Balance & { locked: DecimalString })[]
 }
 
 /**