@l.x/prices 1.0.3 → 1.0.4

package/src/sources/rest/RestPriceBatcher.ts

@@ -0,0 +1,110 @@
+import { BATCH_DELAY_MS, MAX_BATCH_SIZE } from '@l.x/prices/src/sources/rest/constants'
+import type { RestPriceClient } from '@l.x/prices/src/sources/rest/types'
+import type { TokenIdentifier, TokenPriceData } from '@l.x/prices/src/types'
+import { createPriceKey } from '@l.x/prices/src/utils/tokenIdentifier'
+
+interface PendingRequest {
+  token: TokenIdentifier
+  resolve: (value: TokenPriceData | undefined) => void
+  reject: (error: unknown) => void
+}
+
+/**
+ * Timer-based batcher for REST price fetches.
+ *
+ * Individual `fetch(token)` calls are coalesced into a single batch REST
+ * request within a short delay window (BATCH_DELAY_MS ≈ one frame). This
+ * ensures requests from separate macrotasks (e.g. React Query refetchInterval
+ * callbacks) are grouped together. Duplicate tokens share the same result.
+ * Batches exceeding MAX_BATCH_SIZE are chunked into parallel requests.
+ */
+export class RestPriceBatcher {
+  private readonly client: RestPriceClient
+  private pending: PendingRequest[] = []
+  private flushTimer: ReturnType<typeof setTimeout> | null = null
+
+  constructor(client: RestPriceClient) {
+    this.client = client
+  }
+
+  /**
+   * Request a price for a single token. Multiple calls within the same
+   * batching window (BATCH_DELAY_MS) are batched into one REST request.
+   *
+   * @returns The price data, or undefined if the token has no price.
+   */
+  fetch(token: TokenIdentifier): Promise<TokenPriceData | undefined> {
+    return new Promise<TokenPriceData | undefined>((resolve, reject) => {
+      this.pending.push({
+        token: { chainId: token.chainId, address: token.address.toLowerCase() },
+        resolve,
+        reject,
+      })
+
+      if (this.flushTimer === null) {
+        this.flushTimer = setTimeout(() => this.flush(), BATCH_DELAY_MS)
+      }
+    })
+  }
+
+  private async flush(): Promise<void> {
+    const batch = this.pending
+    this.pending = []
+    this.flushTimer = null
+
+    if (batch.length === 0) {
+      return
+    }
+
+    // Group resolvers by price key (deduplication)
+    const resolversByKey = new Map<string, PendingRequest[]>()
+    const uniqueTokens = new Map<string, TokenIdentifier>()
+
+    for (const request of batch) {
+      const key = createPriceKey(request.token.chainId, request.token.address)
+      const existing = resolversByKey.get(key)
+      if (existing) {
+        existing.push(request)
+      } else {
+        resolversByKey.set(key, [request])
+        uniqueTokens.set(key, request.token)
+      }
+    }
+
+    const tokens = Array.from(uniqueTokens.values())
+
+    // Chunk into batches of MAX_BATCH_SIZE
+    const chunks: TokenIdentifier[][] = []
+    for (let i = 0; i < tokens.length; i += MAX_BATCH_SIZE) {
+      chunks.push(tokens.slice(i, i + MAX_BATCH_SIZE))
+    }
+
+    try {
+      // Fetch all chunks in parallel
+      const results = await Promise.all(chunks.map((chunk) => this.client.getTokenPrices(chunk)))
+
+      // Merge all chunk results
+      const merged = new Map<string, TokenPriceData>()
+      for (const chunkResult of results) {
+        for (const [key, value] of chunkResult) {
+          merged.set(key, value)
+        }
+      }
+
+      // Resolve all pending requests
+      for (const [key, requests] of resolversByKey) {
+        const data = merged.get(key)
+        for (const request of requests) {
+          request.resolve(data)
+        }
+      }
+    } catch (error) {
+      // On error, reject all pending promises (React Query retries individually)
+      for (const requests of resolversByKey.values()) {
+        for (const request of requests) {
+          request.reject(error)
+        }
+      }
+    }
+  }
+}

