@lifi/perps-sdk-provider-lighter 13.0.2 → 15.0.0

package/src/LighterProvider.ts

@@ -60,7 +60,6 @@ import type { Address } from 'viem'
 import { projectLighterConfigSettings } from './accountConfig.js'
 import { getAccountSummary } from './accountSummary.js'
 import {
-  DEFAULT_API_KEY_INDEX,
   DEFAULT_TRADES_LIMIT,
   LIGHTER_ALL_MARKETS_WILDCARD,
   LIGHTER_BASE_FEE_TIER,
@@ -706,6 +705,9 @@ export const createLighterProvider = (
       // Shared promise: the referral read below awaits this instance's runtime
       // metadata off the same `/providers` fetch — no second request.
       const providersPromise = getProviders(requireClient())
+      // Shared promise: the registered-key read names the slot off the local
+      // record, and the config readout reports the record — one storage read.
+      const localKeyPromise = keyStore.get(params.address)
       const [
         { providers },
         ,
@@ -719,7 +721,13 @@ export const createLighterProvider = (
         providersPromise,
         registry.sync(),
         assetRegistry.sync(),
-        fetchRegisteredApiKey(client, account.index, DEFAULT_API_KEY_INDEX),
+        // The local record names the only slot worth reading: no record means
+        // nothing to compare the registered key against, so the read is skipped.
+        localKeyPromise.then((key) =>
+          key === null
+            ? undefined
+            : fetchRegisteredApiKey(client, account.index, key.apiKeyIndex)
+        ),
         // No token is a legitimate unauthenticated read → undefined → zero fee
         // tier. A generic fetch error is NOT: it must propagate, never be
         // coerced to a fabricated 0%/0% fee tier. One carve-out: a token the
@@ -734,7 +742,7 @@ export const createLighterProvider = (
                 fetchAccountLimits(client, account.index, t)
               )
             ),
-        keyStore.get(params.address),
+        localKeyPromise,
         readOnlyTokenManager.get(params.address, account.index),
         // The expected code is backend-owned runtime metadata on this
         // instance's own provider descriptor (keyed by `providerKey`, so the
@@ -842,7 +850,7 @@ export const createLighterProvider = (
       const config: LighterAccountConfig = {
         provider: providerKey,
         accountIndex: account.index,
-        apiKeyIndex: DEFAULT_API_KEY_INDEX,
+        apiKeyIndex: localKey?.apiKeyIndex,
         apiKeyRegistered,
         accountType: account.account_type,
         accountTradingMode: account.account_trading_mode,

package/src/constants.ts

@@ -208,17 +208,6 @@ export const LIGHTER_ALL_MARKETS_WILDCARD = 255
  */
 export const LIGHTER_HISTORY_PAGE_SIZE = 100
 
-/**
- * Default API key slot — reused per account. Lighter's docs reserve indexes
- * `{0,1,2,3}` for its own desktop/mobile interfaces; user keys start at 4
- * (max 254, with 255 reserved as `NilApiKeyIndex`). 42 is the LI.FI-wide
- * identifier so a user running both the Lighter app and the widget never
- * collides with the app's session key.
- *
- * @public
- */
-export const DEFAULT_API_KEY_INDEX = 42
-
 /** @internal */
 const LIGHTER_CODE_ACCOUNT_NOT_FOUND = 21100
 

package/src/index.ts

@@ -20,7 +20,6 @@ export type {
   LighterDeployment,
 } from './constants.js'
 export {
-  DEFAULT_API_KEY_INDEX,
   DEFAULT_LIGHTER_EXPLORER_TX_BASE_URL,
   DEFAULT_LIGHTER_REST_URL,
   DEFAULT_LIGHTER_WS_URL,

package/src/signers/LighterKeyStore.ts

@@ -21,7 +21,7 @@ const STORAGE_PREFIX = 'lifi-perps-lighter-key'
 export interface LighterApiKey {
   /** Lighter account index, looked up once via accountsByL1Address. */
   accountIndex: number
-  /** API key slot (0-255). Defaults to {@link DEFAULT_API_KEY_INDEX}. */
+  /** API key slot (0-255), as named by the backend registration payload. */
   apiKeyIndex: number
   /** Lighter-native private key (0x-prefixed hex). */
   apiKeyPrivateKey: string

package/src/signers/signActions.ts

@@ -11,10 +11,7 @@ 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,
-  LIGHTER_MUTATION_SUCCESS_CODE,
-} from '../constants.js'
+import { LIGHTER_MUTATION_SUCCESS_CODE } from '../constants.js'
 import type { ApiParams, LighterApiClient } from '../utils/apiClient.js'
 import {
   fetchRegisteredApiKey,
@@ -260,7 +257,13 @@ async function signRegisterApiKey(
     nonce?: number
     skip_nonce?: 0 | 1
   }
-  const apiKeyIndex = params.api_key_index ?? DEFAULT_API_KEY_INDEX
+  const apiKeyIndex = params.api_key_index
+  if (typeof apiKeyIndex !== 'number') {
+    throw new PerpsError(
+      PerpsErrorCode.SDKError,
+      'REGISTER_API_KEY wasmSignParams is missing `api_key_index`.'
+    )
+  }
   const nonce = params.nonce
   if (typeof nonce !== 'number') {
     throw new PerpsError(

package/src/types/account.ts

@@ -26,6 +26,11 @@ export type LtAccountPosition = {
   unrealized_pnl: string
   realized_pnl: string
   liquidation_price: string
+  /**
+   * Funding accrued since the position opened, signed from the account's point
+   * of view despite the field name: negative is funding the account paid and
+   * positive is funding it received. Lighter resets it to `"0"` on close.
+   */
   total_funding_paid_out: string
   margin_mode: number
   allocated_margin: string

package/src/utils/mapPosition.ts

@@ -60,6 +60,7 @@ export const mapPosition = (
         : positionValue.div(size.abs()).toFixed(),
     liquidationPrice: pos.liquidation_price,
     unrealizedPnl: pos.unrealized_pnl,
+    accruedFunding: pos.total_funding_paid_out,
     leverage: leverageFromImf(pos.initial_margin_fraction) ?? 1,
     marginUsed,
     initialMarginRequirement: initialMarginRequirement.toFixed(),