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

package/src/services/getMarkets.ts

@@ -0,0 +1,40 @@
+import type { MarketsResponse } from '@lifi/perps-types'
+import { buildUrl, request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
+
+/**
+ * Parameters for {@link getMarkets}.
+ *
+ * @public
+ */
+export interface GetMarketsParams {
+  provider: string
+  /** Optional filter — opaque `Market.id`s (not display symbols). */
+  marketIds?: string[]
+}
+
+/**
+ * Get all available markets for a provider. Thin pass-through to the LI.FI
+ * backend's Valkey-cached `/perps/markets` route — the canonical source of
+ * public market data for widget consumers.
+ *
+ * @throws {PerpsError} On backend, network, or parsing errors.
+ * @example
+ * ```ts
+ * const client = createPerpsClient({ integrator: 'my-app' })
+ * const { markets } = await getMarkets(client, { provider: 'hyperliquid' })
+ * ```
+ * @public
+ */
+export async function getMarkets(
+  client: PerpsSDKClient,
+  params: GetMarketsParams,
+  options?: SDKRequestOptions
+): Promise<MarketsResponse> {
+  const url = buildUrl(`${client.config.apiUrl}/markets`, {
+    provider: params.provider,
+    marketIds: params.marketIds?.join(','),
+  })
+  return request<MarketsResponse>(client.config, url, {}, options)
+}

package/src/services/getMeta.ts

@@ -0,0 +1,30 @@
+import type { Meta } from '@lifi/perps-types'
+import { request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
+
+/**
+ * Get platform metadata: the API version and any active platform-level notices.
+ *
+ * @returns Platform version and the list of active notices
+ * @throws {PerpsError} On API error responses
+ * @throws {PerpsError} On network or parsing errors
+ *
+ * @example
+ * ```ts
+ * const client = createPerpsClient({ integrator: 'my-app' })
+ * const { version, notices } = await getMeta(client)
+ * ```
+ * @public
+ */
+export async function getMeta(
+  client: PerpsSDKClient,
+  options?: SDKRequestOptions
+): Promise<Meta> {
+  return request<Meta>(
+    client.config,
+    `${client.config.apiUrl}/meta`,
+    {},
+    options
+  )
+}

package/src/services/getOhlcv.ts

@@ -1,61 +1,52 @@
 import type { OhlcvInterval, OhlcvResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import { buildUrl, request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getOhlcv}.
+ *
+ * @public
+ */
 export interface GetOhlcvParams {
-  /** Provider to get OHLCV from (e.g., 'hyperliquid') */
   provider: string
-  /** Market symbol (e.g., 'BTC') */
-  symbol: string
-  /** Candle interval */
+  /** Opaque provider `Market.id` (not `displaySymbol`). */
+  marketId: string
   interval: OhlcvInterval
-  /** Start time (Unix timestamp in milliseconds) */
+  /** Unix timestamp in milliseconds */
   startTime?: number
-  /** End time (Unix timestamp in milliseconds) */
+  /** Unix timestamp in milliseconds */
   endTime?: number
-  /** Maximum number of candles to return */
   limit?: number
 }
 
 /**
  * Get OHLCV (candlestick) data for a market.
  *
- * @param client - The SDK client instance
- * @param params - Request parameters
- * @param options - Request options (e.g., AbortSignal)
- * @returns OHLCV candle data
- * @throws {PerpsError} On API error responses
- * @throws {PerpsError} On network or parsing errors
- *
+ * @throws {PerpsError} On backend, network, or parsing errors.
  * @example
  * ```ts
- * const client = createPerpsClient({ integrator: 'my-app' })
  * const { candles } = await getOhlcv(client, {
  *   provider: 'hyperliquid',
- *   symbol: 'BTC',
+ *   marketId: 'BTC',
  *   interval: '1h',
- *   limit: 100
+ *   limit: 100,
  * })
- * console.log(candles) // [{ t: 1704067200000, o: '94000', h: '95000', ... }]
  * ```
+ * @public
  */
 export async function getOhlcv(
   client: PerpsSDKClient,
   params: GetOhlcvParams,
   options?: SDKRequestOptions
 ): Promise<OhlcvResponse> {
-  const url = buildUrl(
-    `${client.config.apiUrl}/ohlcv/${encodeURIComponent(params.symbol)}`,
-    {
-      provider: params.provider,
-      interval: params.interval,
-      startTime: params.startTime,
-      endTime: params.endTime,
-      limit: params.limit,
-    }
-  )
+  const url = buildUrl(`${client.config.apiUrl}/ohlcv`, {
+    provider: params.provider,
+    marketId: params.marketId,
+    interval: params.interval,
+    startTime: params.startTime,
+    endTime: params.endTime,
+    limit: params.limit,
+  })
   return request<OhlcvResponse>(client.config, url, {}, options)
 }

package/src/services/getOrder.ts

@@ -1,51 +1,44 @@
-import type { Address, Order } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import type { Order } from '@lifi/perps-types'
+import type { Address } from 'viem'
+import { requireProvider } from '../client/requireProvider.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getOrder}.
+ *
+ * @public
+ */
 export interface GetOrderParams {
-  /** Provider to get order from (e.g., 'hyperliquid') */
   provider: string
-  /** Wallet address */
   address: Address
-  /** Order ID */
   id: string
 }
 
 /**
- * Get a specific order by ID.
- *
- * @param client - The SDK client instance
- * @param params - Request parameters
- * @param options - Request options (e.g., AbortSignal)
- * @returns Order details
- * @throws {PerpsError} On API error responses (e.g., 404 if order not found)
- * @throws {PerpsError} On network or parsing errors
+ * Get a specific order by ID. Delegates to the registered venue plugin
+ * (direct-to-venue); requires the provider plugin to be registered on the
+ * client.
  *
+ * @throws {PerpsError} When the provider plugin is not registered, or on
+ *   backend / network / parsing errors.
  * @example
  * ```ts
- * const client = createPerpsClient({ integrator: 'my-app' })
  * const order = await getOrder(client, {
  *   provider: 'hyperliquid',
  *   address: '0x1234...',
- *   id: '123456'
+ *   id: '123456',
  * })
- * console.log(order) // { orderId: '123456', status: 'FILLED', ... }
  * ```
+ * @public
  */
 export async function getOrder(
   client: PerpsSDKClient,
   params: GetOrderParams,
   options?: SDKRequestOptions
 ): Promise<Order> {
-  const url = buildUrl(
-    `${client.config.apiUrl}/order/${encodeURIComponent(params.id)}`,
-    {
-      provider: params.provider,
-      address: params.address,
-    }
+  return requireProvider(client, params.provider).getOrder(
+    { address: params.address, id: params.id },
+    options
   )
-  return request<Order>(client.config, url, {}, options)
 }

package/src/services/getOrderbook.ts

@@ -1,52 +1,37 @@
 import type { OrderbookResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import { buildUrl, request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getOrderbook}.
+ *
+ * @public
+ */
 export interface GetOrderbookParams {
-  /** Provider to get orderbook from (e.g., 'hyperliquid') */
   provider: string
-  /** Market symbol (e.g., 'BTC') */
-  symbol: string
+  /** Opaque provider `Market.id` (not `displaySymbol`). */
+  marketId: string
   /** Number of levels to return (default varies by DEX) */
   depth?: number
 }
 
 /**
- * Get orderbook for a market.
- *
- * @param client - The SDK client instance
- * @param params - Request parameters
- * @param options - Request options (e.g., AbortSignal)
- * @returns Orderbook with bids and asks
- * @throws {PerpsError} On API error responses
- * @throws {PerpsError} On network or parsing errors
+ * Get an orderbook backfill snapshot for a market. Pair with a provider WS
+ * subscription for live updates.
  *
- * @example
- * ```ts
- * const client = createPerpsClient({ integrator: 'my-app' })
- * const { bids, asks } = await getOrderbook(client, {
- *   provider: 'hyperliquid',
- *   symbol: 'BTC',
- *   depth: 20
- * })
- * console.log(bids[0]) // { price: '94999.50', size: '1.5' }
- * console.log(asks[0]) // { price: '95000.50', size: '2.0' }
- * ```
+ * @throws {PerpsError} On backend error responses, network, or parsing errors.
+ * @public
  */
 export async function getOrderbook(
   client: PerpsSDKClient,
   params: GetOrderbookParams,
   options?: SDKRequestOptions
 ): Promise<OrderbookResponse> {
-  const url = buildUrl(
-    `${client.config.apiUrl}/orderbook/${encodeURIComponent(params.symbol)}`,
-    {
-      provider: params.provider,
-      depth: params.depth,
-    }
-  )
+  const url = buildUrl(`${client.config.apiUrl}/orderbook`, {
+    provider: params.provider,
+    marketId: params.marketId,
+    depth: params.depth,
+  })
   return request<OrderbookResponse>(client.config, url, {}, options)
 }

package/src/services/getOrders.ts

@@ -1,26 +1,30 @@
-import type { Address, OrdersResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import type { OrdersResponse } from '@lifi/perps-types'
+import type { Address } from 'viem'
+import { requireProvider } from '../client/requireProvider.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getOrders}.
+ *
+ * @public
+ */
 export interface GetOrdersParams {
-  /** Provider (e.g., 'hyperliquid') */
   provider: string
-  /** Wallet address */
   address: Address
-  /** Optional symbol to filter orders by market */
-  symbol?: string
-  /** Maximum number of results */
+  /** Optional filter — opaque `Market.id` (not `displaySymbol`) */
+  marketId?: string
   limit?: number
-  /** Pagination cursor */
   cursor?: string
 }
 
 /**
- * Get open orders and trigger orders for an account.
+ * Get open orders and trigger orders for an account. Delegates to the
+ * registered venue plugin (direct-to-venue); requires the provider plugin to be
+ * registered on the client.
  *
+ * @throws {PerpsError} When the provider plugin is not registered, or on
+ *   backend / network / parsing errors.
  * @example
  * ```ts
  * const { openOrders, triggerOrders } = await getOrders(client, {
@@ -28,18 +32,20 @@ export interface GetOrdersParams {
  *   address: '0x1234...',
  * })
  * ```
+ * @public
  */
 export async function getOrders(
   client: PerpsSDKClient,
   params: GetOrdersParams,
   options?: SDKRequestOptions
 ): Promise<OrdersResponse> {
-  const url = buildUrl(`${client.config.apiUrl}/orders`, {
-    provider: params.provider,
-    address: params.address,
-    ...(params.symbol ? { symbol: params.symbol } : {}),
-    ...(params.limit ? { limit: String(params.limit) } : {}),
-    ...(params.cursor ? { cursor: params.cursor } : {}),
-  })
-  return request<OrdersResponse>(client.config, url, {}, options)
+  return requireProvider(client, params.provider).getOrders(
+    {
+      address: params.address,
+      marketId: params.marketId,
+      limit: params.limit,
+      cursor: params.cursor,
+    },
+    options
+  )
 }

package/src/services/getPositions.ts

@@ -1,26 +1,30 @@
-import type { Address, PositionsResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import type { PositionsResponse } from '@lifi/perps-types'
+import type { Address } from 'viem'
+import { requireProvider } from '../client/requireProvider.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getPositions}.
+ *
+ * @public
+ */
 export interface GetPositionsParams {
-  /** Provider (e.g., 'hyperliquid') */
   provider: string
-  /** Wallet address */
   address: Address
-  /** Optional symbol to filter to a single position */
-  symbol?: string
-  /** Maximum number of results */
+  /** Optional filter — opaque `Market.id` (not `displaySymbol`) */
+  marketId?: string
   limit?: number
-  /** Pagination cursor */
   cursor?: string
 }
 
 /**
- * Get open positions for an account.
+ * Get open positions for an account. Delegates to the registered venue plugin
+ * (direct-to-venue); requires the provider plugin to be registered on the
+ * client.
  *
+ * @throws {PerpsError} When the provider plugin is not registered, or on
+ *   backend / network / parsing errors.
  * @example
  * ```ts
  * const { positions } = await getPositions(client, {
@@ -28,18 +32,20 @@ export interface GetPositionsParams {
  *   address: '0x1234...',
  * })
  * ```
+ * @public
  */
 export async function getPositions(
   client: PerpsSDKClient,
   params: GetPositionsParams,
   options?: SDKRequestOptions
 ): Promise<PositionsResponse> {
-  const url = buildUrl(`${client.config.apiUrl}/positions`, {
-    provider: params.provider,
-    address: params.address,
-    ...(params.symbol ? { symbol: params.symbol } : {}),
-    ...(params.limit ? { limit: String(params.limit) } : {}),
-    ...(params.cursor ? { cursor: params.cursor } : {}),
-  })
-  return request<PositionsResponse>(client.config, url, {}, options)
+  return requireProvider(client, params.provider).getPositions(
+    {
+      address: params.address,
+      marketId: params.marketId,
+      limit: params.limit,
+      cursor: params.cursor,
+    },
+    options
+  )
 }

package/src/services/getPrices.ts

@@ -1,39 +1,24 @@
 import type { PricesResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { buildUrl, request } from '../utils/request.js'
+import { buildUrl, request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
+/**
+ * Parameters for {@link getPrices}.
+ *
+ * @public
+ */
 export interface GetPricesParams {
-  /** Provider to get prices from (e.g., 'hyperliquid') */
   provider: string
-  /** Optional list of symbols to filter (e.g., ['BTC', 'ETH']) */
-  symbols?: string[]
+  /** Optional filter — opaque `Market.id`s (not display symbols). */
+  marketIds?: string[]
 }
 
 /**
- * Get current prices for markets.
- *
- * @param client - The SDK client instance
- * @param params - Request parameters
- * @param options - Request options (e.g., AbortSignal)
- * @returns Map of symbol to price
- * @throws {PerpsError} On API error responses
- * @throws {PerpsError} On network or parsing errors
- *
- * @example
- * ```ts
- * const client = createPerpsClient({ integrator: 'my-app' })
- * const { prices } = await getPrices(client, { provider: 'hyperliquid' })
- * console.log(prices) // { BTC: '95000.00', ETH: '3400.00', ... }
+ * Get current prices for markets, optionally filtered by `Market.id`.
  *
- * // Filter by symbols
- * const { prices } = await getPrices(client, {
- *   provider: 'hyperliquid',
- *   symbols: ['BTC', 'ETH']
- * })
- * ```
+ * @throws {PerpsError} On backend error responses, network, or parsing errors.
+ * @public
  */
 export async function getPrices(
   client: PerpsSDKClient,
@@ -42,7 +27,7 @@ export async function getPrices(
 ): Promise<PricesResponse> {
   const url = buildUrl(`${client.config.apiUrl}/prices`, {
     provider: params.provider,
-    symbols: params.symbols?.join(','),
+    marketIds: params.marketIds?.join(','),
   })
   return request<PricesResponse>(client.config, url, {}, options)
 }

package/src/services/getProviders.ts

@@ -1,15 +1,11 @@
 import type { ProvidersResponse } from '@lifi/perps-types'
-import type {
-  PerpsSDKClient,
-  SDKRequestOptions,
-} from '../client/createPerpsClient.js'
-import { request } from '../utils/request.js'
+import { request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
 
 /**
  * Get all available providers.
  *
- * @param client - The SDK client instance
- * @param options - Request options (e.g., AbortSignal)
  * @returns List of supported providers with their authorization requirements
  * @throws {PerpsError} On API error responses
  * @throws {PerpsError} On network or parsing errors
@@ -20,6 +16,7 @@ import { request } from '../utils/request.js'
  * const { providers } = await getProviders(client)
  * console.log(providers) // [{ key: 'hyperliquid', name: 'Hyperliquid', ... }]
  * ```
+ * @public
  */
 export async function getProviders(
   client: PerpsSDKClient,

package/src/services/getQuote.ts

@@ -0,0 +1,58 @@
+import type { Quote, QuoteSide, TradeType } from '@lifi/perps-types'
+import { requireProvider } from '../client/requireProvider.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
+
+/**
+ * Parameters for {@link getQuote}.
+ *
+ * @public
+ */
+export interface GetQuoteParams {
+  provider: string
+  /** Human `displaySymbol`, e.g. `"BTC"`. */
+  symbol: string
+  side: QuoteSide
+  /** USD notional to fill. */
+  size: number
+  type: TradeType
+}
+
+/**
+ * Get a one-shot fill quote for `size` USD notional of `symbol` on a single
+ * venue: VWAP expected fill, price impact (bps), base-tier taker fee, and
+ * funding (perps only). Delegates to the registered venue plugin, which
+ * resolves the symbol against its own markets (scoped by `type`) and walks its
+ * orderbook. Cross-venue comparison is a consumer-side loop over
+ * `client.providers`.
+ *
+ * @throws {PerpsError} When the provider plugin is not registered, no market
+ *   matches the symbol+type, or on network / parsing errors.
+ * @example
+ * ```ts
+ * const quote = await getQuote(client, {
+ *   provider: 'hyperliquid',
+ *   symbol: 'BTC',
+ *   side: 'buy',
+ *   size: 10_000,
+ *   type: 'perps',
+ * })
+ * console.log(quote.expectedFillPrice, quote.priceImpactBps)
+ * ```
+ * @public
+ */
+export async function getQuote(
+  client: PerpsSDKClient,
+  params: GetQuoteParams,
+  options?: SDKRequestOptions
+): Promise<Quote> {
+  return requireProvider(client, params.provider).getQuote(
+    {
+      symbol: params.symbol,
+      side: params.side,
+      size: params.size,
+      type: params.type,
+    },
+    options
+  )
+}

package/src/services/getTermsAcceptance.ts

@@ -0,0 +1,32 @@
+import type { TermsAcceptanceStatus } from '@lifi/perps-types'
+import type { Address } from 'viem'
+import { buildUrl, request } from '../transport/request.js'
+import type { SDKRequestOptions } from '../types/config.js'
+import type { PerpsSDKClient } from '../types/provider.js'
+
+/**
+ * Get the current Terms of Service (version + full content) and whether the
+ * given address has accepted them. Provider-independent — reads from the
+ * platform `meta` surface, not a venue plugin.
+ *
+ * @param address - Address whose acceptance status to resolve
+ * @throws {PerpsError} On backend error responses, network, or parsing errors.
+ *
+ * @example
+ * ```ts
+ * const client = createPerpsClient({ integrator: 'my-app' })
+ * const terms = await getTermsAcceptance(client, '0x1234...')
+ * if (!terms.accepted) {
+ *   // prompt the user to accept terms.content (version terms.termsVersion)
+ * }
+ * ```
+ * @public
+ */
+export async function getTermsAcceptance(
+  client: PerpsSDKClient,
+  address: Address,
+  options?: SDKRequestOptions
+): Promise<TermsAcceptanceStatus> {
+  const url = buildUrl(`${client.config.apiUrl}/meta/terms`, { address })
+  return request<TermsAcceptanceStatus>(client.config, url, {}, options)
+}