@0xarchive/sdk 1.6.0 → 1.7.0

package/dist/index.mjs

@@ -12,7 +12,7 @@ var OxArchiveError = class extends Error {
 
 // src/http.ts
 function snakeToCamel(str) {
-  return str.replace(/_([a-z0-9])/g, (_, char) => char.toUpperCase());
+  return str.replace(/_([a-z])/g, (_, char) => char.toUpperCase());
 }
 function transformKeys(obj) {
   if (obj === null || obj === void 0) {
@@ -265,7 +265,7 @@ var OpenInterestSchema = z.object({
   impactBidPrice: z.string().optional(),
   impactAskPrice: z.string().optional()
 });
-var LiquidationSideSchema = z.enum(["B", "S"]);
+var LiquidationSideSchema = z.enum(["A", "B"]);
 var LiquidationSchema = z.object({
   coin: z.string(),
   timestamp: z.string(),
@@ -315,6 +315,11 @@ var WsChannelSchema = z.enum([
   "hip4_orderbook",
   "hip4_trades",
   "hip4_open_interest",
+  "spot_orderbook",
+  "spot_trades",
+  "spot_l4_diffs",
+  "spot_l4_orders",
+  "spot_twap",
   "l4_diffs",
   "l4_orders",
   "hip3_l4_diffs",
@@ -1871,6 +1876,54 @@ var L3OrderBookResource = class {
   }
 };
 
+// src/resources/spot.ts
+var SpotPairsResource = class {
+  constructor(http, basePath = "/v1/hyperliquid/spot", coinTransform = (c) => c.toUpperCase()) {
+    this.http = http;
+    this.basePath = basePath;
+    this.coinTransform = coinTransform;
+  }
+  /** List every active spot pair. */
+  async list() {
+    const response = await this.http.get(
+      `${this.basePath}/pairs`
+    );
+    return response.data;
+  }
+  /**
+   * Get a specific spot pair by dashed symbol (e.g. `HYPE-USDC`).
+   */
+  async get(symbol) {
+    const response = await this.http.get(
+      `${this.basePath}/pairs/${this.coinTransform(symbol)}`
+    );
+    return response.data;
+  }
+};
+var SpotTwapResource = class {
+  constructor(http, basePath = "/v1/hyperliquid/spot", coinTransform = (c) => c.toUpperCase()) {
+    this.http = http;
+    this.basePath = basePath;
+    this.coinTransform = coinTransform;
+  }
+  /** TWAP statuses for a single spot pair. */
+  async bySymbol(symbol, params) {
+    const response = await this.http.get(
+      `${this.basePath}/twap/${this.coinTransform(symbol)}`,
+      params
+    );
+    return { data: response.data, nextCursor: response.meta.nextCursor };
+  }
+  /** TWAP statuses for a single user wallet across every spot pair. */
+  async byUser(user, params) {
+    const response = await this.http.get(
+      `${this.basePath}/twap/user/${user}`,
+      params
+    );
+    return { data: response.data, nextCursor: response.meta.nextCursor };
+  }
+};
+
 // src/exchanges.ts
 var HyperliquidClient = class {
   /**
@@ -2288,6 +2341,45 @@ var Hip4Client = class {
     return this.l4Orderbook.history(coin, params);
   }
 };
+var SpotClient = class {
+  /** Spot pair metadata (one row per dashed symbol). */
+  pairs;
+  /** L2 order book snapshots (live from 2026-05-05). */
+  orderbook;
+  /** Trade history (S3 backfill from 2025-03-22, live since). */
+  trades;
+  /** Order lifecycle events (Pro+; live from 2026-05-05). */
+  orders;
+  /** L4 order book: snapshots, diffs, and checkpoint history. */
+  l4Orderbook;
+  /** TWAP statuses by symbol or by user wallet (Build+). */
+  twap;
+  http;
+  constructor(http) {
+    this.http = http;
+    const basePath = "/v1/hyperliquid/spot";
+    const coinTransform = (c) => c.toUpperCase();
+    this.pairs = new SpotPairsResource(http, basePath, coinTransform);
+    this.orderbook = new OrderBookResource(http, basePath, coinTransform);
+    this.trades = new TradesResource(http, basePath, coinTransform);
+    this.orders = new OrdersResource(http, basePath, coinTransform);
+    this.l4Orderbook = new L4OrderBookResource(http, basePath, coinTransform);
+    this.twap = new SpotTwapResource(http, basePath, coinTransform);
+  }
+  /**
+   * Get per-symbol data freshness across all spot data types.
+   *
+   * @param symbol Dashed canonical (e.g. `HYPE-USDC`).
+   */
+  async freshness(symbol) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/spot/freshness/${symbol.toUpperCase()}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+};
 var LighterClient = class {
   /**
    * Order book data (L2 snapshots)
@@ -2390,6 +2482,12 @@ var OxArchive = class {
    * Lighter.xyz exchange data (August 2025+)
    */
   lighter;
+  /**
+   * Hyperliquid Spot exchange data. Trades backfilled from 2025-03-22;
+   * orderbook, L4, and TWAP statuses live from 2026-05-05. Symbols are
+   * dashed canonical (e.g. `HYPE-USDC`).
+   */
+  spot;
   /**
    * Data quality metrics: status, coverage, incidents, latency, SLA
    */
@@ -2435,6 +2533,7 @@ var OxArchive = class {
     });
     this.hyperliquid = new HyperliquidClient(this.http);
     this.lighter = new LighterClient(this.http);
+    this.spot = new SpotClient(this.http);
     this.dataQuality = new DataQualityResource(this.http);
     this.web3 = new Web3Resource(this.http);
     const legacyBase = "/v1/hyperliquid";
@@ -2714,6 +2813,24 @@ var OxArchiveWs = class {
   unsubscribeHip3Liquidations(coin) {
     this.unsubscribe("hip3_liquidations", coin);
   }
+  /**
+   * Subscribe to a Hyperliquid Spot channel for a given dashed pair.
+   *
+   * @param channel One of `spot_orderbook`, `spot_trades`, `spot_l4_diffs`,
+   *   `spot_l4_orders`, `spot_twap`. The short form (e.g. `'orderbook'`) is
+   *   also accepted and the `spot_` prefix is added automatically.
+   * @param coin Spot dashed canonical symbol (e.g. `'HYPE-USDC'`).
+   */
+  subscribeSpot(channel, coin) {
+    const fullChannel = channel.startsWith("spot_") ? channel : `spot_${channel}`;
+    this.subscribe(fullChannel, coin);
+  }
+  /** Unsubscribe from a Hyperliquid Spot channel for a given dashed pair.
+   * Accepts the short form (`'orderbook'`) or the full form (`'spot_orderbook'`). */
+  unsubscribeSpot(channel, coin) {
+    const fullChannel = channel.startsWith("spot_") ? channel : `spot_${channel}`;
+    this.unsubscribe(fullChannel, coin);
+  }
   /**
    * Subscribe to a HIP-4 channel for a given outcome coin.
    *
@@ -3087,7 +3204,7 @@ var OxArchiveWs = class {
   resubscribe() {
     for (const key of this.subscriptions) {
       const [channel, coin] = key.split(":");
-      this.send({ op: "subscribe", channel, coin });
+      this.send({ op: "subscribe", channel, symbol: coin });
     }
   }
   scheduleReconnect() {
@@ -3186,12 +3303,12 @@ var OxArchiveWs = class {
         break;
       }
       case "data": {
-        if (message.channel === "orderbook" || message.channel === "hip3_orderbook" || message.channel === "hip4_orderbook" || message.channel === "lighter_orderbook") {
+        if (message.channel === "orderbook" || message.channel === "hip3_orderbook" || message.channel === "hip4_orderbook" || message.channel === "lighter_orderbook" || message.channel === "spot_orderbook") {
           const orderbook = transformOrderbook(message.coin, message.data);
           for (const handler of this.orderbookHandlers) {
             handler(message.coin, orderbook);
           }
-        } else if (message.channel === "trades" || message.channel === "hip3_trades" || message.channel === "hip4_trades" || message.channel === "lighter_trades") {
+        } else if (message.channel === "trades" || message.channel === "hip3_trades" || message.channel === "hip4_trades" || message.channel === "lighter_trades" || message.channel === "spot_trades") {
           const trades = transformTrades(message.coin, message.data);
           for (const handler of this.tradesHandlers) {
             handler(message.coin, trades);
@@ -3386,6 +3503,7 @@ export {
   PriceLevelSchema,
   PriceSnapshotArrayResponseSchema,
   PriceSnapshotSchema,
+  SpotClient,
   TimestampedRecordSchema,
   TradeArrayResponseSchema,
   TradeDirectionSchema,