@lifi/perps-types 18.0.0 → 19.0.0

package/src/providers.ts

@@ -1,5 +1,6 @@
 import type { ActionParamsMap } from './action.js'
 import type { Asset } from './asset.js'
+import type { DecimalString } from './decimal.js'
 import type {
   ActionRelay,
   ActionType,
@@ -179,25 +180,37 @@ export interface Provider {
    * values. Absent when the provider has no settlement chain.
    */
   chainId?: number
-  /** Absent means no minimum advertised. */
-  minDepositUsd?: number
   /**
-   * Minimum order notional value in USD. Feeds the SDK's `validateMargin`
-   * `minMarginUsd` parameter. Absent means no minimum advertised.
+   * Minimum deposit in USD, as a plain decimal string. Absent means no
+   * minimum advertised.
    */
-  minOrderValueUsd?: number
+  minDepositUsd?: DecimalString
+  /**
+   * Minimum order notional value in USD, as a plain decimal string. Absent
+   * means no minimum advertised.
+   */
+  minOrderValueUsd?: DecimalString
   /**
    * Minimum order notional value in USD for reduce-only orders, when the
    * provider applies a lower floor than `minOrderValueUsd`. Absent means
    * reduce-only orders use the same floor as `minOrderValueUsd`.
    */
   minReduceOrderValueUsd?: number
-  /** Minimum withdrawal notional in USD. Absent means no minimum advertised. */
-  minWithdrawalUsd?: number
-  /** Flat deposit fee in USD the provider charges. Absent means no fee advertised. */
-  depositFeeUsd?: number
-  /** Flat withdrawal fee in USD the provider charges. Absent means no fee advertised. */
-  withdrawalFeeUsd?: number
+  /**
+   * Minimum withdrawal notional in USD, as a plain decimal string. Absent
+   * means no minimum advertised.
+   */
+  minWithdrawalUsd?: DecimalString
+  /**
+   * Flat deposit fee in USD the provider charges, as a plain decimal string.
+   * Absent means no fee advertised.
+   */
+  depositFeeUsd?: DecimalString
+  /**
+   * Flat withdrawal fee in USD the provider charges, as a plain decimal
+   * string. Absent means no fee advertised.
+   */
+  withdrawalFeeUsd?: DecimalString
   /**
    * Candle intervals this provider supports for OHLCV/chart requests, in
    * ascending order. Drives the client's chart interval selector. Empty for

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
 }
 
 /**

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,
@@ -148,11 +149,13 @@ export type PositionsEvent = { channel: 'positions'; data: Position[] }
 /**
  * Spot holdings as typed {@link Balance}s, each carrying the venue-locked
  * portion (`locked` = reserved against open orders; `available = units − locked`).
+ * `transferable` is required here, so a live frame always carries the figure
+ * a REST snapshot carries.
  * @public
  */
 export type SpotBalancesEvent = {
   channel: 'spotBalances'
-  data: (Balance & { locked: string })[]
+  data: (Balance & { locked: DecimalString; transferable: DecimalString })[]
 }
 
 /**