@l.x/prices 1.0.3 → 1.0.5

package/.depcheckrc

@@ -0,0 +1,14 @@
+ignores: [
+    # Dependencies that depcheck incorrectly marks as unused
+    "typescript",
+    "@typescript/native-preview",
+    "depcheck",
+
+    # Internal packages / workspaces
+    "prices",
+    "@universe/prices",
+
+    # TODO: remove once used in tests
+    "@testing-library/react",
+    "@vitest/coverage-v8",
+  ]

package/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  extends: ['@luxamm/eslint-config/lib'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        'no-relative-import-paths/no-relative-import-paths': [
+          'error',
+          {
+            allowSameFolder: false,
+            prefix: '@luxexchange/prices',
+          },
+        ],
+      },
+    },
+  ],
+}

package/LICENSE

@@ -0,0 +1,122 @@
+Lux Ecosystem License
+Version 1.2, December 2025
+
+Copyright (c) 2020-2025 Lux Industries Inc.
+All rights reserved.
+
+TECHNOLOGY PORTFOLIO - PATENT APPLICATIONS PLANNED
+Contact: licensing@lux.network
+
+================================================================================
+                          TERMS AND CONDITIONS
+================================================================================
+
+1. DEFINITIONS
+
+   "Lux Primary Network" means the official Lux blockchain with Network ID=1
+   and EVM Chain ID=96369.
+   
+   "Authorized Network" means the Lux Primary Network, official testnets/devnets,
+   and any L1/L2/L3 chain descending from the Lux Primary Network.
+   
+   "Descending Chain" means an L1/L2/L3 chain built on, anchored to, or deriving
+   security from the Lux Primary Network or its authorized testnets.
+   
+   "Research Use" means non-commercial academic research, education, personal
+   study, or evaluation purposes.
+   
+   "Commercial Use" means any use in connection with a product or service
+   offered for sale or fee, internal use by a for-profit entity, or any use
+   to generate revenue.
+
+2. GRANT OF LICENSE
+
+   Subject to these terms, Lux Industries Inc grants you a non-exclusive,
+   royalty-free license to:
+   
+   (a) Use for Research Use without restriction;
+   
+   (b) Operate on the Lux Primary Network (Network ID=1, EVM Chain ID=96369);
+   
+   (c) Operate on official Lux testnets and devnets;
+   
+   (d) Operate L1/L2/L3 chains descending from the Lux Primary Network;
+   
+   (e) Build applications within the Lux ecosystem;
+   
+   (f) Contribute improvements back to the original repositories.
+
+3. RESTRICTIONS
+
+   Without a commercial license from Lux Industries Inc, you may NOT:
+   
+   (a) Fork the Lux Network or any Lux software;
+   
+   (b) Create competing networks not descending from Lux Primary Network;
+   
+   (c) Use for Commercial Use outside the Lux ecosystem;
+   
+   (d) Sublicense or transfer rights outside the Lux ecosystem;
+   
+   (e) Use to create competing blockchain networks, exchanges, custody
+       services, or cryptographic systems outside the Lux ecosystem.
+
+4. NO FORKS POLICY
+
+   Lux Industries Inc maintains ZERO TOLERANCE for unauthorized forks.
+   Any fork or deployment on an unauthorized network constitutes:
+   
+   (a) Breach of this license;
+   (b) Grounds for immediate legal action.
+
+5. RIGHTS RESERVATION
+
+   All rights not explicitly granted are reserved by Lux Industries Inc.
+   
+   We plan to apply for patent protection for the technology in this
+   repository. Any implementation outside the Lux ecosystem may require
+   a separate commercial license.
+
+6. DISCLAIMER OF WARRANTY
+
+   THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+7. LIMITATION OF LIABILITY
+
+   IN NO EVENT SHALL LUX INDUSTRIES INC BE LIABLE FOR ANY CLAIM, DAMAGES
+   OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE.
+
+8. TERMINATION
+
+   This license terminates immediately upon any breach, including but not
+   limited to deployment on unauthorized networks or creation of forks.
+
+9. GOVERNING LAW
+
+   This License shall be governed by the laws of the State of Delaware.
+
+10. COMMERCIAL LICENSING
+
+    For commercial use outside the Lux ecosystem:
+    
+    Lux Industries Inc.
+    Email: licensing@lux.network
+    Subject: Commercial License Request
+
+================================================================================
+                              TL;DR
+================================================================================
+
+- Research/academic use = OK
+- Lux Primary Network (Network ID=1, Chain ID=96369) = OK
+- L1/L2/L3 chains descending from Lux Primary Network = OK
+- Commercial products outside Lux ecosystem = Contact licensing@lux.network
+- Forks = Absolutely not
+
+================================================================================
+
+See LP-0012 for full licensing documentation:
+https://github.com/luxfi/lps/blob/main/LPs/lp-0012-ecosystem-licensing.md

