@lifi/perps-sdk 14.0.0 → 16.0.0

package/src/client/PerpsClient.ts

@@ -4,6 +4,7 @@ import type {
   ActionParamsMap,
   ActionResult,
   ActionStep,
+  AvailableToTrade,
   CreateActionResponse,
   ExecuteActionResponse,
   MarketRef,
@@ -28,7 +29,8 @@ import {
 import Big from 'big.js'
 import type { Address } from 'viem'
 import { PerpsError } from '../errors/PerpsError.js'
-import { getAssetRegistry } from '../registry/assetRegistry.js'
+import { getAssetRegistry, toAssetDisplay } from '../registry/assetRegistry.js'
+import { getMarketRegistry } from '../registry/marketRegistry.js'
 import { createAction } from '../services/createAction.js'
 import { executeAction } from '../services/executeAction.js'
 import { getAccount as fetchAccount } from '../services/getAccount.js'
@@ -109,6 +111,32 @@ function findActionDescriptor(
   return descriptor
 }
 
+/**
+ * Split an ordered `createAction` batch into consecutive runs of steps that
+ * share one descriptor. A batch is a chain and may mix descriptors — a
+ * Hyperliquid `placeOrder` can arrive with a USER-signed builder-fee approval
+ * ahead of the SDK-signed order — and each run must be signed by its own
+ * descriptor's signer.
+ *
+ * @throws {PerpsError} When a step's action is not declared by the provider.
+ */
+function groupStepsByDescriptor(
+  metadata: Provider,
+  steps: ActionStep[]
+): { descriptor: ProviderAction; steps: ActionStep[] }[] {
+  const groups: { descriptor: ProviderAction; steps: ActionStep[] }[] = []
+  for (const step of steps) {
+    const descriptor = findActionDescriptor(metadata, step.action)
+    const current = groups.at(-1)
+    if (current !== undefined && current.descriptor.type === descriptor.type) {
+      current.steps.push(step)
+      continue
+    }
+    groups.push({ descriptor, steps: [step] })
+  }
+  return groups
+}
+
 /**
  * The primary high-level perps API: wraps a {@link PerpsSDKClient} and owns the
  * end-to-end signing pipeline for provider setup, orders, and account-level
@@ -241,15 +269,21 @@ export class PerpsClient {
   }
 
   /**
-   * Delegate signing of `actions` to the provider plugin. The plugin owns
-   * every signing arm and branches on the descriptor's `signers` internally,
-   * reading the end-user's wallet from the {@link SignActionsContext} when an
-   * arm signs as the user.
+   * Delegate signing of `actions` to the provider plugin, one call per
+   * consecutive run of steps sharing a descriptor. Each call carries that
+   * descriptor's `signingMethod` and `signers`, so a mixed batch signs every
+   * step with the signer its own descriptor declares; the signed steps come
+   * back in the batch's original order. The plugin owns every signing arm and
+   * branches on `signers` internally, reading the end-user's wallet from the
+   * {@link SignActionsContext} when an arm signs as the user.
+   *
+   * @throws {PerpsError} When a step's action is not declared by the provider,
+   *   or the plugin implements no `signActions`.
    */
   private async delegateSignActions(
     provider: string,
     address: Address,
-    descriptor: ProviderAction,
+    metadata: Provider,
     actions: ActionStep[],
     onProgress?: (progress: SignActionProgress) => void
   ): Promise<SignedActionStep[]> {
@@ -257,17 +291,25 @@ export class PerpsClient {
     if (typeof plugin.signActions !== 'function') {
       throw new PerpsError(
         PerpsErrorCode.SDKError,
-        `Provider '${provider}' does not implement signActions for ` +
-          `signingMethod '${descriptor.signingMethod}'.`
+        `Provider '${provider}' does not implement signActions.`
       )
     }
-    const userWallet = await this.resolveSigningWallet(descriptor, actions)
-    return plugin.signActions(
-      descriptor.signingMethod,
-      actions,
-      address,
-      this.buildSignActionsContext(descriptor, userWallet, onProgress)
-    )
+    const signed: SignedActionStep[] = []
+    for (const group of groupStepsByDescriptor(metadata, actions)) {
+      const userWallet = await this.resolveSigningWallet(
+        group.descriptor,
+        group.steps
+      )
+      signed.push(
+        ...(await plugin.signActions(
+          group.descriptor.signingMethod,
+          group.steps,
+          address,
+          this.buildSignActionsContext(group.descriptor, userWallet, onProgress)
+        ))
+      )
+    }
+    return signed
   }
 
   /**
@@ -409,11 +451,10 @@ export class PerpsClient {
     step: ActionStep
   ): Promise<SignedActionStep | undefined> {
     const metadata = await this.getProviderMetadata(provider)
-    const descriptor = findActionDescriptor(metadata, step.action)
     const [signed] = await this.delegateSignActions(
       provider,
       address,
-      descriptor,
+      metadata,
       [step]
     )
     return signed
@@ -498,6 +539,58 @@ export class PerpsClient {
     })
   }
 
+  /**
+   * The amounts `params.address` can still buy and sell on one market, in
+   * that market's margin asset. The order panel reads this per-market figure;
+   * account displays read the account-scoped
+   * {@link AccountSummary.availableMargin} instead.
+   *
+   * Providers that read a per-market figure answer it directly. For every
+   * other provider this falls back to the account summary, so both sides
+   * equal `availableMargin` and the asset is the market's quote asset.
+   *
+   * @throws {PerpsError} When the provider plugin is not registered, or the
+   *   market is unknown to the provider's market registry.
+   * @public
+   */
+  async getAvailableToTrade(
+    params: {
+      provider: string
+      address: Address
+      marketId: string
+    },
+    options?: SDKRequestOptions
+  ): Promise<AvailableToTrade> {
+    const plugin = this.requireProvider(params.provider)
+    const perMarket = await plugin.getAvailableToTrade?.(
+      { address: params.address, marketId: params.marketId },
+      options
+    )
+    if (perMarket !== undefined) {
+      return perMarket
+    }
+
+    const registry = getMarketRegistry(this.sdkClient, params.provider)
+    await registry.sync()
+    const market = registry.require(params.marketId)
+    const account = await fetchAccount(
+      this.sdkClient,
+      { provider: params.provider, address: params.address },
+      options
+    )
+    const { availableMargin } = plugin.getAccountSummary(
+      account,
+      account.positions
+    )
+    return {
+      providerId: market.providerId,
+      marketId: market.id,
+      asset: toAssetDisplay(market.quoteAsset),
+      buy: availableMargin,
+      sell: availableMargin,
+    }
+  }
+
   /**
    * Resolve the exact venue-owned margin requirements for `position`.
    * Returns `undefined` when the position has no individual margin adjustment.
@@ -1218,7 +1311,7 @@ export class PerpsClient {
     const signedActions = await this.delegateSignActions(
       provider,
       address,
-      descriptor,
+      metadata,
       actions,
       onProgress
     )

package/src/index.ts

@@ -19,7 +19,11 @@ export { PerpsClient } from './client/PerpsClient.js'
 export { PerpsErrorMessage } from './errors/constants.js'
 export { PerpsError } from './errors/PerpsError.js'
 // Registries
-export { AssetRegistry, getAssetRegistry } from './registry/assetRegistry.js'
+export {
+  AssetRegistry,
+  getAssetRegistry,
+  toAssetDisplay,
+} from './registry/assetRegistry.js'
 export type { DefaultMarketProvider } from './registry/marketRegistry.js'
 export {
   DEFAULT_MARKET_ID,
@@ -152,6 +156,7 @@ export type {
   ProviderAccountExistsParams,
   ProviderGetAccountParams,
   ProviderGetActivityParams,
+  ProviderGetAvailableToTradeParams,
   ProviderGetDepositFlowParams,
   ProviderGetFillsParams,
   ProviderGetMarketSettingsParams,
@@ -170,10 +175,6 @@ export type {
   WithdrawableBalance,
   WithdrawalRoute,
 } from './types/withdrawal.js'
-export {
-  type CollateralSemantics,
-  summarizeAccount,
-} from './utils/accountSummary.js'
 export { paginateActivity } from './utils/activityPaging.js'
 export type { ExpectedPnl } from './utils/calculations.js'
 export {
@@ -259,6 +260,8 @@ export { createWarnOnce } from './utils/warnOnce.js'
 // Version
 export { name, version } from './version.js'
 export { cachePromise } from './websocket/cachePromise.js'
+export type { DecodeChainMode } from './websocket/decodeChain.js'
+export { DecodeChain } from './websocket/decodeChain.js'
 export type {
   PerpsWsClientOptions,
   WsProviderFactory,

package/src/registry/assetRegistry.ts

@@ -1,4 +1,4 @@
-import type { Asset, AssetsResponse } from '@lifi/perps-types'
+import type { Asset, AssetDisplay, AssetsResponse } from '@lifi/perps-types'
 import { PerpsErrorCode } from '@lifi/perps-types'
 import { PerpsError } from '../errors/PerpsError.js'
 import { buildUrl, request } from '../transport/request.js'
@@ -59,6 +59,21 @@ export class AssetRegistry extends ReferenceDataRegistry<Asset> {
   }
 }
 
+/**
+ * Project an {@link Asset} to the identity and labels a display needs.
+ *
+ * @public
+ */
+export const toAssetDisplay = (asset: Asset): AssetDisplay => ({
+  providerId: asset.providerId,
+  id: asset.id,
+  displaySymbol: asset.displaySymbol,
+  logoURI: asset.logoURI,
+  ...(asset.displayName === undefined
+    ? {}
+    : { displayName: asset.displayName }),
+})
+
 const registries = new WeakMap<PerpsSDKClient, Map<string, AssetRegistry>>()
 
 /**

package/src/types/provider.ts

@@ -8,6 +8,7 @@ import type {
   ActionType,
   ActivitiesResponse,
   ActivityType,
+  AvailableToTrade,
   FillsResponse,
   Market,
   MarketRef,
@@ -216,6 +217,17 @@ export interface ProviderGetMarketSettingsParams {
   market: MarketRef
 }
 
+/**
+ * Read params for {@link PerpsProviderPlugin.getAvailableToTrade}.
+ *
+ * @public
+ */
+export interface ProviderGetAvailableToTradeParams {
+  address: Address
+  /** The market's opaque `Market.id` (not a display symbol). */
+  marketId: string
+}
+
 /**
  * Read params for {@link PerpsProvider.getOrders}.
  *
@@ -442,6 +454,19 @@ export interface PerpsProviderPlugin {
     options?: SDKRequestOptions
   ): Promise<MarketSettings | undefined>
 
+  /**
+   * The amounts the account can still buy and sell on one market, in that
+   * market's margin asset. Optional because venues expose this unevenly:
+   * Hyperliquid reads it directly (`activeAssetData`), other venues publish
+   * only an account-scoped figure. `undefined` means the venue has nothing
+   * to read for this market, and the caller falls back to the account
+   * summary.
+   */
+  getAvailableToTrade?(
+    params: ProviderGetAvailableToTradeParams,
+    options?: SDKRequestOptions
+  ): Promise<AvailableToTrade | undefined>
+
   getOrders(
     params: ProviderGetOrdersParams,
     options?: SDKRequestOptions

package/src/utils/explorer.ts

@@ -15,7 +15,10 @@ export const ExplorerChainId = {
   ETHEREUM: 1,
   ARBITRUM_ONE: 42161,
   LIGHTER: 304,
+  ROBINHOOD: 4663,
   HYPERLIQUID: 999,
+  AVALANCHE_C_CHAIN: 43114,
+  BNB_SMART_CHAIN: 56,
 } as const
 
 /**
@@ -30,7 +33,10 @@ const TX_BASE_URL_BY_CHAIN: Record<ExplorerChainId, string> = {
   [ExplorerChainId.ETHEREUM]: 'https://etherscan.io/tx/',
   [ExplorerChainId.ARBITRUM_ONE]: 'https://arbiscan.io/tx/',
   [ExplorerChainId.LIGHTER]: 'https://app.lighter.xyz/explorer/logs/',
+  [ExplorerChainId.ROBINHOOD]: 'https://robin.etherscan.io/tx/',
   [ExplorerChainId.HYPERLIQUID]: 'https://app.hyperliquid.xyz/explorer/tx/',
+  [ExplorerChainId.AVALANCHE_C_CHAIN]: 'https://snowtrace.io/tx/',
+  [ExplorerChainId.BNB_SMART_CHAIN]: 'https://bscscan.com/tx/',
 }
 
 /**

package/src/utils/orderClassification.ts

@@ -84,6 +84,7 @@ export function triggerConditionFor(
 export const ACTIVE_ORDER_STATUSES: ReadonlySet<OrderStatus> = new Set([
   OrderStatus.OPEN,
   OrderStatus.PENDING,
+  OrderStatus.ACCEPTED,
   OrderStatus.PARTIALLY_FILLED,
   OrderStatus.TRIGGERED,
 ])

package/src/version.ts

@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
  *
  * @public
  */
-export const version = '14.0.0'
+export const version = '16.0.0'

package/src/websocket/decodeChain.ts

@@ -0,0 +1,54 @@
+/**
+ * Frame semantics of a {@link DecodeChain}:
+ * - `'every'`: every frame decodes and applies in arrival order — required for
+ *   delta-carrying channels, where dropping a frame corrupts downstream state.
+ * - `'latest'`: frames queued behind an in-flight decode coalesce to the
+ *   newest — for snapshot-like channels, where a newer frame supersedes
+ *   anything still waiting.
+ */
+export type DecodeChainMode = 'every' | 'latest'
+
+/**
+ * Serializes async WS frame decodes so results apply in arrival order.
+ * In `'latest'` mode a backlog (e.g. queued behind a main-thread stall)
+ * collapses to its newest frame instead of replaying every stale decode.
+ * Decode failures are reported to `onError` and never break the chain.
+ */
+export class DecodeChain {
+  private tail: Promise<void> = Promise.resolve()
+  private queued: (() => Promise<void>) | undefined
+
+  constructor(
+    private readonly mode: DecodeChainMode,
+    private readonly onError: (error: unknown) => void
+  ) {}
+
+  push(decode: () => Promise<void>): void {
+    if (this.mode === 'every') {
+      this.tail = this.tail.then(decode).catch(this.onError)
+      return
+    }
+    const drainScheduled = this.queued !== undefined
+    this.queued = decode
+    if (drainScheduled) {
+      return
+    }
+    this.tail = this.tail
+      .then(() => {
+        const next = this.queued
+        this.queued = undefined
+        return next?.()
+      })
+      .catch(this.onError)
+  }
+
+  /**
+   * Detach on connection teardown: drops the queued latest-mode decode and
+   * starts subsequent pushes on a fresh chain. A decode already in flight
+   * still settles.
+   */
+  reset(): void {
+    this.tail = Promise.resolve()
+    this.queued = undefined
+  }
+}

package/dist/cjs/utils/accountSummary.d.ts

@@ -1,4 +0,0 @@
-import type { AccountResponse, AccountSummary, Position } from '@lifi/perps-types';
-export type CollateralSemantics = 'free' | 'net' | 'gross' | 'equity';
-export declare function summarizeAccount(account: AccountResponse, positions: Position[], semantics: CollateralSemantics): AccountSummary;
-//# sourceMappingURL=accountSummary.d.ts.map

package/dist/cjs/utils/accountSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"accountSummary.d.ts","sourceRoot":"","sources":["../../../src/utils/accountSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAgC1B,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAUrE,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,EAAE,mBAAmB,GAC7B,cAAc,CAuChB"}

package/dist/cjs/utils/accountSummary.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.summarizeAccount = summarizeAccount;
-const parse_js_1 = require("./parse.js");
-const sumValueUsd = (balances) => balances.reduce((sum, b) => sum + (0, parse_js_1.stringToFloat)(b.valueUsd), 0);
-const sumMarginUsd = (balances) => balances.reduce((sum, b) => sum + (0, parse_js_1.stringToFloat)(b.valueUsd) * (b.collateralWeight ?? 1), 0);
-function summarizeAccount(account, positions, semantics) {
-    let marginUsed = 0;
-    let unrealizedPnl = 0;
-    for (const p of positions) {
-        marginUsed += (0, parse_js_1.stringToFloat)(p.marginUsed);
-        unrealizedPnl += (0, parse_js_1.stringToFloat)(p.unrealizedPnl);
-    }
-    const collateral = sumValueUsd(account.collateralBalances);
-    const marginCollateral = sumMarginUsd(account.collateralBalances);
-    const balances = sumValueUsd(account.balances);
-    const withLocked = semantics === 'free' || semantics === 'net';
-    const grossCollateral = withLocked ? collateral + marginUsed : collateral;
-    const grossMarginCollateral = withLocked
-        ? marginCollateral + marginUsed
-        : marginCollateral;
-    const equity = semantics === 'equity' || semantics === 'net'
-        ? grossCollateral
-        : grossCollateral + unrealizedPnl;
-    const availableMargin = grossMarginCollateral +
-        (semantics === 'gross' ? unrealizedPnl : 0) -
-        marginUsed;
-    return {
-        portfolioValue: (balances + equity).toString(),
-        availableMargin: availableMargin.toString(),
-        marginUsed: marginUsed.toString(),
-        unrealizedPnl: unrealizedPnl.toString(),
-    };
-}
-//# sourceMappingURL=accountSummary.js.map

package/dist/cjs/utils/accountSummary.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"accountSummary.js","sourceRoot":"","sources":["../../../src/utils/accountSummary.ts"],"names":[],"mappings":";;AA8CA,4CA2CC;AApFD,yCAA0C;AAE1C,MAAM,WAAW,GAAG,CAAC,QAAqC,EAAU,EAAE,CACpE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAA,wBAAa,EAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;AAEjE,MAAM,YAAY,GAAG,CAAC,QAAqC,EAAU,EAAE,CACrE,QAAQ,CAAC,MAAM,CACb,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAA,wBAAa,EAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,EACvE,CAAC,CACF,CAAA;AAgCH,SAAgB,gBAAgB,CAC9B,OAAwB,EACxB,SAAqB,EACrB,SAA8B;IAE9B,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,aAAa,GAAG,CAAC,CAAA;IACrB,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,UAAU,IAAI,IAAA,wBAAa,EAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QACzC,aAAa,IAAI,IAAA,wBAAa,EAAC,CAAC,CAAC,aAAa,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAI1D,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACjE,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE9C,MAAM,UAAU,GAAG,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAA;IAC9D,MAAM,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAA;IACzE,MAAM,qBAAqB,GAAG,UAAU;QACtC,CAAC,CAAC,gBAAgB,GAAG,UAAU;QAC/B,CAAC,CAAC,gBAAgB,CAAA;IACpB,MAAM,MAAM,GACV,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,KAAK;QAC3C,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,eAAe,GAAG,aAAa,CAAA;IAKrC,MAAM,eAAe,GACnB,qBAAqB;QACrB,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,UAAU,CAAA;IAEZ,OAAO;QACL,cAAc,EAAE,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE;QAC9C,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;QAC3C,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;QACjC,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;KACxC,CAAA;AACH,CAAC"}

package/dist/esm/utils/accountSummary.d.ts

@@ -1,32 +0,0 @@
-import type { AccountResponse, AccountSummary, Position } from '@lifi/perps-types';
-/**
- * What the summed `collateralBalances` rows already contain, relative to the
- * positions' locked margin and unrealized PnL:
- *
- * - `'free'` — free collateral only; locked margin and unrealized PnL are
- *   both carried by the positions. Available margin is the free collateral
- *   as-is; unrealized PnL is not counted toward it.
- * - `'net'` — free collateral with unrealized PnL already marked in; only
- *   the locked margin is carried by the positions (e.g. a venue-reported
- *   available balance).
- * - `'gross'` — locked margin included, unrealized PnL carried by the
- *   positions (e.g. spot holdings backing a unified account). The venue
- *   counts unrealized PnL toward buying power, so it is added to available
- *   margin on top of the gross collateral.
- * - `'equity'` — total equity: locked margin AND unrealized PnL included
- *   (e.g. a venue-reported account value). Unrealized PnL is thus already
- *   counted toward available margin.
- *
- * @public
- */
-export type CollateralSemantics = 'free' | 'net' | 'gross' | 'equity';
-/**
- * Roll an {@link AccountResponse} and its open positions up into an
- * {@link AccountSummary}.
- *
- * @param semantics - How the collateral rows relate to the positions'
- * locked margin and unrealized PnL; see {@link CollateralSemantics}.
- * @public
- */
-export declare function summarizeAccount(account: AccountResponse, positions: Position[], semantics: CollateralSemantics): AccountSummary;
-//# sourceMappingURL=accountSummary.d.ts.map

package/dist/esm/utils/accountSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"accountSummary.d.ts","sourceRoot":"","sources":["../../../src/utils/accountSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAY1B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAErE;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,EAAE,mBAAmB,GAC7B,cAAc,CAuChB"}

package/dist/esm/utils/accountSummary.js

@@ -1,46 +0,0 @@
-import { stringToFloat } from './parse.js';
-const sumValueUsd = (balances) => balances.reduce((sum, b) => sum + stringToFloat(b.valueUsd), 0);
-const sumMarginUsd = (balances) => balances.reduce((sum, b) => sum + stringToFloat(b.valueUsd) * (b.collateralWeight ?? 1), 0);
-/**
- * Roll an {@link AccountResponse} and its open positions up into an
- * {@link AccountSummary}.
- *
- * @param semantics - How the collateral rows relate to the positions'
- * locked margin and unrealized PnL; see {@link CollateralSemantics}.
- * @public
- */
-export function summarizeAccount(account, positions, semantics) {
-    let marginUsed = 0;
-    let unrealizedPnl = 0;
-    for (const p of positions) {
-        marginUsed += stringToFloat(p.marginUsed);
-        unrealizedPnl += stringToFloat(p.unrealizedPnl);
-    }
-    const collateral = sumValueUsd(account.collateralBalances);
-    // Margin-eligible collateral: each row's value scaled by its loan-to-value
-    // weight (1 when unset), so a haircut asset backs buying power at less than
-    // face while `portfolioValue` still reflects its full value.
-    const marginCollateral = sumMarginUsd(account.collateralBalances);
-    const balances = sumValueUsd(account.balances);
-    const withLocked = semantics === 'free' || semantics === 'net';
-    const grossCollateral = withLocked ? collateral + marginUsed : collateral;
-    const grossMarginCollateral = withLocked
-        ? marginCollateral + marginUsed
-        : marginCollateral;
-    const equity = semantics === 'equity' || semantics === 'net'
-        ? grossCollateral
-        : grossCollateral + unrealizedPnl;
-    // Buying power is equity net of locked margin, so unrealized PnL counts
-    // toward it. The `'free'` rows exclude uPnL from available margin, holding
-    // it purely as free collateral.
-    const availableMargin = grossMarginCollateral +
-        (semantics === 'gross' ? unrealizedPnl : 0) -
-        marginUsed;
-    return {
-        portfolioValue: (balances + equity).toString(),
-        availableMargin: availableMargin.toString(),
-        marginUsed: marginUsed.toString(),
-        unrealizedPnl: unrealizedPnl.toString(),
-    };
-}
-//# sourceMappingURL=accountSummary.js.map

package/dist/esm/utils/accountSummary.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"accountSummary.js","sourceRoot":"","sources":["../../../src/utils/accountSummary.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,WAAW,GAAG,CAAC,QAAqC,EAAU,EAAE,CACpE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;AAEjE,MAAM,YAAY,GAAG,CAAC,QAAqC,EAAU,EAAE,CACrE,QAAQ,CAAC,MAAM,CACb,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,EACvE,CAAC,CACF,CAAA;AAwBH;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAwB,EACxB,SAAqB,EACrB,SAA8B;IAE9B,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,aAAa,GAAG,CAAC,CAAA;IACrB,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,UAAU,IAAI,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QACzC,aAAa,IAAI,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC1D,2EAA2E;IAC3E,4EAA4E;IAC5E,6DAA6D;IAC7D,MAAM,gBAAgB,GAAG,YAAY,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACjE,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE9C,MAAM,UAAU,GAAG,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,KAAK,CAAA;IAC9D,MAAM,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAA;IACzE,MAAM,qBAAqB,GAAG,UAAU;QACtC,CAAC,CAAC,gBAAgB,GAAG,UAAU;QAC/B,CAAC,CAAC,gBAAgB,CAAA;IACpB,MAAM,MAAM,GACV,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,KAAK;QAC3C,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,eAAe,GAAG,aAAa,CAAA;IAErC,wEAAwE;IACxE,2EAA2E;IAC3E,gCAAgC;IAChC,MAAM,eAAe,GACnB,qBAAqB;QACrB,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,UAAU,CAAA;IAEZ,OAAO;QACL,cAAc,EAAE,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE;QAC9C,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;QAC3C,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;QACjC,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;KACxC,CAAA;AACH,CAAC"}

package/dist/types/utils/accountSummary.d.ts

@@ -1,32 +0,0 @@
-import type { AccountResponse, AccountSummary, Position } from '@lifi/perps-types';
-/**
- * What the summed `collateralBalances` rows already contain, relative to the
- * positions' locked margin and unrealized PnL:
- *
- * - `'free'` — free collateral only; locked margin and unrealized PnL are
- *   both carried by the positions. Available margin is the free collateral
- *   as-is; unrealized PnL is not counted toward it.
- * - `'net'` — free collateral with unrealized PnL already marked in; only
- *   the locked margin is carried by the positions (e.g. a venue-reported
- *   available balance).
- * - `'gross'` — locked margin included, unrealized PnL carried by the
- *   positions (e.g. spot holdings backing a unified account). The venue
- *   counts unrealized PnL toward buying power, so it is added to available
- *   margin on top of the gross collateral.
- * - `'equity'` — total equity: locked margin AND unrealized PnL included
- *   (e.g. a venue-reported account value). Unrealized PnL is thus already
- *   counted toward available margin.
- *
- * @public
- */
-export type CollateralSemantics = 'free' | 'net' | 'gross' | 'equity';
-/**
- * Roll an {@link AccountResponse} and its open positions up into an
- * {@link AccountSummary}.
- *
- * @param semantics - How the collateral rows relate to the positions'
- * locked margin and unrealized PnL; see {@link CollateralSemantics}.
- * @public
- */
-export declare function summarizeAccount(account: AccountResponse, positions: Position[], semantics: CollateralSemantics): AccountSummary;
-//# sourceMappingURL=accountSummary.d.ts.map

package/dist/types/utils/accountSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"accountSummary.d.ts","sourceRoot":"","sources":["../../../src/utils/accountSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAY1B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAErE;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,eAAe,EACxB,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,EAAE,mBAAmB,GAC7B,cAAc,CAuChB"}

package/src/utils/accountSummary.ts

@@ -1,90 +0,0 @@
-import type {
-  AccountResponse,
-  AccountSummary,
-  Position,
-} from '@lifi/perps-types'
-import { stringToFloat } from './parse.js'
-
-const sumValueUsd = (balances: AccountResponse['balances']): number =>
-  balances.reduce((sum, b) => sum + stringToFloat(b.valueUsd), 0)
-
-const sumMarginUsd = (balances: AccountResponse['balances']): number =>
-  balances.reduce(
-    (sum, b) => sum + stringToFloat(b.valueUsd) * (b.collateralWeight ?? 1),
-    0
-  )
-
-/**
- * What the summed `collateralBalances` rows already contain, relative to the
- * positions' locked margin and unrealized PnL:
- *
- * - `'free'` — free collateral only; locked margin and unrealized PnL are
- *   both carried by the positions. Available margin is the free collateral
- *   as-is; unrealized PnL is not counted toward it.
- * - `'net'` — free collateral with unrealized PnL already marked in; only
- *   the locked margin is carried by the positions (e.g. a venue-reported
- *   available balance).
- * - `'gross'` — locked margin included, unrealized PnL carried by the
- *   positions (e.g. spot holdings backing a unified account). The venue
- *   counts unrealized PnL toward buying power, so it is added to available
- *   margin on top of the gross collateral.
- * - `'equity'` — total equity: locked margin AND unrealized PnL included
- *   (e.g. a venue-reported account value). Unrealized PnL is thus already
- *   counted toward available margin.
- *
- * @public
- */
-export type CollateralSemantics = 'free' | 'net' | 'gross' | 'equity'
-
-/**
- * Roll an {@link AccountResponse} and its open positions up into an
- * {@link AccountSummary}.
- *
- * @param semantics - How the collateral rows relate to the positions'
- * locked margin and unrealized PnL; see {@link CollateralSemantics}.
- * @public
- */
-export function summarizeAccount(
-  account: AccountResponse,
-  positions: Position[],
-  semantics: CollateralSemantics
-): AccountSummary {
-  let marginUsed = 0
-  let unrealizedPnl = 0
-  for (const p of positions) {
-    marginUsed += stringToFloat(p.marginUsed)
-    unrealizedPnl += stringToFloat(p.unrealizedPnl)
-  }
-
-  const collateral = sumValueUsd(account.collateralBalances)
-  // Margin-eligible collateral: each row's value scaled by its loan-to-value
-  // weight (1 when unset), so a haircut asset backs buying power at less than
-  // face while `portfolioValue` still reflects its full value.
-  const marginCollateral = sumMarginUsd(account.collateralBalances)
-  const balances = sumValueUsd(account.balances)
-
-  const withLocked = semantics === 'free' || semantics === 'net'
-  const grossCollateral = withLocked ? collateral + marginUsed : collateral
-  const grossMarginCollateral = withLocked
-    ? marginCollateral + marginUsed
-    : marginCollateral
-  const equity =
-    semantics === 'equity' || semantics === 'net'
-      ? grossCollateral
-      : grossCollateral + unrealizedPnl
-
-  // Buying power is equity net of locked margin, so unrealized PnL counts
-  // toward it. The `'free'` rows exclude uPnL from available margin, holding
-  // it purely as free collateral.
-  const availableMargin =
-    grossMarginCollateral +
-    (semantics === 'gross' ? unrealizedPnl : 0) -
-    marginUsed
-
-  return {
-    portfolioValue: (balances + equity).toString(),
-    availableMargin: availableMargin.toString(),
-    marginUsed: marginUsed.toString(),
-    unrealizedPnl: unrealizedPnl.toString(),
-  }
-}