@lifi/perps-sdk-provider-lighter 29.1.1 → 30.0.0

package/src/accountConfig.ts

@@ -1,8 +1,8 @@
-import { PerpsError } from '@lifi/perps-sdk'
+import { isSetupOptionFor, PerpsError } from '@lifi/perps-sdk'
 import type {
   AccountConfigSetting,
   LighterAccountConfig,
-  ProviderAction,
+  SetupAction,
 } from '@lifi/perps-types'
 import { ActionType, PerpsErrorCode } from '@lifi/perps-types'
 import {
@@ -16,8 +16,8 @@ function assertNever(value: never): never {
   )
 }
 
-// Wire strings match the backend descriptor's ParamOption values. An unmapped
-// int projects to null.
+// Wire strings match the modes the backend's ACCOUNT_MODE options bind. An
+// unmapped int projects to null.
 const ACCOUNT_MODE_INT_TO_WIRE: Readonly<Record<number, string>> = {
   [LT_ACCOUNT_TRADING_MODE_SIMPLE]: 'simpleTradingAccount',
   [LT_ACCOUNT_TRADING_MODE_UNIFIED]: 'unifiedTradingAccount',
@@ -25,28 +25,32 @@ const ACCOUNT_MODE_INT_TO_WIRE: Readonly<Record<number, string>> = {
 
 /**
  * Resolve the account tier to the wire string `changeAccountTier` accepts.
- * `userTierName` decides it, but only when the descriptor enumerates the
- * string: Lighter owns that vocabulary, so an unrecognised value projects
- * `null` instead of a mis-reported tier. A descriptor whose parameter carries
- * no `values` array enumerates nothing, so it also projects `null`. The
- * unauthenticated read reaches no `/accountLimits` and so carries no tier
- * string, which projects `null` as well: `config.accountType` is Lighter's
- * `SubAccountType`, not a tier, so nothing else in the config decides it.
+ * `userTierName` decides it, but only when an ACCOUNT_TYPE option binds that
+ * tier: Lighter owns that vocabulary, so an unrecognised value resolves `null`
+ * instead of a mis-reported tier. An absent `userTierName` (no
+ * `/accountLimits` read) resolves `null`.
  */
-function resolveAccountTier(
-  descriptor: ProviderAction,
-  config: LighterAccountConfig
+export function resolveAccountTier(
+  descriptor: SetupAction,
+  userTierName: string | undefined
 ): string | null {
-  const { userTierName } = config
   if (userTierName === undefined) {
     return null
   }
-  const enumerated = descriptor.params?.[0]?.values ?? []
-  return enumerated.some((option) => option.value === userTierName)
+  return boundAccountTiers(descriptor).includes(userTierName)
     ? userTierName
     : null
 }
 
+/** The tiers the ACCOUNT_TYPE step's options bind. */
+export function boundAccountTiers(descriptor: SetupAction): string[] {
+  return (descriptor.options ?? []).flatMap((option) =>
+    isSetupOptionFor(option, ActionType.ACCOUNT_TYPE)
+      ? [option.params.tier]
+      : []
+  )
+}
+
 /**
  * Project a single Lighter descriptor against the typed
  * `LighterAccountConfig` into an `AccountConfigSetting`.
@@ -60,14 +64,14 @@ function resolveAccountTier(
  * | SET_REFERRAL              | []                  (no parameters)
  * | APPROVE_INTEGRATOR        | []                  (no parameters)
  * | ACCOUNT_MODE              | [{ name: 'mode', value: config.accountTradingMode }]
- * | ACCOUNT_TYPE              | [{ name: 'tier', value: resolveAccountTier(…) }]
+ * | ACCOUNT_TYPE              | [{ name: 'tier', value: config.userTierName ?? null }]
  *
  * The switch is exhaustive over `ActionType` so enum additions force a
  * compile error in the `default` arm. ActionTypes that are not valid on
- * `Provider.setup` / `Provider.options` throw at runtime.
+ * `Provider.setup` throw at runtime.
  */
 function projectLighterDescriptor(
-  descriptor: ProviderAction,
+  descriptor: SetupAction,
   config: LighterAccountConfig
 ): AccountConfigSetting {
   switch (descriptor.type) {
@@ -106,28 +110,29 @@ function projectLighterDescriptor(
     case ActionType.APPROVE_INTEGRATOR:
       return { type: descriptor.type, values: [] }
 
-    // `mode` decodes the raw `account_trading_mode` integer to the descriptor's
-    // wire strings (`unifiedTradingAccount` / `simpleTradingAccount`).
+    // `mode` decodes the raw `account_trading_mode` integer to the wire strings
+    // the options bind (`unifiedTradingAccount` / `simpleTradingAccount`).
     // Unrecognised integers project to `null`.
-    case ActionType.ACCOUNT_MODE:
+    case ActionType.ACCOUNT_MODE: {
+      const mode = ACCOUNT_MODE_INT_TO_WIRE[config.accountTradingMode] ?? null
       return {
         type: descriptor.type,
-        values: [
-          {
-            name: 'mode',
-            value: ACCOUNT_MODE_INT_TO_WIRE[config.accountTradingMode] ?? null,
-          },
-        ],
+        values: [{ name: 'mode', value: mode }],
+        satisfied: (descriptor.options ?? []).some(
+          (option) =>
+            isSetupOptionFor(option, ActionType.ACCOUNT_MODE) &&
+            option.params.mode === mode
+        ),
       }
+    }
 
-    // An unresolved `tier` projects to `null` (surfaces as "tier not
-    // detected" — the widget still lets the user pick a value).
+    // `tier` carries the venue's raw tier name even when no option binds it;
+    // only a bound tier reads satisfied.
     case ActionType.ACCOUNT_TYPE:
       return {
         type: descriptor.type,
-        values: [
-          { name: 'tier', value: resolveAccountTier(descriptor, config) },
-        ],
+        values: [{ name: 'tier', value: config.userTierName ?? null }],
+        satisfied: resolveAccountTier(descriptor, config.userTierName) !== null,
       }
 
     case ActionType.APPROVE_AGENT:
@@ -155,11 +160,14 @@ function projectLighterDescriptor(
     case ActionType.META_ONBOARD:
     case ActionType.META_CREATE_REFERRAL_CODE:
     case ActionType.SYNC_FEE_ATTRIBUTION:
+    case ActionType.REVOKE_BUILDER_FEE:
+    case ActionType.REVOKE_SESSION_AGENT:
+    case ActionType.REVOKE_INTEGRATOR:
       throw new PerpsError(
         PerpsErrorCode.SDKError,
         `Lighter account-config mapper has no projection for ` +
           `descriptor type '${descriptor.type}' — this ActionType is not ` +
-          `valid on Provider.setup / Provider.options for Lighter.`
+          `valid on Provider.setup for Lighter.`
       )
 
     default:
@@ -168,22 +176,15 @@ function projectLighterDescriptor(
 }
 
 /**
- * Project the union of Lighter setup + options descriptors against the typed
+ * Project the Lighter setup descriptors against the typed
  * `LighterAccountConfig`. Produces exactly one `AccountConfigSetting` per
- * descriptor, in `setup`-then-`options` order (preserving the order in which
- * the backend emits them).
+ * descriptor, preserving the order in which the backend emits them.
  *
- * @param config Typed account state for the Lighter account.
- * @param setup  `Provider.setup` array as emitted by `/providers`.
- * @param options `Provider.options` array as emitted by `/providers`.
  * @public
  */
 export function projectLighterConfigSettings(
   config: LighterAccountConfig,
-  setup: ProviderAction[],
-  options: ProviderAction[]
+  setup: SetupAction[]
 ): AccountConfigSetting[] {
-  return [...setup, ...options].map((descriptor) =>
-    projectLighterDescriptor(descriptor, config)
-  )
+  return setup.map((descriptor) => projectLighterDescriptor(descriptor, config))
 }

package/src/signers/LighterSigner.ts

@@ -214,12 +214,45 @@ export class LighterSigner {
           'required L1 user wallet signature.'
       )
     }
+    if (action === ActionType.REVOKE_INTEGRATOR) {
+      return this.signRevokeIntegrator(wasmSignParams, context)
+    }
     const wasm = await this.ensureLoaded()
     await this.ensureClient(context)
     const result = this.dispatch(wasm, action, wasmSignParams, context)
     return unwrap(result, action)
   }
 
+  private async signRevokeIntegrator(
+    p: Record<string, unknown>,
+    ctx: LighterSignerContext
+  ): Promise<LighterSignedBlob> {
+    const integratorAccountIndex = numberField(p, 'integrator_account_index')
+    const maxPerpsTakerFee = revokeIntegratorZeroField(p, 'max_perps_taker_fee')
+    const maxPerpsMakerFee = revokeIntegratorZeroField(p, 'max_perps_maker_fee')
+    const maxSpotTakerFee = revokeIntegratorZeroField(p, 'max_spot_taker_fee')
+    const maxSpotMakerFee = revokeIntegratorZeroField(p, 'max_spot_maker_fee')
+    const approvalExpiry = revokeIntegratorZeroField(p, 'approval_expiry')
+    const nonce = numberField(p, 'nonce')
+    const wasm = await this.ensureLoaded()
+    await this.ensureClient(ctx)
+    return unwrap(
+      wasm.SignApproveIntegrator(
+        integratorAccountIndex,
+        maxPerpsTakerFee,
+        maxPerpsMakerFee,
+        maxSpotTakerFee,
+        maxSpotMakerFee,
+        approvalExpiry,
+        SKIP_NONCE_DISABLED,
+        nonce,
+        ctx.apiKeyIndex,
+        ctx.accountIndex
+      ),
+      ActionType.REVOKE_INTEGRATOR
+    )
+  }
+
   /**
    * Step 1 of the REGISTER_API_KEY flow. Generates the WASM blob for a
    * ChangePubKey tx with `L1Sig` left empty, plus the canonical EIP-191
@@ -738,6 +771,20 @@ function numberField(p: Record<string, unknown>, key: string): number {
   )
 }
 
+function revokeIntegratorZeroField(
+  p: Record<string, unknown>,
+  key: string
+): number {
+  const value = numberField(p, key)
+  if (value !== 0) {
+    throw new PerpsError(
+      PerpsErrorCode.ValidationError,
+      `Lighter REVOKE_INTEGRATOR requires '${key}' to be zero`
+    )
+  }
+  return value
+}
+
 function optionalNumberField(
   p: Record<string, unknown>,
   key: string,

package/src/signers/signActions.ts

@@ -17,6 +17,7 @@ import {
 } from '../constants.js'
 import type { ApiParams, LighterApiClient } from '../utils/apiClient.js'
 import { fetchAppliedReferralCode } from '../utils/appliedReferralCode.js'
+import { lighterErrorCodeFromBody } from '../utils/lighterErrorCode.js'
 import {
   fetchRegisteredApiKey,
   type LighterRegisteredApiKey,
@@ -472,7 +473,8 @@ async function signTransfer(
  * skips the POST when the account carries one, and a
  * {@link LIGHTER_REFERRAL_ALREADY_USED_CODE} verdict from the POST settles the
  * step the same way. Every other non-success verdict surfaces Lighter's
- * `code`/`message` verbatim as an {@link PerpsErrorCode.ExchangeRejected}.
+ * `code`/`message` verbatim, under the `PerpsErrorCode` the body code names
+ * ({@link lighterErrorCodeFromBody}) or {@link PerpsErrorCode.ExchangeRejected}.
  */
 async function executeTokenAuthMutation(
   deps: LighterSignActionsDeps,
@@ -517,7 +519,7 @@ async function executeTokenAuthMutation(
   ) {
     const suffix = data?.message ? `: ${data.message}` : ''
     throw new PerpsError(
-      PerpsErrorCode.ExchangeRejected,
+      lighterErrorCodeFromBody(code) ?? PerpsErrorCode.ExchangeRejected,
       `Lighter ${step.action} rejected (code ${code ?? status})${suffix}`
     )
   }

package/src/utils/lighterErrorCode.ts

@@ -16,6 +16,8 @@ const LIGHTER_BODY_ERROR_CODES: ReadonlyMap<number, PerpsErrorCode> = new Map([
   [21507, PerpsErrorCode.InsufficientMargin],
   // account is below initial margin
   [21508, PerpsErrorCode.InsufficientMargin],
+  // account is not eligible for this operation
+  [21520, PerpsErrorCode.SetupRequired],
   // not enough margin to create the order
   [21739, PerpsErrorCode.InsufficientMargin],
 ])