package/README.md

@@ -0,0 +1,3 @@
+# @universe/prices
+
+// TODO

package/package.json

@@ -1 +1,44 @@
-{"name":"@l.x/prices","version":"1.0.3","description":"LX Exchange - prices","main":"index.js","dependencies":{"@luxexchange/prices":"1.0.3"}}
+{
+  "name": "@l.x/prices",
+  "version": "1.0.5",
+  "dependencies": {
+    "@tanstack/react-query": "5.90.20",
+    "@luxamm/sdk-core": "7.12.3",
+    "@l.x/api": "^1.0.5",
+    "@luxfi/utilities": "^1.0.6",
+    "@l.x/websocket": "^1.0.5"
+  },
+  "peerDependencies": {
+    "react": "19.0.3"
+  },
+  "devDependencies": {
+    "@testing-library/react": "16.3.0",
+    "@types/node": "22.13.1",
+    "@typescript/native-preview": "7.0.0-dev.20260311.1",
+    "@vitest/coverage-v8": "3.2.1",
+    "depcheck": "1.4.7",
+    "eslint": "8.57.1",
+    "react": "19.0.3",
+    "typescript": "5.8.3",
+    "vitest": "3.2.1",
+    "@luxfi/eslint-config": "^1.0.6"
+  },
+  "nx": {
+    "includedScripts": []
+  },
+  "main": "src/index.ts",
+  "private": false,
+  "sideEffects": false,
+  "scripts": {
+    "test": "nx test prices",
+    "typecheck": "nx typecheck prices",
+    "typecheck:tsgo": "nx typecheck:tsgo prices",
+    "lint": "nx lint prices",
+    "lint:fix": "nx lint:fix prices",
+    "lint:biome": "nx lint:biome prices",
+    "lint:biome:fix": "nx lint:biome:fix prices",
+    "lint:eslint": "nx lint:eslint prices",
+    "lint:eslint:fix": "nx lint:eslint:fix prices",
+    "check:deps:usage": "nx check:deps:usage prices"
+  }
+}

package/project.json

@@ -0,0 +1,22 @@
+{
+  "name": "@l.x/prices",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "pkgs/prices/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "test": {
+      "command": "vitest run --passWithNoTests",
+      "options": { "cwd": "{projectRoot}" }
+    },
+    "typecheck": {},
+    "typecheck:tsgo": {},
+    "lint:biome": {},
+    "lint:biome:fix": {},
+    "lint:eslint": {},
+    "lint:eslint:fix": {},
+    "lint": {},
+    "lint:fix": {},
+    "check:deps:usage": {}
+  }
+}

package/src/context/PriceServiceContext.test.tsx