package/src/sources/rest/constants.ts

@@ -0,0 +1,9 @@
+/** How often to poll REST as a fallback for fresh prices */
+export const REST_POLL_INTERVAL_MS = 30_000
+
+/** Maximum tokens per REST request (backend limit) */
+export const MAX_BATCH_SIZE = 100
+
+/** Delay before flushing a batch (~one frame). Allows requests from separate
+ *  macrotasks (e.g. React Query refetchInterval callbacks) to be grouped. */
+export const BATCH_DELAY_MS = 16

package/src/sources/rest/types.ts

@@ -0,0 +1,13 @@
+import type { TokenIdentifier, TokenPriceData } from '@l.x/prices/src/types'
+
+/**
+ * Contract for fetching token prices via REST.
+ * Implementations handle the actual transport (ConnectRPC, fetch, etc.).
+ */
+export interface RestPriceClient {
+  /**
+   * Fetches prices for a batch of tokens.
+   * @returns Map keyed by price key ("chainId-address"), missing tokens omitted.
+   */
+  getTokenPrices(tokens: TokenIdentifier[]): Promise<Map<string, TokenPriceData>>
+}

package/src/sources/websocket/messageParser.ts

@@ -0,0 +1,79 @@
+import type { ConnectionEstablishedMessage, RawTokenPriceMessage, TokenPriceMessage } from '@l.x/prices/src/types'
+import { createPriceKey } from '@l.x/prices/src/utils/tokenIdentifier'
+
+/**
+ * Type guard for RawTokenPriceMessage
+ */
+export function isRawTokenPriceMessage(message: unknown): message is RawTokenPriceMessage {
+  return (
+    typeof message === 'object' &&
+    message !== null &&
+    'type' in message &&
+    message.type === 'token_price_update' &&
+    'payload' in message &&
+    typeof message.payload === 'object' &&
+    message.payload !== null
+  )
+}
+
+/**
+ * Type guard for ConnectionEstablishedMessage
+ */
+export function isConnectionEstablishedMessage(message: unknown): message is ConnectionEstablishedMessage {
+  return (
+    typeof message === 'object' &&
+    message !== null &&
+    'connectionEstablished' in message &&
+    typeof message.connectionEstablished === 'object' &&
+    message.connectionEstablished !== null &&
+    'connectionId' in message.connectionEstablished
+  )
+}
+
+/**
+ * Parses a raw WebSocket message into a typed price update.
+ * Returns null if the message is not a price update.
+ *
+ * Used both as the `parseMessage` config for createWebSocketClient
+ * and in the `onRawMessage` callback to write to React Query cache.
+ */
+export function parseTokenPriceMessage(raw: unknown): TokenPriceMessage | null {
+  if (!isRawTokenPriceMessage(raw)) {
+    return null
+  }
+
+  const { chainId, tokenAddress, priceUsd } = raw.payload
+  const price = parseFloat(priceUsd)
+
+  if (Number.isNaN(price)) {
+    return null
+  }
+
+  const timestamp = new Date(raw.timestamp).getTime()
+  const key = createPriceKey(chainId, tokenAddress)
+
+  return {
+    channel: 'token_price',
+    key,
+    data: {
+      chainId,
+      tokenAddress: tokenAddress.toLowerCase(),
+      priceUsd: price,
+      timestamp,
+    },
+  }
+}
+
+/**
+ * Parses a raw WebSocket message for connection establishment.
+ * Returns null if the message is not a connection message.
+ */
+export function parseConnectionMessage(raw: unknown): { connectionId: string } | null {
+  if (!isConnectionEstablishedMessage(raw)) {
+    return null
+  }
+
+  return {
+    connectionId: raw.connectionEstablished.connectionId,
+  }
+}

