@lifi/perps-sdk-provider-ondo 22.0.1 → 24.0.0

package/src/OndoProvider.ts

@@ -1,6 +1,7 @@
 import {
   ACTIVE_ORDER_STATUSES,
   type ActionSignerContribution,
+  calculateTransferable,
   createWarnOnce,
   type DepositFlow,
   ETHEREUM_USDC,
@@ -8,8 +9,6 @@ import {
   getMarketRegistry,
   getProviders,
   localStorageAdapter,
-  maxOf,
-  minOf,
   PerpsError,
   type PerpsProviderPlugin,
   type PerpsSDKClient,
@@ -74,7 +73,6 @@ import {
   MarginMode,
   PerpsErrorCode,
 } from '@lifi/perps-types'
-import Big from 'big.js'
 import { type Address, getAddress } from 'viem'
 import { projectOndoConfigSettings } from './accountConfig.js'
 import { getAccountSummary } from './accountSummary.js'
@@ -123,8 +121,6 @@ import {
 import { toWireBig } from './utils/decimal.js'
 import {
   estimateLiquidationPrice,
-  formatOrderPrice,
-  formatOrderSize,
   listOndoDepositAddress,
   mapDepositActivity,
   mapFill,
@@ -137,6 +133,8 @@ import {
   ondoWithdrawableBalances,
   positionRemovableMargin,
   requireOndoCollateralAsset,
+  snapOrderPrice,
+  snapOrderSize,
 } from './utils/index.js'
 import { mapPortfolioHistory } from './utils/mapPortfolioHistory.js'
 import {
@@ -164,9 +162,10 @@ export interface OndoProviderOptions {
  *
  * Per-user reads call Ondo's REST API directly — every one requires the
  * session JWT obtained through the SIWE login and stored in the token store.
- * Without a stored token the reads degrade gracefully (empty pages,
- * `loggedIn: false` config) instead of failing; `getOrder` throws because an
- * empty result would be indistinguishable from "order not found".
+ * A data read throws `PerpsErrorCode.SetupRequired` when no session is stored
+ * and `PerpsErrorCode.Unauthorized` when Ondo rejects the stored session. A
+ * status read (`getAccount`, `accountExists`, `getDepositFlow`,
+ * `getWithdrawFlow`) returns the logged-out state instead.
  *
  * @example
  * ```ts
@@ -274,30 +273,69 @@ export const ondoProvider = (
     config: emptyConfig,
   })
 
-  // Runs an authenticated read against a live session. An absent local token
-  // and a server-revoked one (surfaced mid-call as `OndoSessionExpiredError`)
-  // both evict any stale token and fall back to `loggedOut`, so a rotated
-  // session never soft-locks the UI behind a token that looks valid locally.
+  // Runs an authenticated read against a live session. `noSession` answers
+  // when no token is stored; `rejected` answers after the venue rejects the
+  // stored token mid-call (`OndoSessionExpiredError`), which is evicted first
+  // so a rotated session never soft-locks the UI behind a token that looks
+  // valid locally.
   const withSession = async <T>(
     address: Address,
-    loggedOut: () => T,
+    fallback: {
+      noSession: () => T
+      rejected: (cause: OndoSessionExpiredError) => T
+    },
     fn: (token: OndoAuthToken) => Promise<T>
   ): Promise<T> => {
     const token = await tokenStore.get(address)
     if (token === null) {
-      return loggedOut()
+      return fallback.noSession()
     }
     try {
       return await fn(token)
     } catch (err) {
       if (err instanceof OndoSessionExpiredError) {
         await tokenStore.remove(address)
-        return loggedOut()
+        return fallback.rejected(err)
       }
       throw err
     }
   }
 
+  const sessionRequired = (read: string) => (): never => {
+    const error = new PerpsError(
+      PerpsErrorCode.SetupRequired,
+      `Ondo ${read} requires a session token. Run the SIWE login first.`
+    )
+    error.tool = ONDO_PROVIDER_KEY
+    throw error
+  }
+
+  const sessionRejected =
+    (read: string) =>
+    (cause: OndoSessionExpiredError): never => {
+      const error = new PerpsError(
+        PerpsErrorCode.Unauthorized,
+        `Ondo ${read} failed: the venue rejected the session; sign in again.`
+      )
+      error.tool = ONDO_PROVIDER_KEY
+      error.cause = cause
+      throw error
+    }
+
+  // A data read throws the account's state: an empty result would be
+  // indistinguishable from an account with no data.
+  const dataRead = (read: string) => ({
+    noSession: sessionRequired(read),
+    rejected: sessionRejected(read),
+  })
+
+  // A status read reports the logged-out state whether the session is absent
+  // or was rejected.
+  const statusRead = <T>(loggedOut: () => T) => ({
+    noSession: loggedOut,
+    rejected: loggedOut,
+  })
+
   return {
     type: ONDO_PROVIDER_KEY,
 
@@ -313,13 +351,13 @@ export const ondoProvider = (
       const apiKeyRegistered = apiKey !== null && hasOndoApiKeyScopes(apiKey)
       return withSession(
         params.address,
-        () => {
+        statusRead(() => {
           const account = loggedOutAccount(params.address)
           return {
             ...account,
             config: { ...emptyConfig, apiKeyRegistered },
           }
-        },
+        }),
         async (token) => {
           const client = apiClient(opts)
           const [
@@ -373,16 +411,13 @@ export const ondoProvider = (
                     units: balance.walletBalance,
                     valueUsd: balance.walletBalance,
                     price: '1',
-                    transferable: minOf(
-                      maxOf(
-                        toWireBig(
-                          balance.withdrawableMargin,
-                          'balance.withdrawableMargin'
-                        ),
-                        new Big(0)
-                      ),
-                      walletBalance
-                    ).toFixed(),
+                    transferable: calculateTransferable(
+                      toWireBig(
+                        balance.withdrawableMargin,
+                        'balance.withdrawableMargin'
+                      ).toFixed(),
+                      walletBalance.toFixed()
+                    ),
                   },
                 ]
               : [],
@@ -420,7 +455,7 @@ export const ondoProvider = (
     ): Promise<ProviderWithdrawableBalance[]> {
       return withSession(
         params.address,
-        (): ProviderWithdrawableBalance[] => [],
+        dataRead('withdrawable balances read'),
         async (token) => {
           const client = apiClient(opts)
           const [{ providers }, balance, account] = await Promise.all([
@@ -457,11 +492,7 @@ export const ondoProvider = (
       }
       return withSession(
         params.address,
-        () => {
-          throw new OndoSessionExpiredError(
-            `No valid Ondo session token stored for ${params.address}. Run the SIWE login first.`
-          )
-        },
+        dataRead('market settings read'),
         async (token) => {
           const leverages = await apiClient(opts).get<OndoLeverage[]>(
             '/v1/perps/leverage',
@@ -496,7 +527,7 @@ export const ondoProvider = (
     ): Promise<AvailableToTrade | undefined> {
       return withSession(
         params.address,
-        () => undefined,
+        dataRead('available-to-trade read'),
         async (token) => {
           const registry = marketRegistry()
           await registry.sync()
@@ -578,7 +609,7 @@ export const ondoProvider = (
     ): Promise<boolean> {
       return withSession(
         params.address,
-        () => false,
+        statusRead(() => false),
         async (token) => {
           await apiClient(opts).get('/v1/account', { authToken: token.token })
           return true
@@ -595,10 +626,12 @@ export const ondoProvider = (
       // before a route has a recipient.
       return withSession<DepositFlow>(
         params.address,
-        () => ({
-          kind: 'setupRequired',
-          setup: [ActionType.SIWE_LOGIN, ActionType.CREATE_DEPOSIT_ADDRESS],
-        }),
+        statusRead(
+          (): DepositFlow => ({
+            kind: 'setupRequired',
+            setup: [ActionType.SIWE_LOGIN, ActionType.CREATE_DEPOSIT_ADDRESS],
+          })
+        ),
         async (token) => {
           const depositAddress = await listOndoDepositAddress(
             apiClient(opts),
@@ -627,10 +660,12 @@ export const ondoProvider = (
       // offers one destination: the login address.
       return withSession<WithdrawFlow>(
         params.address,
-        () => ({
-          kind: 'setupRequired',
-          setup: [ActionType.SIWE_LOGIN, ActionType.ADD_WITHDRAWAL_ADDRESS],
-        }),
+        statusRead(
+          (): WithdrawFlow => ({
+            kind: 'setupRequired',
+            setup: [ActionType.SIWE_LOGIN, ActionType.ADD_WITHDRAWAL_ADDRESS],
+          })
+        ),
         async (token) => {
           const { addressBook } = await apiClient(
             opts
@@ -658,11 +693,7 @@ export const ondoProvider = (
     ): Promise<PositionsResponse> {
       return withSession<PositionsResponse>(
         params.address,
-        () => ({
-          provider: ONDO_PROVIDER_KEY,
-          positions: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }),
+        dataRead('positions read'),
         async (token) => {
           const client = apiClient(opts)
           const [rawPositions] = await Promise.all([
@@ -698,11 +729,7 @@ export const ondoProvider = (
     ): Promise<OrdersResponse> {
       return withSession<OrdersResponse>(
         params.address,
-        () => ({
-          provider: ONDO_PROVIDER_KEY,
-          orders: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }),
+        dataRead('orders read'),
         async (token) => {
           const statuses =
             params.statuses === undefined
@@ -865,12 +892,7 @@ export const ondoProvider = (
     ): Promise<Order> {
       return withSession(
         params.address,
-        (): Order => {
-          throw new PerpsError(
-            PerpsErrorCode.SDKError,
-            'Ondo order lookup requires a session token. Run the SIWE login first.'
-          )
-        },
+        dataRead('order lookup'),
         async (token) => {
           const client = apiClient(opts)
           const [order] = await Promise.all([
@@ -904,11 +926,7 @@ export const ondoProvider = (
     ): Promise<FillsResponse> {
       return withSession<FillsResponse>(
         params.address,
-        () => ({
-          provider: ONDO_PROVIDER_KEY,
-          items: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }),
+        dataRead('fills read'),
         async (token) => {
           const client = apiClient(opts)
           const queryParams: ApiParams = {}
@@ -951,11 +969,7 @@ export const ondoProvider = (
     ): Promise<ActivitiesResponse> {
       return withSession<ActivitiesResponse>(
         params.address,
-        () => ({
-          provider: ONDO_PROVIDER_KEY,
-          items: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }),
+        dataRead('activity read'),
         async (token) => {
           const inputCursor = decodeActivityCursor(params.cursor)
           const client = apiClient(opts)
@@ -1095,7 +1109,7 @@ export const ondoProvider = (
     ): Promise<PortfolioHistoryResponse> {
       return withSession<PortfolioHistoryResponse>(
         params.address,
-        () => ({ range: params.range, points: [] }),
+        dataRead('portfolio history read'),
         async (token) => {
           const client = apiClient(opts)
           const [graph, summary] = await Promise.all([
@@ -1129,9 +1143,9 @@ export const ondoProvider = (
       return getAccountSummary(account)
     },
 
-    formatOrderPrice,
+    snapOrderPrice,
 
-    formatOrderSize,
+    snapOrderSize,
 
     estimateLiquidationPrice,
 

package/src/utils/index.ts

@@ -38,6 +38,6 @@ export { mapOrder, mapOrderStatus, mapOrderUpdates } from './mapOrder.js'
 export { mapOpenPositions, mapPosition } from './mapPosition.js'
 export { intervalFromBarSpan, mapInterval } from './ohlcvInterval.js'
 export { ondoAsset } from './ondoAsset.js'
-export { formatOrderPrice, formatOrderSize } from './orderFormatting.js'
+export { snapOrderPrice, snapOrderSize } from './orderFormatting.js'
 export { positionRemovableMargin } from './transferMargin.js'
 export { ondoWithdrawableBalances } from './withdrawableBalances.js'

package/src/utils/liquidation.ts

@@ -7,7 +7,7 @@
  */
 
 import {
-  estimateIsolatedLiquidationPrice,
+  estimateLiquidationPrice as estimateIsolatedLiquidationPrice,
   type LiquidationEstimateParams,
 } from '@lifi/perps-sdk'
 import type { PerpsMarket } from '@lifi/perps-types'

package/src/utils/orderFormatting.ts

@@ -1,5 +1,5 @@
 /**
- * Ondo order size and price formatting for exchange submission.
+ * Ondo order size and price snapping for exchange submission.
  *
  * Ondo's tick and lot grids are exact contract increments (`quoteIncrement` /
  * `baseIncrement`) that need not be powers of ten. When the generic
@@ -10,7 +10,11 @@
  */
 
 import { PerpsError } from '@lifi/perps-sdk'
-import { type Market, PerpsErrorCode } from '@lifi/perps-types'
+import {
+  type DecimalString,
+  type Market,
+  PerpsErrorCode,
+} from '@lifi/perps-types'
 import Big from 'big.js'
 
 const powerOfTenIncrement = (decimals: number): Big => new Big(`1e-${decimals}`)
@@ -25,21 +29,24 @@ const priceGrid = (market: Market): Big => {
   throw new PerpsError(
     PerpsErrorCode.ValidationError,
     `Market '${market.id}' carries no price grid; Ondo order prices cannot ` +
-      `be formatted without the market's tick increment.`
+      `be snapped without the market's tick increment.`
   )
 }
 
 /**
- * Format a price onto an Ondo market's tick grid: snapped half-up to the
- * nearest `priceIncrement` (or the grid implied by `priceDecimals`), trailing
- * zeros stripped.
+ * Snap a price onto an Ondo market's tick grid: half-up to the nearest
+ * `priceIncrement` (or the grid implied by `priceDecimals`), trailing zeros
+ * stripped.
  *
  * @throws {PerpsError} `ValidationError` when the market carries neither
  *   `priceIncrement` nor `priceDecimals` — without the venue's tick grid no
  *   correct price can be produced.
  * @public
  */
-export function formatOrderPrice(market: Market, price: number): string {
+export function snapOrderPrice(
+  market: Market,
+  price: DecimalString
+): DecimalString {
   const increment = priceGrid(market)
   const snapped = new Big(price)
     .div(increment)
@@ -49,7 +56,7 @@ export function formatOrderPrice(market: Market, price: number): string {
 }
 
 /**
- * Format a size onto an Ondo market's lot grid: truncated toward zero (never
+ * Snap a size onto an Ondo market's lot grid: truncated toward zero (never
  * rounded up, so the size cannot exceed the user's balance) to the market's
  * `sizeIncrement` (or the grid implied by `szDecimals`), trailing zeros
  * stripped.
@@ -57,7 +64,10 @@ export function formatOrderPrice(market: Market, price: number): string {
  * @param size - Size in base-asset units as a non-negative magnitude.
  * @public
  */
-export function formatOrderSize(market: Market, size: number): string {
+export function snapOrderSize(
+  market: Market,
+  size: DecimalString
+): DecimalString {
   const increment =
     market.sizeIncrement !== undefined
       ? new Big(market.sizeIncrement)

package/src/utils/withdrawableBalances.ts

@@ -1,4 +1,7 @@
-import type { ProviderWithdrawableBalance } from '@lifi/perps-sdk'
+import {
+  calculateWithdrawMax,
+  type ProviderWithdrawableBalance,
+} from '@lifi/perps-sdk'
 import type { OndoBalanceSummary } from '../types/wire.js'
 import { toWireBig } from './decimal.js'
 
@@ -10,9 +13,9 @@ import { toWireBig } from './decimal.js'
  *
  * @param assetId - `Asset.id` the row is keyed by.
  * @param withdrawalFeeUsd - The account's `withdrawalFeeUSD`. Ondo collateral
- *   is USDC, so the USD fee is the row fee 1:1 in collateral units. Ondo
- *   charges it on top of the requested amount. Absent leaves the row without a
- *   fee.
+ * is USDC, so the USD fee is the row fee 1:1 in collateral units. Ondo
+ * charges it on top of the requested amount. Absent leaves the row without a
+ * fee.
  * @public
  */
 export const ondoWithdrawableBalances = (
@@ -27,20 +30,19 @@ export const ondoWithdrawableBalances = (
   if (!available.gt(0)) {
     return []
   }
-  return [
-    {
-      assetId,
-      route: 'perps',
-      available: available.toFixed(),
-      ...(withdrawalFeeUsd === undefined
-        ? {}
-        : {
-            withdrawalFee: toWireBig(
-              withdrawalFeeUsd,
-              'account.withdrawalFeeUSD'
-            ).toFixed(),
-            isFeeDeducted: false,
-          }),
-    },
-  ]
+  const row = {
+    assetId,
+    route: 'perps' as const,
+    available: available.toFixed(),
+    ...(withdrawalFeeUsd === undefined
+      ? {}
+      : {
+          withdrawalFee: toWireBig(
+            withdrawalFeeUsd,
+            'account.withdrawalFeeUSD'
+          ).toFixed(),
+          isFeeDeducted: false,
+        }),
+  }
+  return [{ ...row, max: calculateWithdrawMax(row) }]
 }

package/src/websocket/OndoWsProvider.ts

@@ -3,6 +3,7 @@ import {
   getMarketRegistry,
   localStorageAdapter,
   type MarketRegistry,
+  PerpsError,
   type PerpsSDKClient,
   type ProviderGetQuoteParams,
   type QuoteListener,
@@ -16,12 +17,13 @@ import {
   type WsProviderFactoryParams,
   wsLog,
 } from '@lifi/perps-sdk'
-import type {
-  MarketContext,
-  MarketDisplay,
-  OndoAccountBalance,
-  PerpsMarketDisplay,
-  Subscription,
+import {
+  type MarketContext,
+  type MarketDisplay,
+  type OndoAccountBalance,
+  PerpsErrorCode,
+  type PerpsMarketDisplay,
+  type Subscription,
 } from '@lifi/perps-types'
 import type { Address } from 'viem'
 import { OndoTokenStore } from '../auth/OndoTokenStore.js'
@@ -44,7 +46,6 @@ import type {
   OndoWsMessage,
   OndoWsTrade,
 } from '../types/index.js'
-import { OndoSessionExpiredError } from '../utils/apiClient.js'
 import {
   mapFill,
   mapOrderUpdates,
@@ -65,7 +66,7 @@ import { intervalFromBarSpan, mapInterval } from '../utils/ohlcvInterval.js'
 // connection, sent before the first private subscribe; the venue rejects a
 // second login on the same connection. The JWT comes from the SIWE session in
 // the token store — absent or expired reads back as null and surfaces as
-// `OndoSessionExpiredError` so callers re-run the SIWE login. A dropped
+// `PerpsError` with `SetupRequired` so callers run the SIWE login. A dropped
 // socket forgets the login, so the guard resets on every close.
 
 const ONDO_AUTH_CHANNEL = {
@@ -580,14 +581,16 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
   }
 
   /**
-   * The stored SIWE session for `address`, or {@link OndoSessionExpiredError}
-   * when it is absent or expired. Shared by the subscribe-time guard, the
-   * login op and the account-summary seed so all three report one message.
+   * The stored SIWE session for `address`, or {@link PerpsError} with
+   * `SetupRequired` when it is absent or expired. Shared by the subscribe-time
+   * guard, the login op and the account-summary seed so all three report one
+   * message.
    */
   private async requireSession(address: Address): Promise<OndoAuthToken> {
     const token = await this.tokenStore.get(address)
     if (token === null) {
-      throw new OndoSessionExpiredError(
+      throw new PerpsError(
+        PerpsErrorCode.SetupRequired,
         `No Ondo session for ${address}. Run the SIWE login before subscribing to account channels.`
       )
     }
@@ -628,9 +631,9 @@ export class OndoWsProvider extends WsProviderBase<SubState> {
 
   /**
    * 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.
+   * is complete before any positions frame lands. Throws {@link PerpsError}
+   * with `SetupRequired` when the SIWE session is missing, matching the other
+   * authenticated channels.
    */
   private async seedAccountSummary(
     address: Address,