@@ -0,0 +1,63 @@
+// @vitest-environment jsdom
+
+import type { QueryClient } from '@tanstack/react-query'
+import { renderHook } from '@testing-library/react'
+import { PriceServiceProvider, usePricesContext } from '@l.x/prices/src/context/PriceServiceContext'
+import type { TokenPriceMessage, TokenSubscriptionParams } from '@l.x/prices/src/types'
+import type { WebSocketClient } from '@l.x/websocket'
+import type { ReactNode } from 'react'
+import { describe, expect, it, vi } from 'vitest'
+
+function createMockWsClient(): WebSocketClient<TokenSubscriptionParams, TokenPriceMessage['data']> {
+  return {
+    isConnected: vi.fn(() => false),
+    getConnectionStatus: vi.fn(() => 'disconnected' as const),
+    getConnectionId: vi.fn(() => null),
+    subscribe: vi.fn(() => vi.fn()),
+    onStatusChange: vi.fn(() => vi.fn()),
+    onConnectionEstablished: vi.fn(() => vi.fn()),
+  }
+}
+
+function createMockQueryClient(): QueryClient {
+  return { setQueryData: vi.fn() } as unknown as QueryClient
+}
+
+describe('PriceServiceContext', () => {
+  it('usePricesContext throws when used outside PriceServiceProvider', () => {
+    expect(() => {
+      renderHook(() => usePricesContext())
+    }).toThrow('usePricesContext must be used within a PriceServiceProvider')
+  })
+
+  it('usePricesContext returns wsClient and queryClient when inside PriceServiceProvider', () => {
+    const mockWsClient = createMockWsClient()
+    const mockQueryClient = createMockQueryClient()
+
+    const wrapper = ({ children }: { children: ReactNode }): ReactNode => (
+      <PriceServiceProvider wsClient={mockWsClient} queryClient={mockQueryClient}>
+        {children}
+      </PriceServiceProvider>
+    )
+
+    const { result } = renderHook(() => usePricesContext(), { wrapper })
+
+    expect(result.current.wsClient).toBe(mockWsClient)
+    expect(result.current.queryClient).toBe(mockQueryClient)
+  })
+
+  it('PriceServiceProvider renders children', () => {
+    const mockWsClient = createMockWsClient()
+    const mockQueryClient = createMockQueryClient()
+
+    const wrapper = ({ children }: { children: ReactNode }): ReactNode => (
+      <PriceServiceProvider wsClient={mockWsClient} queryClient={mockQueryClient}>
+        {children}
+      </PriceServiceProvider>
+    )
+
+    const { result } = renderHook(() => 'rendered', { wrapper })
+
+    expect(result.current).toBe('rendered')
+  })
+})

package/src/context/PriceServiceContext.tsx

@@ -0,0 +1,36 @@
+import type { QueryClient } from '@tanstack/react-query'
+import type { RestPriceBatcher } from '@l.x/prices/src/sources/rest/RestPriceBatcher'
+import type { TokenPriceMessage, TokenSubscriptionParams } from '@l.x/prices/src/types'
+import type { WebSocketClient } from '@l.x/websocket'
+import { createContext, type ReactElement, type ReactNode, useContext, useMemo } from 'react'
+
+interface PricesContextValue {
+  wsClient: WebSocketClient<TokenSubscriptionParams, TokenPriceMessage['data']>
+  queryClient: QueryClient
+  restBatcher?: RestPriceBatcher
+}
+
+const PricesContext = createContext<PricesContextValue | null>(null)
+
+export function PriceServiceProvider({
+  wsClient,
+  queryClient,
+  restBatcher,
+  children,
+}: {
+  wsClient: WebSocketClient<TokenSubscriptionParams, TokenPriceMessage['data']>
+  queryClient: QueryClient
+  restBatcher?: RestPriceBatcher
+  children: ReactNode
+}): ReactElement {
+  const value = useMemo(() => ({ wsClient, queryClient, restBatcher }), [wsClient, queryClient, restBatcher])
+  return <PricesContext.Provider value={value}>{children}</PricesContext.Provider>
+}
+
+export function usePricesContext(): PricesContextValue {
+  const context = useContext(PricesContext)
+  if (!context) {
+    throw new Error('usePricesContext must be used within a PriceServiceProvider')
+  }
+  return context
+}