package/src/sources/websocket/subscriptionApi.ts

@@ -0,0 +1,105 @@
+import type { FetchClient } from '@l.x/api'
+import type { TokenSubscriptionParams } from '@l.x/prices/src/types'
+import type { SubscriptionHandler } from '@l.x/websocket'
+
+const EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE = 'EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE'
+
+export interface SubscriptionApiOptions {
+  client: FetchClient
+  onError?: (error: unknown, operation: string) => void
+}
+
+/**
+ * Creates a subscription handler for token price subscriptions.
+ * This implements the SubscriptionHandler interface from @l.x/websocket.
+ */
+export function createPriceSubscriptionHandler(
+  options: SubscriptionApiOptions,
+): SubscriptionHandler<TokenSubscriptionParams> {
+  const { client, onError } = options
+
+  async function subscribe(connectionId: string, params: TokenSubscriptionParams): Promise<void> {
+    try {
+      await client.post('/lx.notificationservice.v1.EventSubscriptionService/Subscribe', {
+        body: JSON.stringify({
+          eventSubscriptionType: EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE,
+          connectionId,
+          events: [{ token: { chainId: params.chainId, tokenAddress: params.tokenAddress } }],
+        }),
+      })
+    } catch (error) {
+      onError?.(error, 'subscribe')
+    }
+  }
+
+  async function unsubscribe(connectionId: string, params: TokenSubscriptionParams): Promise<void> {
+    try {
+      await client.post('/lx.notificationservice.v1.EventSubscriptionService/Unsubscribe', {
+        body: JSON.stringify({
+          eventSubscriptionType: EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE,
+          connectionId,
+          events: [{ token: { chainId: params.chainId, tokenAddress: params.tokenAddress } }],
+        }),
+      })
+    } catch (error) {
+      onError?.(error, 'unsubscribe')
+    }
+  }
+
+  async function subscribeBatch(connectionId: string, paramsList: TokenSubscriptionParams[]): Promise<void> {
+    if (paramsList.length === 0) {
+      return
+    }
+
+    try {
+      await client.post('/lx.notificationservice.v1.EventSubscriptionService/Subscribe', {
+        body: JSON.stringify({
+          eventSubscriptionType: EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE,
+          connectionId,
+          events: paramsList.map((p) => ({ token: { chainId: p.chainId, tokenAddress: p.tokenAddress } })),
+        }),
+      })
+    } catch (error) {
+      onError?.(error, 'subscribeBatch')
+    }
+  }
+
+  async function unsubscribeBatch(connectionId: string, paramsList: TokenSubscriptionParams[]): Promise<void> {
+    if (paramsList.length === 0) {
+      return
+    }
+
+    try {
+      await client.post('/lx.notificationservice.v1.EventSubscriptionService/Unsubscribe', {
+        body: JSON.stringify({
+          eventSubscriptionType: EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE,
+          connectionId,
+          events: paramsList.map((p) => ({ token: { chainId: p.chainId, tokenAddress: p.tokenAddress } })),
+        }),
+      })
+    } catch (error) {
+      onError?.(error, 'unsubscribeBatch')
+    }
+  }
+
+  async function refreshSession(connectionId: string): Promise<void> {
+    try {
+      await client.post('/lx.notificationservice.v1.EventSubscriptionService/RefreshSession', {
+        body: JSON.stringify({
+          eventSubscriptionType: EVENT_SUBSCRIPTION_TYPE_TOKEN_PRICE,
+          connectionId,
+        }),
+      })
+    } catch (error) {
+      onError?.(error, 'refreshSession')
+    }
+  }
+
+  return {
+    subscribe,
+    unsubscribe,
+    subscribeBatch,
+    unsubscribeBatch,
+    refreshSession,
+  }
+}

package/src/types.ts

