@lifi/perps-sdk-provider-lighter 32.0.0 → 33.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"LighterWsProvider.d.ts","sourceRoot":"","sources":["../../../src/websocket/LighterWsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAKlB,cAAc,EACd,KAAK,iBAAiB,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAML,KAAK,YAAY,EAClB,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAuFnC;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;AAEhC,UAAU,QAAQ;IAChB,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yEAAyE;IACzE,SAAS,EAAE,OAAO,CAAA;CACnB;AAyBD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAA;CAC5C;AAED;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAC7D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IACtC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAE5B;IACb,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IAEnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAC/D,OAAO,CAAC,cAAc,CAAoC;IAE1D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA2C;IAE9E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAGlC;IAEH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IAErD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA4B;IAC9D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqC;gBAGxE,KAAK,GAAE,MAA+B,EACtC,WAAW,GAAE,MAA6B,EAC1C,OAAO,GAAE,wBAA6B,EACtC,MAAM,CAAC,EAAE,cAAc;IAsBzB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAWzB;;;;;OAKG;IACG,cAAc,CAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,MAAM,IAAI,CAAC;cAkBN,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IAsEnE;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;cASP,OAAO,IAAI,IAAI;cAOlB,aAAa,CAAC,EAC5B,OAAO,EACP,SAAS,EACT,OAAO,GACR,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3B;;;;;;OAMG;YACW,gBAAgB;IAsB9B,2FAA2F;YAC7E,mBAAmB;IAYjC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,MAAM;YAyB5B,cAAc;YAmGd,mBAAmB;YAqBnB,iBAAiB;IAK/B,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAqB1C,OAAO,CAAC,QAAQ;IA0GhB,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,eAAe;IAyDvB,4EAA4E;IAC5E,OAAO,CAAC,gBAAgB;IAqCxB,qEAAqE;IACrE,OAAO,CAAC,kBAAkB;IAgD1B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,mBAAmB;IAiB3B,OAAO,CAAC,sBAAsB;IAiC9B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,iBAAiB;IAuCzB,OAAO,CAAC,eAAe;IA+BvB,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,mBAAmB;CAc5B;AAkID;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,wBAAwB,KACjC,iBAKA,CAAA"}
+{"version":3,"file":"LighterWsProvider.d.ts","sourceRoot":"","sources":["../../../src/websocket/LighterWsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAKlB,cAAc,EACd,KAAK,iBAAiB,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAML,KAAK,YAAY,EAClB,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAuFnC;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;AAEhC,UAAU,QAAQ;IAChB,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yEAAyE;IACzE,SAAS,EAAE,OAAO,CAAA;CACnB;AAyBD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAA;CAC5C;AAED;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAC7D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IACtC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAE5B;IACb,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IAEnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAC/D,OAAO,CAAC,cAAc,CAAoC;IAE1D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA2C;IAE9E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAGlC;IAEH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IAErD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA4B;IAC9D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqC;gBAGxE,KAAK,GAAE,MAA+B,EACtC,WAAW,GAAE,MAA6B,EAC1C,OAAO,GAAE,wBAA6B,EACtC,MAAM,CAAC,EAAE,cAAc;IAsBzB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAWzB;;;;;OAKG;IACG,cAAc,CAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,MAAM,IAAI,CAAC;cAkBN,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IA6DnE;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;cASP,OAAO,IAAI,IAAI;cAOlB,aAAa,CAAC,EAC5B,OAAO,EACP,SAAS,EACT,OAAO,GACR,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3B;;;;;;;OAOG;YACW,gBAAgB;IAsB9B,2FAA2F;YAC7E,mBAAmB;IAYjC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,MAAM;YAyB5B,cAAc;YAwGd,mBAAmB;YAqBnB,iBAAiB;IAK/B,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAqB1C,OAAO,CAAC,QAAQ;IA0GhB,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,eAAe;IAyDvB,4EAA4E;IAC5E,OAAO,CAAC,gBAAgB;IAqCxB,qEAAqE;IACrE,OAAO,CAAC,kBAAkB;IAgD1B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,mBAAmB;IAiB3B,OAAO,CAAC,sBAAsB;IAiC9B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,iBAAiB;IAuCzB,OAAO,CAAC,eAAe;IA+BvB,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,mBAAmB;CAc5B;AAkID;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,wBAAwB,KACjC,iBAKA,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-sdk-provider-lighter",
-  "version": "32.0.0",
+  "version": "33.0.0",
   "description": "Lighter 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/LighterProvider.ts

@@ -275,10 +275,26 @@ interface ReadOnlyCreationBackoff {
  *   4. Fresh 1h create via this instance's WASM signer + the user's registered
  *      API key
  *
- * When none of these yields a token the auth-gated reads degrade gracefully:
- *   - `getOrders`, `getActivity` return empty results (mirrors backend behaviour)
- *   - `getOrder` throws `Unauthorized`
- *   - `getAccount` returns zero fee tier rather than failing
+ * Status reads report the account's state and do not throw for a missing
+ * credential: `getAccount` returns a zero fee tier and
+ * `apiKeyRegistered: false` when the wallet has no locally stored API key
+ * matching the key registered on Lighter; otherwise it reads the fee tier
+ * with the resolved token and throws `Unauthorized` if Lighter rejects it.
+ * `accountExists` and `getDepositFlow` need no token.
+ *
+ * Data reads throw `PerpsError`, one code per fact:
+ *   - `SetupRequired` when none of these sources yields a token. The SDK
+ *     sends no venue request. `getOrders`, `getOrder`, `getFills`,
+ *     `getPortfolioHistory` and `getActivity` need a token.
+ *   - `Unauthorized` when Lighter rejects the token that was sent. An
+ *     SDK-owned read-only token that Lighter reports as revoked is replaced
+ *     and the read retried once first.
+ *   - `AccountNotFound` when the wallet has no Lighter account. This also
+ *     applies to `getPositions`, `getWithdrawableBalances` and
+ *     `getAvailableToTrade`, which need no token. `getAvailableToTrade`
+ *     reads the fee tier through `getAccount`, so it also throws
+ *     `Unauthorized` when a matching local key's token is rejected.
+ * An account with no rows resolves an empty list.
  *
  * @public
  */
@@ -328,8 +344,7 @@ export interface LighterPerpsProvider extends PerpsProviderPlugin {
   /**
    * Resolve a Lighter auth token for `address`, following the resolution order
    * documented on {@link LighterProviderOptions} (the per-call override does not
-   * apply here). Returns `undefined` when no source can produce a token —
-   * callers degrade gracefully.
+   * apply here). Returns `undefined` when no source can produce a token.
    */
   resolveAuthToken(address: Address): Promise<string | undefined>
 }
@@ -454,8 +469,7 @@ export const createLighterProvider = (
    *      as the credential that authorises read-only token creation, and as
    *      the fallback while creation is failing, bounded by the
    *      creation-retry backoff.
-   * Returns `undefined` when no source can produce a token — reads degrade
-   * gracefully.
+   * Returns `undefined` when no source can produce a token.
    */
   const resolveAuthToken = async (
     opts: SDKRequestOptions | undefined,
@@ -549,6 +563,25 @@ export const createLighterProvider = (
     return attempt
   }
 
+  /** {@link resolveAuthToken}, throwing `SetupRequired` when no source yields a token. */
+  const requireAuthToken = async (
+    read: string,
+    opts: SDKRequestOptions | undefined,
+    address: Address,
+    knownApiKey?: LighterApiKey
+  ): Promise<string> => {
+    const token = await resolveAuthToken(opts, address, knownApiKey)
+    if (token === undefined) {
+      throw new PerpsError(
+        PerpsErrorCode.SetupRequired,
+        `Lighter ${read} requires an auth token. Pass \`authToken\` to ` +
+          'lighterProvider, register an API key + signer for on-demand creation, or ' +
+          'forward `options.lighterAuthToken` on the call.'
+      )
+    }
+    return token
+  }
+
   const replaceRevokedReadOnlyToken = async (
     address: Address,
     revokedToken: string
@@ -945,6 +978,7 @@ export const createLighterProvider = (
         localKey !== null &&
         normalizeLighterPublicKey(localKey.apiKeyPublicKey) ===
           normalizeLighterPublicKey(registeredKey.public_key)
+      // Status read: a missing or stale credential reports `apiKeyRegistered: false`, not a throw.
       const token = apiKeyRegistered
         ? await resolveAuthToken(opts, params.address, localKey)
         : undefined
@@ -1149,13 +1183,11 @@ export const createLighterProvider = (
       params: ProviderGetWithdrawableBalancesParams,
       opts?: SDKRequestOptions
     ): Promise<ProviderWithdrawableBalance[]> {
-      const account = await fetchAccountIfExists(
+      const account = await fetchDetailedAccount(
         apiClient(opts),
         params.address
       )
-      return account === undefined
-        ? []
-        : lighterWithdrawableBalances(account, collateral.assetIndex)
+      return lighterWithdrawableBalances(account, collateral.assetIndex)
     },
 
     async getPositions(
@@ -1165,16 +1197,9 @@ export const createLighterProvider = (
       const client = apiClient(opts)
       const registry = getMarketRegistry(requireClient(), providerKey)
       const [account] = await Promise.all([
-        fetchAccountIfExists(client, params.address),
+        fetchDetailedAccount(client, params.address),
         registry.sync(),
       ])
-      if (account === undefined) {
-        return {
-          provider: providerKey,
-          positions: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }
-      }
 
       let positions: Position[] = mapOpenPositions(account.positions, (id) =>
         toPerpsMarketDisplay(registry.require(String(id)))
@@ -1279,10 +1304,7 @@ export const createLighterProvider = (
       if (statuses.size === 0) {
         return empty
       }
-      const token = await resolveAuthToken(opts, params.address)
-      if (token === undefined) {
-        return empty
-      }
+      const token = await requireAuthToken('orders read', opts, params.address)
 
       const client = apiClient(opts)
       const registry = getMarketRegistry(requireClient(), providerKey)
@@ -1371,15 +1393,7 @@ export const createLighterProvider = (
       params: ProviderGetOrderParams,
       opts?: SDKRequestOptions
     ): Promise<Order> {
-      const token = await resolveAuthToken(opts, params.address)
-      if (token === undefined) {
-        throw new PerpsError(
-          PerpsErrorCode.SDKError,
-          'Lighter order lookup requires an auth token. Pass `authToken` to ' +
-            'lighterProvider, register an API key + signer for on-demand creation, or ' +
-            'forward `options.lighterAuthToken` on the call.'
-        )
-      }
+      const token = await requireAuthToken('order lookup', opts, params.address)
 
       const client = apiClient(opts)
       const registry = getMarketRegistry(requireClient(), providerKey)
@@ -1477,14 +1491,7 @@ export const createLighterProvider = (
       params: ProviderGetFillsParams,
       opts?: SDKRequestOptions
     ): Promise<FillsResponse> {
-      const token = await resolveAuthToken(opts, params.address)
-      if (token === undefined) {
-        return {
-          provider: providerKey,
-          items: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }
-      }
+      const token = await requireAuthToken('fills read', opts, params.address)
 
       const client = apiClient(opts)
       const registry = getMarketRegistry(requireClient(), providerKey)
@@ -1541,14 +1548,12 @@ export const createLighterProvider = (
       const sdkOwnsToken =
         opts?.lighterAuthToken === undefined && authTokenSource === undefined
       const apiKey = sdkOwnsToken ? await keyStore.get(params.address) : null
-      const token = await resolveAuthToken(
+      const token = await requireAuthToken(
+        'portfolio history read',
         opts,
         params.address,
         apiKey ?? undefined
       )
-      if (token === undefined) {
-        return { range: params.range, points: [] }
-      }
 
       const client = apiClient(opts)
       const account = await plugin.getAccount({ address: params.address }, opts)
@@ -1603,14 +1608,11 @@ export const createLighterProvider = (
       params: ProviderGetActivityParams,
       opts?: SDKRequestOptions
     ): Promise<ActivitiesResponse> {
-      const token = await resolveAuthToken(opts, params.address)
-      if (token === undefined) {
-        return {
-          provider: providerKey,
-          items: [],
-          pagination: { limit: params.limit ?? 0, hasMore: false },
-        }
-      }
+      const token = await requireAuthToken(
+        'activity read',
+        opts,
+        params.address
+      )
 
       const inputCursor = decodeActivityCursor(params.cursor)
       const client = apiClient(opts)

package/src/websocket/LighterWsProvider.ts

@@ -293,15 +293,6 @@ export class LighterWsProvider extends WsProviderBase<SubState> {
 
     const wireChannels = await this.resolveChannel(sub)
 
-    // Reject before any wire sub registers: a registered sub whose token can
-    // never be resolved is retried on every reopen without the caller ever
-    // seeing the failure.
-    for (const { channel, needsAuth, address } of wireChannels) {
-      if (needsAuth) {
-        await this.requireAuthToken(channel, address)
-      }
-    }
-
     // Acquired before the wire subs register, so a rejected spot-mark open
     // leaves no `user_stats`/`account_all` entry behind for the next replay.
     const releaseSpotMarks =
@@ -392,8 +383,9 @@ export class LighterWsProvider extends WsProviderBase<SubState> {
    * The auth token a gated channel's subscribe frame carries, or a throw when
    * no resolver is wired or the resolver yields none. Shared by the
    * subscribe-time guard and the per-send resolve so both report one message.
-   * Throws {@link PerpsError} with `Unauthorized` so a caller branches on the
-   * code, as it does for the Ondo and Lighter REST auth failures.
+   * Throws {@link PerpsError}: `SetupRequired` when the resolver yields no
+   * token, the code the REST reads throw for the same missing credential, and
+   * `SDKError` when no resolver is wired, which no account setup can fix.
    */
   private async requireAuthToken(
     channel: string,
@@ -402,7 +394,7 @@ export class LighterWsProvider extends WsProviderBase<SubState> {
     const resolve = this.authTokenResolver()
     if (!resolve || !address) {
       throw new PerpsError(
-        PerpsErrorCode.Unauthorized,
+        PerpsErrorCode.SDKError,
         `Lighter WS channel '${channel}' requires authentication but no auth-token resolver was available. ` +
           'Register `lighterProvider()` on the same client, or pass `resolveAuthToken` to `lighterWsProvider`.'
       )
@@ -410,7 +402,7 @@ export class LighterWsProvider extends WsProviderBase<SubState> {
     const token = await resolve(address)
     if (!token) {
       throw new PerpsError(
-        PerpsErrorCode.Unauthorized,
+        PerpsErrorCode.SetupRequired,
         `Lighter WS channel '${channel}' requires authentication but no token was available for ${address}.`
       )
     }
@@ -534,13 +526,18 @@ export class LighterWsProvider extends WsProviderBase<SubState> {
       sub.channel === 'fills' ||
       sub.channel === 'positions'
     ) {
-      const accountIndex = await this.resolveAccountIndex(sub.address)
       const lighterChannel = LIGHTER_AUTH_CHANNEL[sub.channel]
       // `account_all_trades` is publicly readable per the Lighter WS spec —
       // an auth token only filters events to the user's own account, which
       // we don't currently use to scope further. Skip the token here so a
       // user without a registered API key still gets their fill stream.
       const needsAuth = sub.channel !== 'fills'
+      // Before the account lookup and before registration: a registered sub
+      // with no token would fail on every reopen without the caller seeing it.
+      if (needsAuth) {
+        await this.requireAuthToken(lighterChannel, sub.address)
+      }
+      const accountIndex = await this.resolveAccountIndex(sub.address)
       return [
         {
           channel: `${lighterChannel}/${accountIndex}`,