@lifi/perps-sdk-provider-ondo 23.0.0 → 24.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,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;IACjB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;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;IACtD,OAAO,CAAC,wBAAwB,CAAI;IAEpC;;;;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;IAC/C,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,eAAe,CAAI;IAC3B,OAAO,CAAC,eAAe,CAAI;gBAGzB,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;IAoHnE;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAa5B,4EAA4E;IAC5E,OAAO,CAAC,cAAc;IAWtB,2EAA2E;YAC7D,WAAW;IAwBzB,4EAA4E;IAC5E,OAAO,CAAC,WAAW;cAgBH,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAoB1C,OAAO,IAAI,IAAI;IAYlC,0EAA0E;IAC1E,OAAO,CAAC,cAAc;IA0GtB;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAqBnB,OAAO,CAAC,UAAU;IAMlB;;;;;OAKG;YACW,kBAAkB;IAgBhC,4EAA4E;YAC9D,qBAAqB;IAuBnC,OAAO,CAAC,mBAAmB;YAMb,WAAW;IAezB,uEAAuE;IACvE,OAAO,CAAC,kBAAkB;IAgB1B,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;IAqBnB,OAAO,CAAC,eAAe;CA0BxB;AAED;;;;;;;;;GASG;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,EAML,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAGlB,KAAK,cAAc,EAGnB,cAAc,EACd,KAAK,iBAAiB,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAML,KAAK,YAAY,EAClB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AA+DnC,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;IACjB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;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;IACtD,OAAO,CAAC,wBAAwB,CAAI;IAEpC;;;;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;IAC/C,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,eAAe,CAAI;IAC3B,OAAO,CAAC,eAAe,CAAI;gBAGzB,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;IAoHnE;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAa5B,4EAA4E;IAC5E,OAAO,CAAC,cAAc;IAWtB,2EAA2E;YAC7D,WAAW;IAwBzB,4EAA4E;IAC5E,OAAO,CAAC,WAAW;cAgBH,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAoB1C,OAAO,IAAI,IAAI;IAYlC,0EAA0E;IAC1E,OAAO,CAAC,cAAc;IA0GtB;;;;;OAKG;YACW,cAAc;IAW5B;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAqBnB,OAAO,CAAC,UAAU;IAMlB;;;;;OAKG;YACW,kBAAkB;IAgBhC,4EAA4E;YAC9D,qBAAqB;IAuBnC,OAAO,CAAC,mBAAmB;YAMb,WAAW;IAezB,uEAAuE;IACvE,OAAO,CAAC,kBAAkB;IAgB1B,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;IAqBnB,OAAO,CAAC,eAAe;CA0BxB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,qBAAqB,KAC9B,iBAKA,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-sdk-provider-ondo",
-  "version": "23.0.0",
+  "version": "24.0.0",
   "description": "Ondo Perps provider plugin for @lifi/perps-sdk",
   "homepage": "https://github.com/lifinance/perps-sdk",
   "bugs": {
@@ -47,7 +47,7 @@
     "@lifi/perps-types": "^19.0.0"
   },
   "peerDependencies": {
-    "@lifi/perps-sdk": "^21.0.0"
+    "@lifi/perps-sdk": "^21.1.0"
   },
   "publishConfig": {
     "access": "public"

package/src/OndoProvider.ts

@@ -162,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
@@ -272,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,
 
@@ -311,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 [
@@ -415,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([
@@ -452,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',
@@ -491,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()
@@ -573,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
@@ -590,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),
@@ -622,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
@@ -653,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([
@@ -693,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
@@ -860,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([
@@ -899,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 = {}
@@ -946,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)
@@ -1090,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([

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,