@@ -0,0 +1,96 @@
+import type { Currency } from '@luxamm/sdk-core'
+
+/**
+ * A token identifier with chain and address.
+ * Can be used instead of a full Currency object.
+ */
+export interface TokenIdentifier {
+  chainId: number
+  address: string
+}
+
+/**
+ * Token price data with timestamp.
+ */
+export interface TokenPrice {
+  price: number
+  timestamp: number
+}
+
+/**
+ * Shape stored in the React Query cache for each token price.
+ */
+export interface TokenPriceData {
+  price: number
+  timestamp: number
+}
+
+/**
+ * Key used to identify a token price in the store.
+ * Format: "chainId-address" (e.g., "1-0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2")
+ * Matches CurrencyId convention from lx/src/utils/currencyId.ts
+ */
+export type PriceKey = string
+
+/**
+ * Token identifier format used by the subscription API.
+ */
+export interface TokenSubscriptionParams {
+  chainId: number
+  tokenAddress: string
+}
+
+/**
+ * Parsed WebSocket message for token price updates.
+ * Wraps channel, key, and the inner data payload.
+ */
+export interface TokenPriceMessage {
+  channel: string
+  key: string
+  data: {
+    chainId: number
+    tokenAddress: string
+    priceUsd: number
+    timestamp: number
+  }
+}
+
+/**
+ * Raw WebSocket message format from server (strings, optional fields).
+ * Parsed into {@link TokenPriceMessage} by messageParser before app consumption.
+ */
+export interface RawTokenPriceMessage {
+  type: 'token_price_update'
+  payload: {
+    chainId: number
+    tokenAddress: string
+    priceUsd: string
+    symbol?: string
+    timestamp?: string
+  }
+  timestamp: string
+}
+
+/**
+ * Connection established message from server.
+ */
+export interface ConnectionEstablishedMessage {
+  connectionEstablished: {
+    connectionId: string
+    timestamp: string
+  }
+}
+
+/**
+ * Logger interface for optional logging.
+ */
+export interface Logger {
+  debug: (tag: string, context: string, message: string, data?: unknown) => void
+  warn: (tag: string, context: string, message: string, data?: unknown) => void
+  error: (tag: string, context: string, message: string, data?: unknown) => void
+}
+
+/**
+ * Type guard input - any token that can provide chain and address.
+ */
+export type TokenInput = TokenIdentifier | Currency

package/src/utils/tokenIdentifier.test.ts