package/src/hooks/useConnectionStatus.ts

@@ -0,0 +1,11 @@
+import { usePricesContext } from '@l.x/prices/src/context/PriceServiceContext'
+import type { ConnectionStatus } from '@l.x/websocket'
+import { useSyncExternalStore } from 'react'
+
+/**
+ * Hook to get the current WebSocket connection status.
+ */
+export function useConnectionStatus(): ConnectionStatus {
+  const { wsClient } = usePricesContext()
+  return useSyncExternalStore(wsClient.onStatusChange, wsClient.getConnectionStatus, wsClient.getConnectionStatus)
+}

package/src/hooks/usePrice.ts

@@ -0,0 +1,48 @@
+import { queryOptions, skipToken, useQuery, useQueryClient } from '@tanstack/react-query'
+import { usePricesContext } from '@l.x/prices/src/context/PriceServiceContext'
+import { priceKeys } from '@l.x/prices/src/queries/priceKeys'
+import { tokenPriceQueryOptions } from '@l.x/prices/src/queries/tokenPriceQueryOptions'
+import type { TokenPriceData } from '@l.x/prices/src/types'
+import { useEffect } from 'react'
+
+interface UsePriceOptions {
+  chainId: number | undefined
+  address: string | undefined
+  live?: boolean
+}
+
+/**
+ * Hook to get the live price for a token.
+ * Reads from React Query cache and auto-subscribes via websocket.
+ * Falls back to REST polling when WS data goes stale (if restBatcher is provided).
+ *
+ * Requires a PriceServiceProvider in the tree.
+ */
+export function usePrice(options: UsePriceOptions): number | undefined {
+  const { chainId, address, live = true } = options
+  const { wsClient, restBatcher } = usePricesContext()
+  const queryClient = useQueryClient()
+
+  const enabled = chainId !== undefined && !!address
+
+  // Data is populated externally via queryClient.setQueryData from WS messages.
+  // When restBatcher is provided, queryFn fires as a fallback when WS data goes stale.
+  const { data } = useQuery(
+    enabled
+      ? tokenPriceQueryOptions({ chainId, address, restBatcher, queryClient })
+      : queryOptions<TokenPriceData | null>({ queryKey: priceKeys.all, queryFn: skipToken, enabled: false }),
+  )
+
+  useEffect(() => {
+    if (!enabled || !live) {
+      return undefined
+    }
+    return wsClient.subscribe({
+      channel: 'token_price',
+      params: { chainId, tokenAddress: address.toLowerCase() },
+    })
+  }, [enabled, live, chainId, address, wsClient])
+
+  const price: number | undefined = enabled ? (data?.price ?? undefined) : undefined
+  return price
+}

package/src/index.ts

@@ -0,0 +1,45 @@
+// Types
+
+export {
+  isConnectionEstablishedMessage,
+  isRawTokenPriceMessage,
+  parseConnectionMessage,
+  parseTokenPriceMessage,
+} from '@l.x/prices/src/sources/websocket/messageParser'
+// Internals (testing / custom setups)
+export { createPriceSubscriptionHandler } from '@l.x/prices/src/sources/websocket/subscriptionApi'
+export type {
+  ConnectionEstablishedMessage,
+  Logger,
+  PriceKey,
+  RawTokenPriceMessage,
+  TokenIdentifier,
+  TokenInput,
+  TokenPrice,
+  TokenPriceData,
+  TokenPriceMessage,
+  TokenSubscriptionParams,
+} from '@l.x/prices/src/types'
+export {
+  createPriceKey,
+  createPriceKeyFromToken,
+  filterValidTokens,
+  isCurrency,
+  isTokenIdentifier,
+  normalizeToken,
+  parsePriceKey,
+  toSubscriptionParams,
+} from '@l.x/prices/src/utils/tokenIdentifier'
+export type { ConnectionStatus } from '@l.x/websocket'
+export { PriceServiceProvider, usePricesContext } from './context/PriceServiceContext'
+export { useConnectionStatus } from './hooks/useConnectionStatus'
+// Consumer hooks
+// Backward-compat alias
+export { usePrice, usePrice as useLivePrice } from './hooks/usePrice'
+// Query utilities (advanced / UDL)
+export { priceKeys } from './queries/priceKeys'
+export { tokenPriceQueryOptions } from './queries/tokenPriceQueryOptions'
+export { REST_POLL_INTERVAL_MS } from './sources/rest/constants'
+// REST fallback
+export { RestPriceBatcher } from './sources/rest/RestPriceBatcher'
+export type { RestPriceClient } from './sources/rest/types'

