@0xarchive/sdk 0.6.5 → 0.8.0

package/dist/index.mjs

@@ -516,9 +516,10 @@ function reconstructFinal(tickData, depth) {
 
 // src/resources/orderbook.ts
 var OrderBookResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get order book snapshot for a coin
@@ -529,7 +530,7 @@ var OrderBookResource = class {
    */
   async get(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? OrderBookResponseSchema : void 0
     );
@@ -564,7 +565,7 @@ var OrderBookResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}/history`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}/history`,
       params,
       this.http.validationEnabled ? OrderBookArrayResponseSchema : void 0
     );
@@ -604,7 +605,7 @@ var OrderBookResource = class {
    */
   async historyTick(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/orderbook/${coin.toUpperCase()}/history`,
+      `${this.basePath}/orderbook/${this.coinTransform(coin)}/history`,
       {
         ...params,
         granularity: "tick"
@@ -757,9 +758,10 @@ var OrderBookResource = class {
 
 // src/resources/trades.ts
 var TradesResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get trade history for a coin using cursor-based pagination
@@ -793,7 +795,7 @@ var TradesResource = class {
    */
   async list(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/trades/${coin.toUpperCase()}`,
+      `${this.basePath}/trades/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? TradeArrayResponseSchema : void 0
     );
@@ -805,9 +807,10 @@ var TradesResource = class {
   /**
    * Get most recent trades for a coin.
    *
-   * Note: This method is only available for Lighter (client.lighter.trades.recent())
-   * which has real-time data ingestion. Hyperliquid uses hourly backfill so this
-   * endpoint is not available for Hyperliquid.
+   * Note: This method is available for Lighter (client.lighter.trades.recent())
+   * and HIP-3 (client.hyperliquid.hip3.trades.recent()) which have real-time data
+   * ingestion. Hyperliquid uses hourly backfill so this endpoint is not available
+   * for Hyperliquid.
    *
    * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
    * @param limit - Number of trades to return (default: 100)
@@ -815,7 +818,7 @@ var TradesResource = class {
    */
   async recent(coin, limit) {
     const response = await this.http.get(
-      `${this.basePath}/trades/${coin.toUpperCase()}/recent`,
+      `${this.basePath}/trades/${this.coinTransform(coin)}/recent`,
       { limit },
       this.http.validationEnabled ? TradeArrayResponseSchema : void 0
     );
@@ -889,9 +892,10 @@ var LighterInstrumentsResource = class {
 
 // src/resources/funding.ts
 var FundingResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get funding rate history for a coin with cursor-based pagination
@@ -902,7 +906,7 @@ var FundingResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/funding/${coin.toUpperCase()}`,
+      `${this.basePath}/funding/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? FundingRateArrayResponseSchema : void 0
     );
@@ -919,7 +923,7 @@ var FundingResource = class {
    */
   async current(coin) {
     const response = await this.http.get(
-      `/v1/funding/${coin.toUpperCase()}/current`,
+      `${this.basePath}/funding/${this.coinTransform(coin)}/current`,
       void 0,
       this.http.validationEnabled ? FundingRateResponseSchema : void 0
     );
@@ -929,9 +933,10 @@ var FundingResource = class {
 
 // src/resources/openinterest.ts
 var OpenInterestResource = class {
-  constructor(http, basePath = "/v1") {
+  constructor(http, basePath = "/v1", coinTransform = (c) => c.toUpperCase()) {
     this.http = http;
     this.basePath = basePath;
+    this.coinTransform = coinTransform;
   }
   /**
    * Get open interest history for a coin with cursor-based pagination
@@ -942,7 +947,7 @@ var OpenInterestResource = class {
    */
   async history(coin, params) {
     const response = await this.http.get(
-      `${this.basePath}/openinterest/${coin.toUpperCase()}`,
+      `${this.basePath}/openinterest/${this.coinTransform(coin)}`,
       params,
       this.http.validationEnabled ? OpenInterestArrayResponseSchema : void 0
     );
@@ -959,7 +964,7 @@ var OpenInterestResource = class {
    */
   async current(coin) {
     const response = await this.http.get(
-      `/v1/openinterest/${coin.toUpperCase()}/current`,
+      `${this.basePath}/openinterest/${this.coinTransform(coin)}/current`,
       void 0,
       this.http.validationEnabled ? OpenInterestResponseSchema : void 0
     );
@@ -1093,7 +1098,7 @@ var DataQualityResource = class {
   /**
    * Get data coverage for a specific exchange
    *
-   * @param exchange - Exchange name ('hyperliquid' or 'lighter')
+   * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
    * @returns ExchangeCoverage with coverage info for all data types on this exchange
    *
    * @example
@@ -1110,11 +1115,13 @@ var DataQualityResource = class {
   /**
    * Get data coverage for a specific symbol on an exchange
    *
-   * Includes gap detection showing periods where data may be missing.
+   * Includes gap detection, empirical data cadence, and hour-level historical coverage.
+   * Supports optional time bounds for gap detection (default: last 30 days).
    *
-   * @param exchange - Exchange name ('hyperliquid' or 'lighter')
-   * @param symbol - Symbol name (e.g., 'BTC', 'ETH')
-   * @returns SymbolCoverageResponse with per-data-type coverage including gaps
+   * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
+   * @param symbol - Symbol name (e.g., 'BTC', 'ETH', or HIP3 coins like 'xyz:XYZ100')
+   * @param options - Optional time bounds for gap detection window
+   * @returns SymbolCoverageResponse with per-data-type coverage including gaps, cadence, and historical coverage
    *
    * @example
    * ```typescript
@@ -1125,11 +1132,24 @@ var DataQualityResource = class {
    * for (const gap of oi.gaps.slice(0, 3)) {
    *   console.log(`  ${gap.durationMinutes} min gap at ${gap.start}`);
    * }
+   *
+   * // Check cadence
+   * if (btc.dataTypes.orderbook.cadence) {
+   *   console.log(`Cadence: ~${btc.dataTypes.orderbook.cadence.medianIntervalSeconds}s`);
+   * }
+   *
+   * // Time-bounded (last 7 days)
+   * const weekAgo = Date.now() - 7 * 24 * 60 * 60 * 1000;
+   * const btc7d = await client.dataQuality.symbolCoverage('hyperliquid', 'BTC', {
+   *   from: weekAgo,
+   *   to: Date.now(),
+   * });
    * ```
    */
-  async symbolCoverage(exchange, symbol) {
+  async symbolCoverage(exchange, symbol, options) {
     return this.http.get(
-      `${this.basePath}/coverage/${exchange.toLowerCase()}/${symbol.toUpperCase()}`
+      `${this.basePath}/coverage/${exchange.toLowerCase()}/${symbol.toUpperCase()}`,
+      options
     );
   }
   // ===========================================================================
@@ -1251,6 +1271,10 @@ var HyperliquidClient = class {
    * Liquidation events (May 2025+)
    */
   liquidations;
+  /**
+   * HIP-3 builder-deployed perpetuals (Pro+ only, February 2026+)
+   */
+  hip3;
   constructor(http) {
     const basePath = "/v1/hyperliquid";
     this.orderbook = new OrderBookResource(http, basePath);
@@ -1260,6 +1284,33 @@ var HyperliquidClient = class {
     this.openInterest = new OpenInterestResource(http, basePath);
     this.candles = new CandlesResource(http, basePath);
     this.liquidations = new LiquidationsResource(http, basePath);
+    this.hip3 = new Hip3Client(http);
+  }
+};
+var Hip3Client = class {
+  /**
+   * Order book snapshots (February 2026+)
+   */
+  orderbook;
+  /**
+   * Trade/fill history
+   */
+  trades;
+  /**
+   * Funding rates
+   */
+  funding;
+  /**
+   * Open interest
+   */
+  openInterest;
+  constructor(http) {
+    const basePath = "/v1/hyperliquid/hip3";
+    const coinTransform = (c) => c;
+    this.orderbook = new OrderBookResource(http, basePath, coinTransform);
+    this.trades = new TradesResource(http, basePath, coinTransform);
+    this.funding = new FundingResource(http, basePath, coinTransform);
+    this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
   }
 };
 var LighterClient = class {
@@ -1941,6 +1992,7 @@ export {
   FundingRateArrayResponseSchema,
   FundingRateResponseSchema,
   FundingRateSchema,
+  Hip3Client,
   HyperliquidClient,
   InstrumentArrayResponseSchema,
   InstrumentResponseSchema,