@@ -0,0 +1,145 @@
+import { Ether, Token } from '@luxamm/sdk-core'
+import type { TokenIdentifier } from '@l.x/prices'
+import {
+  createPriceKey,
+  createPriceKeyFromToken,
+  filterValidTokens,
+  isCurrency,
+  isTokenIdentifier,
+  normalizeToken,
+  parsePriceKey,
+  toSubscriptionParams,
+} from '@l.x/prices'
+import { describe, expect, it } from 'vitest'
+
+const WETH_ADDRESS = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+const USDC_ADDRESS = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
+
+describe('tokenIdentifier utilities', () => {
+  describe('isCurrency', () => {
+    it('returns true for Token instances', () => {
+      const token = new Token(1, WETH_ADDRESS, 18, 'WETH', 'Wrapped Ether')
+      expect(isCurrency(token)).toBe(true)
+    })
+
+    it('returns false for TokenIdentifier', () => {
+      const identifier: TokenIdentifier = { chainId: 1, address: WETH_ADDRESS }
+      expect(isCurrency(identifier)).toBe(false)
+    })
+  })
+
+  describe('isTokenIdentifier', () => {
+    it('returns true for TokenIdentifier objects', () => {
+      const identifier: TokenIdentifier = { chainId: 1, address: WETH_ADDRESS }
+      expect(isTokenIdentifier(identifier)).toBe(true)
+    })
+
+    it('returns false for Token instances', () => {
+      const token = new Token(1, WETH_ADDRESS, 18, 'WETH', 'Wrapped Ether')
+      expect(isTokenIdentifier(token)).toBe(false)
+    })
+  })
+
+  describe('normalizeToken', () => {
+    it('normalizes TokenIdentifier with lowercase address', () => {
+      const identifier: TokenIdentifier = { chainId: 1, address: WETH_ADDRESS }
+      const result = normalizeToken(identifier)
+      expect(result).toEqual({
+        chainId: 1,
+        address: WETH_ADDRESS.toLowerCase(),
+      })
+    })
+
+    it('normalizes native currency to zero address', () => {
+      const eth = Ether.onChain(1)
+      const result = normalizeToken(eth)
+      expect(result).toEqual({
+        chainId: 1,
+        address: '0x0000000000000000000000000000000000000000',
+      })
+    })
+
+    it('normalizes Token instance', () => {
+      const token = new Token(1, WETH_ADDRESS, 18, 'WETH', 'Wrapped Ether')
+      const result = normalizeToken(token)
+      expect(result).toEqual({
+        chainId: 1,
+        address: WETH_ADDRESS.toLowerCase(),
+      })
+    })
+  })
+
+  describe('createPriceKey', () => {
+    it('creates key with format chainId-address', () => {
+      const key = createPriceKey(1, WETH_ADDRESS)
+      expect(key).toBe(`1-${WETH_ADDRESS.toLowerCase()}`)
+    })
+
+    it('lowercases address', () => {
+      const key = createPriceKey(1, '0xABC')
+      expect(key).toBe('1-0xabc')
+    })
+  })
+
+  describe('createPriceKeyFromToken', () => {
+    it('creates key from TokenIdentifier', () => {
+      const identifier: TokenIdentifier = { chainId: 1, address: WETH_ADDRESS }
+      const key = createPriceKeyFromToken(identifier)
+      expect(key).toBe(`1-${WETH_ADDRESS.toLowerCase()}`)
+    })
+
+    it('creates key from Token', () => {
+      const token = new Token(1, WETH_ADDRESS, 18, 'WETH', 'Wrapped Ether')
+      const key = createPriceKeyFromToken(token)
+      expect(key).toBe(`1-${WETH_ADDRESS.toLowerCase()}`)
+    })
+  })
+
+  describe('parsePriceKey', () => {
+    it('parses key back to TokenIdentifier', () => {
+      const key = `1-${WETH_ADDRESS.toLowerCase()}`
+      const result = parsePriceKey(key)
+      expect(result).toEqual({
+        chainId: 1,
+        address: WETH_ADDRESS.toLowerCase(),
+      })
+    })
+
+    it('returns null for missing address', () => {
+      expect(parsePriceKey('1')).toBeNull()
+    })
+
+    it('returns null for invalid chainId', () => {
+      expect(parsePriceKey('abc-0x123')).toBeNull()
+    })
+
+    it('returns null for empty key', () => {
+      expect(parsePriceKey('')).toBeNull()
+    })
+  })
+
+  describe('toSubscriptionParams', () => {
+    it('converts to subscription params format', () => {
+      const identifier: TokenIdentifier = { chainId: 1, address: WETH_ADDRESS }
+      const params = toSubscriptionParams(identifier)
+      expect(params).toEqual({
+        chainId: 1,
+        tokenAddress: WETH_ADDRESS.toLowerCase(),
+      })
+    })
+  })
+
+  describe('filterValidTokens', () => {
+    it('filters out invalid addresses', () => {
+      const tokens: TokenIdentifier[] = [
+        { chainId: 1, address: WETH_ADDRESS },
+        { chainId: 1, address: 'invalid' },
+        { chainId: 1, address: USDC_ADDRESS },
+      ]
+      const result = filterValidTokens(tokens)
+      expect(result).toHaveLength(2)
+      expect(result[0]?.address).toBe(WETH_ADDRESS.toLowerCase())
+      expect(result[1]?.address).toBe(USDC_ADDRESS.toLowerCase())
+    })
+  })
+})

