@lifi/perps-sdk-provider-lighter 0.2.0-alpha.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright LI.FI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,176 @@
+# `@lifi/perps-sdk-provider-lighter`
+
+Lighter provider plugin for [`@lifi/perps-sdk`](../../README.md). Registers a `PerpsProviderPlugin` that routes Lighter reads directly to the Lighter REST API (no LI.FI backend hop per read), and handles all Lighter signing via a bundled Go WASM signer.
+
+> **`marketId` is numeric.** Lighter's `Market.id` is a numeric string (`"0"`, `"1"`, …). Never pass a display string such as `"LIT/USDC"` where a `marketId` is expected — it will silently produce `NaN` and requests will fail.
+
+## Installation
+
+```bash
+pnpm add @lifi/perps-sdk @lifi/perps-sdk-provider-lighter
+# or
+npm install @lifi/perps-sdk @lifi/perps-sdk-provider-lighter
+```
+
+## Registration
+
+```ts
+import { createPerpsClient, localStorageAdapter } from '@lifi/perps-sdk'
+import {
+  LighterKeyStore,
+  LighterSigner,
+  lighterProvider,
+} from '@lifi/perps-sdk-provider-lighter'
+
+const client = createPerpsClient({
+  integrator: 'my-app',
+  apiKey: 'your-lifi-api-key',
+  providers: [
+    lighterProvider({
+      signer: new LighterSigner(),
+      keyStore: new LighterKeyStore(localStorageAdapter),
+      readOnlyTokenOptions: { storage: localStorageAdapter },
+    }),
+  ],
+})
+```
+
+### Loading WASM in a Vite/browser project
+
+The `LighterSigner` bundles `lighter-signer.wasm` and `wasm_exec.js` alongside its `dist/`. In a Vite project you must import these assets so Vite serves them correctly — otherwise the IIFE that installs `globalThis.Go` may be transformed and break:
+
+```ts
+import lighterWasmUrl from '@lifi/perps-sdk-provider-lighter/wasm/lighter-signer.wasm?url'
+import lighterWasmExecSource from '@lifi/perps-sdk-provider-lighter/wasm/wasm_exec.js?raw'
+
+const signer = new LighterSigner({
+  wasmBinaryUrl: lighterWasmUrl,
+  wasmExecJsSource: lighterWasmExecSource,
+})
+```
+
+In Node.js the default asset paths resolve correctly from `dist/` without any overrides.
+
+## Token model
+
+Lighter uses two distinct bearer tokens for different purposes. Both flow through `LighterProviderOptions` and are managed automatically once `signer` and `keyStore` are configured.
+
+### Standard auth token
+
+- **Created by:** the WASM signer (`LighterSigner.createAuthToken`), signed with the user's registered Lighter API key — no wallet popup.
+- **Lifetime:** up to 8 hours (Lighter's hard cap). The SDK defaults to 1-hour tokens and re-creates one when the remaining life falls below 60 seconds.
+- **Used for:** authenticated writes (via `signActions`) and as the credential that authorises read-only token creation on first use.
+
+### Read-only token
+
+- **Created at:** first authenticated read after setup, via Lighter's `POST /api/v1/tokens/create`, authorised by a standard auth token.
+- **Lifetime:** up to 10 years (Lighter's maximum). The SDK requests this maximum so the token covers the account's lifetime. One warning: `LighterReadOnlyTokenManager.isReadOnlyTokenExpiringSoon` can alert the consumer when fewer than 30 days remain.
+- **Used for:** all authenticated reads (`getOrders`, `getOrder`, `getActivity`, `getAccount` fee tier, etc.) that go directly to the Lighter API — no LI.FI backend hop.
+- **Scope:** `all` (reads across all sub-accounts of the owner).
+- **Stored by:** `LighterReadOnlyTokenManager`, keyed on `(l1Address, accountIndex)`, using the `StorageAdapter` passed in `readOnlyTokenOptions.storage`.
+
+Per-user reads go **direct to the Lighter API** (not through the LI.FI backend). The backend is involved only in the create/execute action pipeline for writes.
+
+### Token resolution order for authenticated reads
+
+When a read requires authentication the provider tries these sources in order and uses the first that produces a token:
+
+1. Per-call `options.lighterAuthToken`
+2. Constructor `authToken` string or factory
+3. Stored read-only token (from `LighterReadOnlyTokenManager`)
+4. Freshly created read-only token (authorised by a standard token created from the registered API key)
+5. Standard auth token (fallback if read-only token creation fails)
+
+When no source produces a token, `getOrders` and `getActivity` return empty results, `getOrder` throws `Unauthorized`, and `getAccount` returns a zero fee tier.
+
+## One-time setup flow
+
+Before trading, the user's Ethereum address must be registered on Lighter's L2 with a Lighter-native API keypair. The `PerpsClient.checkSetup` / `PerpsClient.executeSetup` flow handles this. The Lighter-specific steps are:
+
+1. **`REGISTER_API_KEY`** — the WASM signer generates a fresh Lighter keypair (`GenerateAPIKey`), produces a `ChangePubKey` transaction blob, and requests an EIP-191 `signMessage` from the user's L1 wallet (one wallet popup, first time only). The L1 signature is embedded into the blob and submitted. The keypair is then persisted in `LighterKeyStore`.
+
+2. Subsequent write operations (place order, cancel, modify, withdraw, etc.) are signed with the stored API key via the WASM signer — no further wallet popups.
+
+For the generic `checkSetup → executeSetup` lifecycle, see the [root README](../../README.md).
+
+```mermaid
+sequenceDiagram
+    participant App
+    participant PC as PerpsClient
+    participant KS as LighterKeyStore
+    participant WS as WASM signer
+    participant BE as LI.FI backend
+    participant LX as Lighter API
+
+    Note over App,LX: one-time setup
+    App->>PC: executeSetup (REGISTER_API_KEY)
+    PC->>WS: generateAPIKey → keypair
+    PC->>WS: signChangePubKey → blob + EIP-191 message
+    PC->>App: wallet.signMessage (one popup)
+    PC->>BE: executeAction (blob + L1 sig)
+    BE->>LX: sendTx (ChangePubKey)
+    PC->>KS: persist API keypair
+
+    Note over App,LX: steady state — place order
+    App->>PC: placeOrder(...)
+    PC->>BE: createAction
+    BE-->>PC: WasmBlobActionStep
+    PC->>WS: sign with API key (no popup)
+    PC->>BE: executeAction (signed blob)
+
+    Note over App,LX: steady state — read positions
+    App->>PC: getPositions(...)
+    PC->>LX: GET /api/v1/account (read-only token)
+    LX-->>PC: positions data
+```
+
+## WASM signer
+
+The package bundles two assets under `wasm/`:
+
+- `lighter-signer.wasm` — the Go WASM binary that signs Lighter transactions and creates auth tokens.
+- `wasm_exec.js` — Go's runtime shim that installs the `globalThis.Go` class and registers polyfills.
+
+The WASM provides: key generation (`GenerateAPIKey`), API-key client registration (`CreateClient`), auth-token creation (`CreateAuthToken`), and all transaction signing operations (`SignCreateOrder`, `SignCancelOrder`, `SignModifyOrder`, `SignWithdraw`, `SignTransfer`, `SignUpdateLeverage`, `SignUpdateMargin`, `SignChangePubKey`).
+
+`loadLighterWasm` is memoized per process — the Go runtime starts a long-running goroutine on first load and is never stopped.
+
+`LighterSigner` calls `loadLighterWasm` automatically on first use; you do not need to call `initialize()` explicitly.
+
+## Storage
+
+`LighterKeyStore` persists the user's Lighter API keypair (private key, public key, `accountIndex`, `apiKeyIndex`) under the key `lifi-perps-lighter-key:<address>`.
+
+`LighterReadOnlyTokenManager` persists the read-only token under `lifi:perps:lighter:rotoken:<address>:<accountIndex>`.
+
+Both accept any `StorageAdapter` — an interface from `@lifi/perps-sdk` with `get`, `set`, and `remove` methods. The SDK ships `localStorageAdapter` for browsers. Pass a custom adapter for server-side or React Native environments.
+
+**Recovery when storage is lost:** re-run `executeSetup`. For `REGISTER_API_KEY` specifically — the backend checks whether the public key you hold matches the one registered on-chain. If storage was wiped but the on-chain slot matches a freshly generated key, setup re-completes transparently. No funds are at risk; the API keypair authorises signing only, not asset custody.
+
+## Multi-account
+
+Lighter uses a numeric `accountIndex` (looked up once from the user's L1 Ethereum address via Lighter's REST) and an `apiKeyIndex` for the API key slot. The SDK uses `accountIndex` 0-based (the primary account) and defaults to `apiKeyIndex` 42 (`DEFAULT_API_KEY_INDEX`), chosen to avoid colliding with Lighter's reserved desktop/mobile slots (0–3).
+
+The SDK exposes `accountIndex` and `apiKeyIndex` as fields on `LighterApiKey` (what `LighterKeyStore` stores) and on `LighterAccountConfig` (what `getAccount` returns under `AccountResponse.config`). Sub-account switching is not directly supported beyond this — the SDK operates on the primary account for a given L1 address.
+
+## Exported surface
+
+The main exports from `@lifi/perps-sdk-provider-lighter`:
+
+| Export | Kind | Purpose |
+|---|---|---|
+| `lighterProvider` / `Lighter` | factory | Creates the `LighterPerpsProvider` plugin for `createPerpsClient` |
+| `LighterSigner` | class | WASM-backed signer for key generation, signing, and auth-token creation |
+| `LighterKeyStore` | class | Persists the user's Lighter API keypair |
+| `LighterReadOnlyTokenManager` | class | Creates and persists the long-lived read-only bearer token |
+| `createAuthToken` | function | Creates a fresh standard auth token from an API key + signer |
+| `isReadOnlyTokenExpiringSoon` | function | Returns `true` when the stored read-only token expires within a threshold |
+| `loadLighterWasm` | function | Loads the WASM binary (memoized) |
+| `LighterWsProvider` / `lighterWsProvider` | class / factory | Realtime WebSocket provider (orderbook, prices, orders, fills, positions) |
+| `LighterPerpsProvider` | interface | Extended `PerpsProviderPlugin` with `resolveAuthToken` — used by the WS layer |
+| `LighterProviderOptions` | interface | Constructor options for `lighterProvider(...)` |
+| `LighterApiKey` | interface | Shape stored by `LighterKeyStore` |
+| `LighterReadOnlyToken` | interface | Shape stored by `LighterReadOnlyTokenManager` |
+| `DEFAULT_API_KEY_INDEX` | constant | `42` — the LI.FI-assigned API key slot |
+| `DEFAULT_LIGHTER_REST_URL` | constant | Lighter mainnet REST base URL |
+| `LIGHTER_PROVIDER_KEY` | constant | `"lighter"` — the provider key used on `Market.categoryId` |

package/dist/cjs/LighterProvider.d.ts

@@ -0,0 +1,20 @@
+import { type PerpsProviderPlugin } from '@lifi/perps-sdk';
+import type { Address } from 'viem';
+import type { LighterKeyStore } from './signers/LighterKeyStore.js';
+import type { LighterReadOnlyTokenManagerOptions } from './signers/LighterReadOnlyTokenManager.js';
+import type { LighterSigner } from './signers/LighterSigner.js';
+export interface LighterProviderOptions {
+    restUrl?: string;
+    authToken?: string | (() => string | Promise<string>);
+    signer?: LighterSigner;
+    keyStore?: LighterKeyStore;
+    readOnlyTokenOptions?: LighterReadOnlyTokenManagerOptions;
+    tokenLifetimeSeconds?: number;
+    tokenRenewBufferSeconds?: number;
+}
+export interface LighterPerpsProvider extends PerpsProviderPlugin {
+    resolveAuthToken(address: Address): Promise<string | undefined>;
+}
+export declare const lighterProvider: (options?: LighterProviderOptions) => LighterPerpsProvider;
+export declare const Lighter: (options?: LighterProviderOptions) => LighterPerpsProvider;
+//# sourceMappingURL=LighterProvider.d.ts.map

package/dist/cjs/LighterProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LighterProvider.d.ts","sourceRoot":"","sources":["../../src/LighterProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,mBAAmB,EAazB,MAAM,iBAAiB,CAAA;AAsBxB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAcnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,0CAA0C,CAAA;AAElG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAoG/D,MAAM,WAAW,sBAAsB;IAErC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IAMrD,MAAM,CAAC,EAAE,aAAa,CAAA;IAKtB,QAAQ,CAAC,EAAE,eAAe,CAAA;IAQ1B,oBAAoB,CAAC,EAAE,kCAAkC,CAAA;IAEzD,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAiBD,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAO/D,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAChE;AAuBD,eAAO,MAAM,eAAe,GAC1B,UAAS,sBAA2B,KACnC,oBA25BF,CAAA;AAOD,eAAO,MAAM,OAAO,aAn6BT,sBAAsB,KAC9B,oBAk6BmC,CAAA"}