@lifi/perps-sdk-provider-ondo 16.0.0 → 18.0.0

package/dist/types/websocket/OndoWsProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OndoWsProvider.d.ts","sourceRoot":"","sources":["../../../src/websocket/OndoWsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAGlB,KAAK,cAAc,EAGnB,cAAc,EACd,KAAK,iBAAiB,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAIV,YAAY,EACb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAgEnC,UAAU,QAAQ;IAChB,yEAAyE;IACzE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACnE,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6EAA6E;IAC7E,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IAEzD;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAET;IAEb,4EAA4E;IAC5E,OAAO,CAAC,QAAQ,CAAoC;IACpD,yDAAyD;IACzD,OAAO,CAAC,cAAc,CAGnB;IAEH,8DAA8D;IAC9D,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,YAAY,CAA2B;gBAG7C,KAAK,GAAE,MAA4B,EACnC,WAAW,SAAoB,EAC/B,OAAO,GAAE,qBAA0B,EACnC,MAAM,CAAC,EAAE,cAAc;IAqBnB,cAAc,CAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,MAAM,IAAI,CAAC;IAkBtB,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,MAAM;cAqB1B,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IA0DnE;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB,2EAA2E;YAC7D,WAAW;IAsBzB,4EAA4E;IAC5E,OAAO,CAAC,WAAW;cAkBH,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAU1C,OAAO,IAAI,IAAI;IAOlC,0EAA0E;IAC1E,OAAO,CAAC,cAAc;IAyGtB;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,UAAU;IAMlB;;;;;OAKG;YACW,kBAAkB;IAchC,8EAA8E;YAChE,4BAA4B;IAiB1C;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAkB1B,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IA+C1C,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,YAAY;IA0BpB,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,YAAY;IAgBpB,6EAA6E;IAC7E,OAAO,CAAC,aAAa,CAGpB;IAED,OAAO,CAAC,kBAAkB,CAKzB;IAED,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,eAAe;CA+BxB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,qBAAqB,KAC9B,iBAKA,CAAA"}
+{"version":3,"file":"OndoWsProvider.d.ts","sourceRoot":"","sources":["../../../src/websocket/OndoWsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAGlB,KAAK,cAAc,EAGnB,cAAc,EACd,KAAK,iBAAiB,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAKV,YAAY,EACb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAgEnC,UAAU,QAAQ;IAChB,yEAAyE;IACzE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACnE,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6EAA6E;IAC7E,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IAEzD;;;;OAIG;IACH,OAAO,CAAC,cAAc,CAAgC;IAEtD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAEnC;IAED,4EAA4E;IAC5E,OAAO,CAAC,QAAQ,CAAoC;IACpD,yDAAyD;IACzD,OAAO,CAAC,cAAc,CAGnB;IAEH,8DAA8D;IAC9D,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,YAAY,CAA2B;gBAG7C,KAAK,GAAE,MAA4B,EACnC,WAAW,SAAoB,EAC/B,OAAO,GAAE,qBAA0B,EACnC,MAAM,CAAC,EAAE,cAAc;IAqBnB,cAAc,CAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,MAAM,IAAI,CAAC;IAkBtB,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,MAAM;cAuB1B,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IA2DnE;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB,2EAA2E;YAC7D,WAAW;IAsBzB,4EAA4E;IAC5E,OAAO,CAAC,WAAW;cAkBH,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAU1C,OAAO,IAAI,IAAI;IAOlC,0EAA0E;IAC1E,OAAO,CAAC,cAAc;IA0GtB;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,UAAU;IAMlB;;;;;OAKG;YACW,kBAAkB;IAMhC,4EAA4E;YAC9D,qBAAqB;YAarB,WAAW;IAezB,uEAAuE;IACvE,OAAO,CAAC,kBAAkB;IAiB1B,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IA+C1C,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,YAAY;IA0BpB,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,YAAY;IAgBpB,6EAA6E;IAC7E,OAAO,CAAC,aAAa,CAGpB;IAED,OAAO,CAAC,kBAAkB,CAKzB;IAED,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,WAAW;IAoBnB,OAAO,CAAC,eAAe;CAyBxB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,qBAAqB,KAC9B,iBAKA,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-sdk-provider-ondo",
-  "version": "16.0.0",
+  "version": "18.0.0",
   "description": "Ondo Perps provider plugin for @lifi/perps-sdk",
   "homepage": "https://github.com/lifinance/perps-sdk",
   "bugs": {
@@ -44,10 +44,10 @@
   "dependencies": {
     "big.js": "^7.0.1",
     "viem": "^2.55.18",
-    "@lifi/perps-types": "^13.0.0"
+    "@lifi/perps-types": "^15.0.0"
   },
   "peerDependencies": {
-    "@lifi/perps-sdk": "^14.0.0"
+    "@lifi/perps-sdk": "^16.0.0"
   },
   "publishConfig": {
     "access": "public"

package/src/OndoProvider.ts

@@ -20,6 +20,8 @@ import {
   type ProviderGetPortfolioHistoryParams,
   type ProviderGetPositionsParams,
   type ProviderGetQuoteParams,
+  type ProviderGetWithdrawableBalancesParams,
+  type ProviderWithdrawableBalance,
   paginateActivity,
   resolveQuote,
   resolveRetryPolicy,
@@ -111,7 +113,9 @@ import {
   mapOpenPositions,
   mapOrder,
   mapWithdrawalActivity,
+  ondoWithdrawableBalances,
   positionMarginConstraints,
+  requireOndoCollateralAsset,
 } from './utils/index.js'
 import { mapPortfolioHistory } from './utils/mapPortfolioHistory.js'
 import {
@@ -323,19 +327,7 @@ export const ondoProvider = (
             marketRegistry().sync(),
           ])
 
-          const collateralAsset = providers
-            .find((provider) => provider.key === ONDO_PROVIDER_KEY)
-            ?.categories.find(
-              (category) => category.id === ONDO_PROVIDER_KEY
-            )?.quoteAsset
-          if (collateralAsset === null || collateralAsset === undefined) {
-            const error = new PerpsError(
-              PerpsErrorCode.SDKError,
-              'Ondo provider metadata is missing its collateral asset'
-            )
-            error.tool = ONDO_PROVIDER_KEY
-            throw error
-          }
+          const collateralAsset = requireOndoCollateralAsset(providers)
 
           const positions: Position[] = mapOpenPositions(
             rawPositions ?? [],
@@ -343,7 +335,7 @@ export const ondoProvider = (
           )
 
           // The backend owns the collateral identity; the venue supplies its
-          // gross wallet balance (locked margin in, unrealized PnL out).
+          // wallet balance (locked margin in, unrealized PnL out).
           return {
             provider: ONDO_PROVIDER_KEY,
             address: params.address,
@@ -373,12 +365,42 @@ export const ondoProvider = (
               apiKeyRegistered,
               referralSet: referral !== null && referral !== undefined,
               depositAddress,
+              balance: {
+                walletBalance: balance.walletBalance,
+                unrealizedPnl: balance.unrealizedPnl,
+                marginBalance: balance.marginBalance,
+                usedMargin: balance.usedMargin,
+                availableMargin: balance.availableMargin,
+                withdrawableMargin: balance.withdrawableMargin,
+              },
             },
           }
         }
       )
     },
 
+    async getWithdrawableBalances(
+      params: ProviderGetWithdrawableBalancesParams,
+      opts?: SDKRequestOptions
+    ): Promise<ProviderWithdrawableBalance[]> {
+      return withSession(
+        params.address,
+        (): ProviderWithdrawableBalance[] => [],
+        async (token) => {
+          const [{ providers }, balance] = await Promise.all([
+            getProviders(requireClient(), opts),
+            apiClient(opts).get<OndoBalanceSummary>('/v1/perps/balance', {
+              authToken: token.token,
+            }),
+          ])
+          return ondoWithdrawableBalances(
+            requireOndoCollateralAsset(providers).id,
+            balance
+          )
+        }
+      )
+    },
+
     async accountExists(
       params: ProviderAccountExistsParams,
       opts?: SDKRequestOptions
@@ -899,11 +921,8 @@ export const ondoProvider = (
       )
     },
 
-    getAccountSummary(
-      account: AccountResponse,
-      positions: Position[]
-    ): AccountSummary {
-      return getAccountSummary(account, positions)
+    getAccountSummary(account: AccountResponse): AccountSummary {
+      return getAccountSummary(account)
     },
 
     formatOrderPrice,

package/src/accountSummary.ts

@@ -1,22 +1,47 @@
-import { summarizeAccount } from '@lifi/perps-sdk'
+import { PerpsError } from '@lifi/perps-sdk'
 import type {
   AccountResponse,
   AccountSummary,
-  Position,
+  OndoAccountBalance,
 } from '@lifi/perps-types'
+import { PerpsErrorCode } from '@lifi/perps-types'
+
+const ZERO_SUMMARY: AccountSummary = {
+  portfolioValue: '0',
+  availableMargin: '0',
+  marginUsed: '0',
+  unrealizedPnl: '0',
+}
+
+const ondoBalance = (
+  account: AccountResponse
+): OndoAccountBalance | undefined => {
+  if (account.config.provider !== 'ondo') {
+    throw new PerpsError(
+      PerpsErrorCode.SDKError,
+      `Ondo account summary received a '${account.config.provider}' account config`
+    )
+  }
+  return account.config.balance
+}
 
 /**
- * Roll an Ondo {@link AccountResponse} up into an {@link AccountSummary}.
- * Ondo's collateral row holds `walletBalance`, which includes locked margin
- * but not unrealized PnL (the positions carry it) — gross semantics: the
- * venue counts unrealized PnL toward buying power
- * (`availableMargin = marginBalance − usedMargin`).
+ * Roll an Ondo account up into an {@link AccountSummary}, from the venue
+ * balance figures the response carries. A logged-out account reads no venue
+ * balance and summarizes as zero.
  *
+ * @throws {PerpsError} `SDKError` when the account is not an Ondo one.
  * @public
  */
-export function getAccountSummary(
-  account: AccountResponse,
-  positions: Position[]
-): AccountSummary {
-  return summarizeAccount(account, positions, 'gross')
+export function getAccountSummary(account: AccountResponse): AccountSummary {
+  const balance = ondoBalance(account)
+  if (balance === undefined) {
+    return ZERO_SUMMARY
+  }
+  return {
+    portfolioValue: balance.marginBalance,
+    availableMargin: balance.availableMargin,
+    marginUsed: balance.usedMargin,
+    unrealizedPnl: balance.unrealizedPnl,
+  }
 }

package/src/utils/collateralAsset.ts

@@ -0,0 +1,30 @@
+import { PerpsError } from '@lifi/perps-sdk'
+import type { Asset, Provider } from '@lifi/perps-types'
+import { PerpsErrorCode } from '@lifi/perps-types'
+import { ONDO_PROVIDER_KEY } from '../constants.js'
+
+/**
+ * The collateral asset the backend publishes for Ondo's single category. The
+ * backend owns the collateral identity, so the venue payload never names it.
+ *
+ * @throws {PerpsError} `SDKError` when the provider metadata carries none.
+ * @public
+ */
+export const requireOndoCollateralAsset = (
+  providers: readonly Provider[]
+): Asset => {
+  const asset = providers
+    .find((provider) => provider.key === ONDO_PROVIDER_KEY)
+    ?.categories.find(
+      (category) => category.id === ONDO_PROVIDER_KEY
+    )?.quoteAsset
+  if (asset === null || asset === undefined) {
+    const error = new PerpsError(
+      PerpsErrorCode.SDKError,
+      'Ondo provider metadata is missing its collateral asset'
+    )
+    error.tool = ONDO_PROVIDER_KEY
+    throw error
+  }
+  return asset
+}

package/src/utils/decimal.ts

@@ -0,0 +1,24 @@
+import { PerpsError } from '@lifi/perps-sdk'
+import { PerpsErrorCode } from '@lifi/perps-types'
+import Big from 'big.js'
+import { ONDO_PROVIDER_KEY } from '../constants.js'
+
+/**
+ * Exact-decimal parse of an Ondo wire decimal string. `field` names the
+ * offending field on failure, so a venue contract breach surfaces as a
+ * `PerpsError` instead of an anonymous big.js throw.
+ *
+ * @throws {PerpsError} `SDKError` when `value` is not a decimal numeric string.
+ */
+export const toWireBig = (value: string, field: string): Big => {
+  try {
+    return new Big(value)
+  } catch {
+    const error = new PerpsError(
+      PerpsErrorCode.SDKError,
+      `Ondo field \`${field}\` is not a valid decimal: '${value}'`
+    )
+    error.tool = ONDO_PROVIDER_KEY
+    throw error
+  }
+}

package/src/utils/index.ts

@@ -16,6 +16,7 @@ export {
   type OndoRequestOptions,
   OndoSessionExpiredError,
 } from './apiClient.js'
+export { requireOndoCollateralAsset } from './collateralAsset.js'
 export {
   buildOndoProvisionPayload,
   listOndoDepositAddress,
@@ -38,3 +39,4 @@ export { intervalFromBarSpan, mapInterval } from './ohlcvInterval.js'
 export { ondoAsset } from './ondoAsset.js'
 export { formatOrderPrice, formatOrderSize } from './orderFormatting.js'
 export { positionMarginConstraints } from './transferMargin.js'
+export { ondoWithdrawableBalances } from './withdrawableBalances.js'

package/src/utils/mapActivity.ts

@@ -1,4 +1,8 @@
-import type { AssetRegistry } from '@lifi/perps-sdk'
+import {
+  type AssetRegistry,
+  ExplorerChainId,
+  explorerTxUrl,
+} from '@lifi/perps-sdk'
 import type {
   DepositActivity,
   FundingActivity,
@@ -91,24 +95,46 @@ const depositId = (deposit: OndoWalletDeposit): string => {
     : `deposit:${deposit.txid}:${deposit.logIndex}`
 }
 
+/**
+ * Explorer chain per Ondo wire `chainId`, whose values Ondo's REST spec
+ * enumerates. Ondo also settles on Bitcoin, Solana and testnets, and a row on
+ * one of those resolves to no explorer link.
+ */
+const EXPLORER_CHAIN_BY_ONDO_CHAIN_ID: Record<string, ExplorerChainId> = {
+  'eth-mainnet': ExplorerChainId.ETHEREUM,
+  'avax-c-chain': ExplorerChainId.AVALANCHE_C_CHAIN,
+  'bsc-mainnet': ExplorerChainId.BNB_SMART_CHAIN,
+}
+
+const ondoExplorerLink = (
+  chainId: string,
+  txid: string
+): string | undefined => {
+  const explorerChainId = EXPLORER_CHAIN_BY_ONDO_CHAIN_ID[chainId]
+  return explorerChainId === undefined
+    ? undefined
+    : explorerTxUrl(explorerChainId, txid)
+}
+
 /** Map a wallet deposit with registry asset identity and its on-chain transaction. @public */
 export const mapDepositActivity = (
   deposit: OndoWalletDeposit,
   assetRegistry: AssetRegistry
-): DepositActivity => ({
-  id: depositId(deposit),
-  provider: ONDO_PROVIDER_KEY,
-  timestamp: new Date(deposit.time).toISOString(),
-  type: ActivityType.DEPOSIT,
-  asset: assetRegistry.require(deposit.coin),
-  amount: deposit.size,
-  ...(deposit.fromAddress === ''
-    ? {}
-    : { counterpartyAddress: deposit.fromAddress }),
-  ...(deposit.txid === ''
-    ? {}
-    : { explorerLink: `https://scan.li.fi/tx/${deposit.txid}` }),
-})
+): DepositActivity => {
+  const explorerLink = ondoExplorerLink(deposit.chainId, deposit.txid)
+  return {
+    id: depositId(deposit),
+    provider: ONDO_PROVIDER_KEY,
+    timestamp: new Date(deposit.time).toISOString(),
+    type: ActivityType.DEPOSIT,
+    asset: assetRegistry.require(deposit.coin),
+    amount: deposit.size,
+    ...(deposit.fromAddress === ''
+      ? {}
+      : { counterpartyAddress: deposit.fromAddress }),
+    ...(explorerLink === undefined ? {} : { explorerLink }),
+  }
+}
 
 const SETTLING_WITHDRAWAL_STATUSES = new Set<string>([
   'complete',
@@ -133,6 +159,7 @@ export const mapWithdrawalActivity = (
   if (!SETTLING_WITHDRAWAL_STATUSES.has(withdrawal.status)) {
     return null
   }
+  const explorerLink = ondoExplorerLink(withdrawal.chainId, withdrawal.txid)
   return {
     id: withdrawal.withdrawal_id,
     provider: ONDO_PROVIDER_KEY,
@@ -149,8 +176,6 @@ export const mapWithdrawalActivity = (
             asset: ONDO_WITHDRAWAL_FEE_SYMBOL,
           },
         }),
-    ...(withdrawal.txid === ''
-      ? {}
-      : { explorerLink: `https://scan.li.fi/tx/${withdrawal.txid}` }),
+    ...(explorerLink === undefined ? {} : { explorerLink }),
   }
 }

package/src/utils/withdrawableBalances.ts

@@ -0,0 +1,25 @@
+import type { ProviderWithdrawableBalance } from '@lifi/perps-sdk'
+import type { OndoBalanceSummary } from '../types/wire.js'
+import { toWireBig } from './decimal.js'
+
+/**
+ * The single route an Ondo withdrawal draws on: `withdrawableMargin`, the
+ * venue's own figure for the margin the account can take out. A route with
+ * nothing left to draw carries no row, and the caller applies the per-asset
+ * venue minimum.
+ *
+ * @param assetId - `Asset.id` the row is keyed by.
+ * @public
+ */
+export const ondoWithdrawableBalances = (
+  assetId: string,
+  balance: OndoBalanceSummary
+): ProviderWithdrawableBalance[] => {
+  const available = toWireBig(
+    balance.withdrawableMargin,
+    'balance.withdrawableMargin'
+  )
+  return available.gt(0)
+    ? [{ assetId, route: 'perps', available: available.toFixed() }]
+    : []
+}

package/src/websocket/OndoWsProvider.ts

@@ -1,4 +1,5 @@
 import {
+  DecodeChain,
   getMarketRegistry,
   localStorageAdapter,
   type MarketRegistry,
@@ -18,6 +19,7 @@ import {
 import type {
   MarketContext,
   MarketDisplay,
+  OndoAccountBalance,
   PerpsMarketDisplay,
   Subscription,
 } from '@lifi/perps-types'
@@ -131,13 +133,20 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
   private readonly authWireRefs = new Map<string, number>()
 
   /**
-   * Running account-summary inputs while `accountSummary` is subscribed
-   * (`undefined` otherwise). `walletBalance` is REST-seeded and refreshed on
-   * fills; `marginUsed`/`unrealizedPnl` track the latest positions frame.
+   * Latest venue balance figures while `accountSummary` is subscribed
+   * (`undefined` otherwise). REST-seeded, then re-read on every fills and
+   * positions frame, which is what moves them.
    */
-  private accountSummary:
-    | { walletBalance: number; marginUsed: number; unrealizedPnl: number }
-    | undefined
+  private accountSummary: OndoAccountBalance | undefined
+
+  /**
+   * Serializes the balance re-read: a single trade event emits a fills frame
+   * and a positions frame together, and two concurrent REST reads can resolve
+   * out of order. `'latest'` coalesces the backlog to one trailing refresh.
+   */
+  private readonly accountSummaryChain = new DecodeChain('latest', (err) =>
+    wsLog.handlerFailure(this.providerKey, err)
+  )
 
   /** Complete (mark-price-bearing) contexts, keyed by venue market symbol. */
   private contexts: Record<string, MarketContext> = {}
@@ -215,6 +224,8 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
       case 'accountSummary':
       case 'spotBalances':
         return `${sub.channel}:${sub.address.toLowerCase()}`
+      case 'availableToTrade':
+        throw new Error(`Ondo WS does not support channel: ${sub.channel}.`)
     }
   }
 
@@ -269,6 +280,7 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
     return () => {
       if (sub.channel === 'accountSummary') {
         this.accountSummary = undefined
+        this.accountSummaryChain.reset()
       }
       for (const [key, state] of wireSubs) {
         this.releaseWire(key, state, needsLogin)
@@ -484,6 +496,7 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
           ],
         ]
       case 'spotBalances':
+      case 'availableToTrade':
         return []
     }
   }
@@ -530,62 +543,60 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
   }
 
   /**
-   * Seed the account-summary inputs from the REST balance so the first emit is
-   * complete before any positions frame lands. Throws {@link
+   * Seed the account-summary figures from the REST balance so the first emit
+   * is complete before any positions frame lands. Throws {@link
    * OndoSessionExpiredError} when the SIWE session is missing, matching the
    * other authenticated channels.
    */
   private async seedAccountSummary(address: Address): Promise<void> {
     const token = await this.requireSession(address)
-    const balance = await this.restClient().get<OndoBalanceSummary>(
-      '/v1/perps/balance',
-      { authToken: token.token }
-    )
-    this.accountSummary = {
-      walletBalance: Number.parseFloat(balance.walletBalance) || 0,
-      marginUsed: Number.parseFloat(balance.usedMargin) || 0,
-      unrealizedPnl: Number.parseFloat(balance.unrealizedPnl) || 0,
-    }
+    this.accountSummary = await this.readBalance(token.token)
     this.emitAccountSummary()
   }
 
-  /** Re-pull the wallet balance (moved by the fill) and re-emit the summary. */
-  private async refreshAccountSummaryBalance(address: Address): Promise<void> {
+  /** Re-read the venue balance moved by the frame and re-emit the summary. */
+  private async refreshAccountSummary(address: Address): Promise<void> {
     const token = await this.tokenStore.get(address)
     if (token === null || this.accountSummary === undefined) {
       return
     }
-    const balance = await this.restClient().get<OndoBalanceSummary>(
-      '/v1/perps/balance',
-      { authToken: token.token }
-    )
+    const balance = await this.readBalance(token.token)
     if (this.accountSummary === undefined) {
       return
     }
-    this.accountSummary.walletBalance =
-      Number.parseFloat(balance.walletBalance) || 0
+    this.accountSummary = balance
     this.emitAccountSummary()
   }
 
-  /**
-   * Emit the current account summary. Gross semantics: `walletBalance` is the
-   * collateral, the positions carry unrealized PnL, so it counts toward buying
-   * power (`availableMargin = walletBalance + unrealizedPnl − marginUsed`).
-   */
+  private async readBalance(authToken: string): Promise<OndoAccountBalance> {
+    const balance = await this.restClient().get<OndoBalanceSummary>(
+      '/v1/perps/balance',
+      { authToken }
+    )
+    return {
+      walletBalance: balance.walletBalance,
+      unrealizedPnl: balance.unrealizedPnl,
+      marginBalance: balance.marginBalance,
+      usedMargin: balance.usedMargin,
+      availableMargin: balance.availableMargin,
+      withdrawableMargin: balance.withdrawableMargin,
+    }
+  }
+
+  /** Emit the current account summary from the venue balance figures. */
   private emitAccountSummary(): void {
-    const summary = this.accountSummary
+    const balance = this.accountSummary
     const address = this.accountAddress
-    if (summary === undefined || address === undefined) {
+    if (balance === undefined || address === undefined) {
       return
     }
-    const portfolioValue = summary.walletBalance + summary.unrealizedPnl
     this.emit(`accountSummary:${address}`, {
       channel: 'accountSummary',
       data: {
-        portfolioValue: portfolioValue.toString(),
-        availableMargin: (portfolioValue - summary.marginUsed).toString(),
-        marginUsed: summary.marginUsed.toString(),
-        unrealizedPnl: summary.unrealizedPnl.toString(),
+        portfolioValue: balance.marginBalance,
+        availableMargin: balance.availableMargin,
+        marginUsed: balance.usedMargin,
+        unrealizedPnl: balance.unrealizedPnl,
       },
     })
   }
@@ -792,8 +803,8 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
     }
     this.emit(`fills:${address}`, { channel: 'fills', data: mapped })
     if (this.accountSummary !== undefined) {
-      this.refreshAccountSummaryBalance(address as Address).catch((err) =>
-        wsLog.handlerFailure(this.providerKey, err)
+      this.accountSummaryChain.push(() =>
+        this.refreshAccountSummary(address as Address)
       )
     }
   }
@@ -818,15 +829,9 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
       data: mapped,
     })
     if (this.accountSummary !== undefined) {
-      let marginUsed = 0
-      let unrealizedPnl = 0
-      for (const position of positions) {
-        marginUsed += Number.parseFloat(position.usedMargin) || 0
-        unrealizedPnl += Number.parseFloat(position.unrealizedPnl) || 0
-      }
-      this.accountSummary.marginUsed = marginUsed
-      this.accountSummary.unrealizedPnl = unrealizedPnl
-      this.emitAccountSummary()
+      this.accountSummaryChain.push(() =>
+        this.refreshAccountSummary(address as Address)
+      )
     }
   }
 }