package/src/utils/tokenIdentifier.ts

@@ -0,0 +1,111 @@
+import type { Currency, Token } from '@luxamm/sdk-core'
+import type { PriceKey, TokenIdentifier, TokenInput, TokenSubscriptionParams } from '@l.x/prices'
+import { isEVMAddress } from 'utilities/src/addresses/evm/evm'
+
+/** Address that represents native currencies on ETH, Arbitrum, etc. */
+const DEFAULT_NATIVE_ADDRESS = '0x0000000000000000000000000000000000000000'
+
+/**
+ * Type guard to check if input is a Currency object (from @luxamm/sdk-core).
+ * Currency objects have isNative and isToken properties from the SDK.
+ */
+export function isCurrency(token: TokenInput): token is Currency {
+  return (
+    typeof token === 'object' &&
+    'chainId' in token &&
+    typeof (token as Currency).chainId === 'number' &&
+    // Currency from SDK always has isNative property (true for native, false for tokens)
+    'isNative' in token &&
+    typeof (token as Currency).isNative === 'boolean'
+  )
+}
+
+/**
+ * Type guard to check if input is a TokenIdentifier.
+ */
+export function isTokenIdentifier(token: TokenInput): token is TokenIdentifier {
+  return (
+    typeof token === 'object' &&
+    'chainId' in token &&
+    'address' in token &&
+    typeof (token as TokenIdentifier).chainId === 'number' &&
+    typeof (token as TokenIdentifier).address === 'string' &&
+    !('isNative' in token)
+  )
+}
+
+/**
+ * Normalizes any token input to a TokenIdentifier.
+ */
+export function normalizeToken(token: TokenInput): TokenIdentifier {
+  if (isTokenIdentifier(token)) {
+    return {
+      chainId: token.chainId,
+      address: token.address.toLowerCase(),
+    }
+  }
+
+  // It's a Currency
+  const currency = token as Currency
+  if (currency.isNative) {
+    return {
+      chainId: currency.chainId,
+      address: DEFAULT_NATIVE_ADDRESS,
+    }
+  }
+
+  // It's a Token
+  const tokenCurrency = currency as Token
+  return {
+    chainId: tokenCurrency.chainId,
+    address: tokenCurrency.address.toLowerCase(),
+  }
+}
+
+/**
+ * Creates a unique price key from chainId and address.
+ * Format matches CurrencyId convention: "chainId-address"
+ */
+export function createPriceKey(chainId: number, address: string): PriceKey {
+  return `${chainId}-${address.toLowerCase()}`
+}
+
+/**
+ * Creates a price key from a token input.
+ */
+export function createPriceKeyFromToken(token: TokenInput): PriceKey {
+  const { chainId, address } = normalizeToken(token)
+  return createPriceKey(chainId, address)
+}
+
+/**
+ * Parses a price key back to chainId and address.
+ * Returns null if the key is malformed (missing chainId or address).
+ */
+export function parsePriceKey(key: PriceKey): TokenIdentifier | null {
+  const [chainIdStr, address] = key.split('-')
+  const chainId = Number(chainIdStr)
+
+  if (Number.isNaN(chainId) || !address) {
+    return null
+  }
+
+  return { chainId, address }
+}
+
+/**
+ * Converts a TokenIdentifier to the format expected by the subscription API.
+ */
+export function toSubscriptionParams(token: TokenIdentifier): TokenSubscriptionParams {
+  return {
+    chainId: token.chainId,
+    tokenAddress: token.address.toLowerCase(),
+  }
+}
+
+/**
+ * Filters tokens to only those valid for subscription.
+ */
+export function filterValidTokens(tokens: TokenInput[]): TokenIdentifier[] {
+  return tokens.map(normalizeToken).filter((t) => isEVMAddress(t.address))
+}