package/src/queries/priceKeys.test.ts

@@ -0,0 +1,23 @@
+import { priceKeys } from '@l.x/prices/src/queries/priceKeys'
+import { ReactQueryCacheKey } from 'utilities/src/reactQuery/cache'
+import { describe, expect, it } from 'vitest'
+
+describe('priceKeys', () => {
+  describe('all', () => {
+    it('returns array with TokenPrice cache key', () => {
+      expect(priceKeys.all).toEqual([ReactQueryCacheKey.TokenPrice])
+    })
+  })
+
+  describe('token', () => {
+    it('returns key with chainId and lowercased address', () => {
+      const key = priceKeys.token(1, '0xABC')
+      expect(key).toEqual([ReactQueryCacheKey.TokenPrice, 1, '0xabc'])
+    })
+
+    it('handles already lowercased address', () => {
+      const key = priceKeys.token(42161, '0xdef')
+      expect(key).toEqual([ReactQueryCacheKey.TokenPrice, 42161, '0xdef'])
+    })
+  })
+})

package/src/queries/priceKeys.ts

@@ -0,0 +1,6 @@
+import { ReactQueryCacheKey } from 'utilities/src/reactQuery/cache'
+
+export const priceKeys = {
+  all: [ReactQueryCacheKey.TokenPrice] as const,
+  token: (chainId: number, address: string) => [ReactQueryCacheKey.TokenPrice, chainId, address.toLowerCase()] as const,
+} as const

package/src/queries/tokenPriceQueryOptions.ts

@@ -0,0 +1,41 @@
+import { type QueryClient, queryOptions, skipToken } from '@tanstack/react-query'
+import { priceKeys } from '@l.x/prices/src/queries/priceKeys'
+import { REST_POLL_INTERVAL_MS } from '@l.x/prices/src/sources/rest/constants'
+import type { RestPriceBatcher } from '@l.x/prices/src/sources/rest/RestPriceBatcher'
+import type { TokenPriceData } from '@l.x/prices/src/types'
+
+export interface TokenPriceQueryOptionsParams {
+  chainId: number
+  address: string
+  restBatcher?: RestPriceBatcher
+  queryClient?: QueryClient
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function tokenPriceQueryOptions({ chainId, address, restBatcher, queryClient }: TokenPriceQueryOptionsParams) {
+  const key = priceKeys.token(chainId, address)
+  return queryOptions<TokenPriceData | null>({
+    queryKey: key,
+    queryFn: restBatcher
+      ? async (): Promise<TokenPriceData | null> => {
+          const fresh = await restBatcher.fetch({ chainId, address: address.toLowerCase() })
+          if (!fresh) {
+            return null
+          }
+          // Guard against REST responses overwriting newer WebSocket data.
+          // refetchInterval fires independently of staleTime, so without this
+          // check a 30s-old REST response could clobber a sub-second WS update.
+          const existing = queryClient?.getQueryData<TokenPriceData>(key)
+          if (existing && existing.timestamp >= fresh.timestamp) {
+            return existing
+          }
+          return fresh
+        }
+      : skipToken,
+    staleTime: Infinity,
+    refetchOnWindowFocus: false,
+    refetchOnMount: false,
+    structuralSharing: false,
+    refetchInterval: restBatcher ? REST_POLL_INTERVAL_MS : false,
+  })
+}