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

package/src/LighterProvider.ts

@@ -41,7 +41,7 @@ import type {
 import { ActionType, ActivityType, PerpsErrorCode } from '@lifi/perps-types'
 import type { Address } from 'viem'
 import { projectLighterConfigSettings } from './accountConfig.js'
-import { summarizeLighterAccount } from './accountSummary.js'
+import { getAccountSummary } from './accountSummary.js'
 import {
   DEFAULT_API_KEY_INDEX,
   DEFAULT_LIGHTER_REST_URL,
@@ -1071,11 +1071,11 @@ export const lighterProvider = (
       )
     },
 
-    getPortfolioSummary(
+    getAccountSummary(
       account: AccountResponse,
       positions: Position[]
     ): AccountSummary {
-      return summarizeLighterAccount(account, positions)
+      return getAccountSummary(account, positions)
     },
 
     formatOrderPrice,

package/src/accountConfig.ts

@@ -13,29 +13,11 @@ function assertNever(value: never): never {
 }
 
 /**
- * `account_type` on Lighter's `DetailedAccount` is a `StrictInt` in the
- * public OpenAPI schema (`lighter-python/lighter/models/detailed_account.py`)
- * with no documented integer ↔ name mapping in the Python or Go SDKs.
- *
- * The empirical mapping below follows the public docs' tier ordering
- * (apidocs.lighter.xyz/docs/account-types lists Standard → Premium → Plus)
- * and the Python paper client's `AccountTier` enum ordering (STANDARD
- * first, PREMIUM next). The write side of `/changeAccountTier` accepts the
- * lowercase strings `'standard' | 'premium'` — these are what the
- * descriptor's `ParamOption.value` declarations carry, so this mapping
- * round-trips cleanly with the OptionsModal selection.
- *
- * Lighter publishes a third "Plus" tier (likely integer `2`), but it is
- * not currently settable via the public API, so we deliberately do not
- * map it — a Plus account surfaces as "tier not detected" in the widget
- * rather than offering an option that would 400 on submit. Add
- * `LIGHTER_ACCOUNT_TYPE_PLUS` here (and to the backend descriptor) if
- * Lighter exposes it later.
- *
- * Each integer is a named constant so a correction (e.g. Lighter publishing
- * an authoritative table) is a one-line edit. An unmapped integer projects
- * to `null` and surfaces as "tier not detected" in the widget, so drift is
- * observable rather than silent.
+ * `account_type` on Lighter's `DetailedAccount` is a `StrictInt` with no
+ * documented integer ↔ name mapping in the public SDKs. Empirical ordering:
+ * 0 = standard, 1 = premium (from `AccountTier` enum + `/changeAccountTier`
+ * wire strings). Plus tier (likely `2`) is omitted — an unmapped int projects
+ * to null and surfaces as "tier not detected", so drift is observable.
  */
 const LIGHTER_ACCOUNT_TYPE_STANDARD = 0
 const LIGHTER_ACCOUNT_TYPE_PREMIUM = 1

package/src/accountSummary.ts

@@ -14,7 +14,7 @@ import type {
  *
  * @public
  */
-export function summarizeLighterAccount(
+export function getAccountSummary(
   account: AccountResponse,
   positions: Position[]
 ): AccountSummary {

package/src/index.ts

@@ -14,7 +14,7 @@
  */
 
 export { projectLighterConfigSettings } from './accountConfig.js'
-export { summarizeLighterAccount } from './accountSummary.js'
+export { getAccountSummary } from './accountSummary.js'
 export {
   DEFAULT_API_KEY_INDEX,
   DEFAULT_LIGHTER_REST_URL,

package/src/signers/signActions.ts

@@ -10,6 +10,7 @@ import type {
 import { ActionType, PerpsErrorCode, SigningMethod } from '@lifi/perps-types'
 import type { Address } from 'viem'
 import { parseAbi } from 'viem'
+import { waitForTransactionReceipt } from 'viem/actions'
 import { DEFAULT_API_KEY_INDEX } from '../constants.js'
 import type { LighterApiKey, LighterKeyStore } from './LighterKeyStore.js'
 import type { LighterSigner } from './LighterSigner.js'
@@ -225,10 +226,11 @@ async function requireApiKey(
 
 /**
  * Sign and broadcast a sequence of `EVM_TX` actions via the user's wallet
- * client. Steps are submitted serially so a later step (e.g. deposit) can
- * rely on an earlier step (e.g. approve) having mined. Each step's
- * `txParams` carries chainId, target, function name, args, and a
- * human-readable abi from the backend.
+ * client. Each leg is broadcast then confirmed to a successful receipt before
+ * the next is broadcast, so a later step (e.g. deposit) can rely on an earlier
+ * step (e.g. approve) having mined. A reverted leg throws and aborts the
+ * remaining legs. Each step's `txParams` carries chainId, target, function
+ * name, args, and a human-readable abi from the backend.
  * @internal
  */
 export async function signEvmTxActions(
@@ -263,6 +265,17 @@ export async function signEvmTxActions(
       account: walletSigner.account,
     })
 
+    const receipt = await waitForTransactionReceipt(walletSigner, {
+      hash: txHash,
+    })
+    if (receipt.status === 'reverted') {
+      throw new PerpsError(
+        PerpsErrorCode.SDKError,
+        `EVM_TX leg '${step.action}' reverted (tx ${txHash}); aborting the ` +
+          'remaining legs.'
+      )
+    }
+
     signed.push({
       action: step.action,
       txParams: step.txParams,

package/src/signers/wasmLoader.ts

@@ -60,6 +60,10 @@ export interface LoadLighterWasmOptions {
    * URL on serve, breaking the IIFE that installs `globalThis.Go`. Pass via
    * a `?raw` import (Vite) or equivalent so the original source survives
    * intact.
+   *
+   * @security This string is evaluated via `new Function(...)`. The caller is
+   * responsible for ensuring it originates from the bundled `wasm_exec.js`;
+   * attacker-controlled content would execute arbitrary code in the host.
    */
   wasmExecJsSource?: string
 }
@@ -105,13 +109,41 @@ export interface LighterWasmExports {
     apiKeyIndex: number,
     accountIndex: number
   ) => SignResult & { messageToSign?: string }
+  /**
+   * Go WASM exports take positional primitives, so TS cannot type the
+   * arguments — `WASM_FUNCTION_NAMES` only validates that each function
+   * *exists* at load time, never its arity or order. A `.wasm` bump that
+   * shifts or adds an argument therefore compiles, passes the existence
+   * check, and only fails at runtime (Lighter code 20001 "invalid param").
+   * The expected positional contract below is the authority; it MUST stay in
+   * sync with the call site in `LighterSigner.dispatch`. All sign exports end
+   * with `(nonce, apiKeyIndex, accountIndex)`.
+   *
+   * 13 args: marketIndex, clientOrderIndex, baseAmount, price, isAsk,
+   * orderType, timeInForce, reduceOnly, triggerPrice, orderExpiry, then the
+   * trailing three.
+   */
   SignCreateOrder: (...args: unknown[]) => SignResult
+  /** 5 args: marketIndex, orderIndex, then the trailing three. */
   SignCancelOrder: (...args: unknown[]) => SignResult
+  /** 5 args: timeInForce, timestampMs, then the trailing three. */
   SignCancelAllOrders: (...args: unknown[]) => SignResult
+  /**
+   * 7 args: toAccount, usdcAmount, fee, memo, then the trailing three. `memo`
+   * is copied into a Go `[32]byte`, so its UTF-8 byte length must be exactly
+   * 32 or Go rejects it before signing.
+   */
   SignTransfer: (...args: unknown[]) => SignResult
+  /** 4 args: amount, then the trailing three. */
   SignWithdraw: (...args: unknown[]) => SignResult
+  /** 6 args: marketIndex, fraction, marginMode, then the trailing three. */
   SignUpdateLeverage: (...args: unknown[]) => SignResult
+  /**
+   * 8 args: marketIndex, orderIndex, baseAmount, price, triggerPrice, then the
+   * trailing three.
+   */
   SignModifyOrder: (...args: unknown[]) => SignResult
+  /** 6 args: marketIndex, usdcAmount, direction, then the trailing three. */
   SignUpdateMargin: (...args: unknown[]) => SignResult
 }
 
@@ -242,8 +274,9 @@ async function loadWasmUncached(
   ])
 
   // wasm_exec.js is an IIFE that installs `globalThis.Go = class { ... }` plus
-  // fs/process/crypto polyfills. Evaluate it in a Function scope so the class
-  // attaches to globalThis and we read it back from there.
+  // fs/process/crypto polyfills. Evaluating it is required to attach the class;
+  // Go ships no fork-free alternative. The trust boundary is the caller-supplied
+  // source — see the `@security` note on `LoadLighterWasmOptions.wasmExecJsSource`.
   const installGo = new Function(`${wasmExecSource}; return globalThis.Go`)
   const Go = installGo() as GoClass