@0xarchive/sdk 0.9.0 → 0.9.2

package/dist/index.mjs

@@ -45,6 +45,14 @@ var HttpClient = class {
   get validationEnabled() {
     return this.validate;
   }
+  /** Base URL for raw requests (used by web3 subscribe) */
+  getBaseUrl() {
+    return this.baseUrl;
+  }
+  /** Timeout in ms for raw requests (used by web3 subscribe) */
+  getTimeout() {
+    return this.timeout;
+  }
   /**
    * Make a GET request to the API
    *
@@ -115,6 +123,66 @@ var HttpClient = class {
       );
     }
   }
+  /**
+   * Make a POST request to the API
+   *
+   * @param path - API endpoint path
+   * @param body - JSON request body
+   * @param schema - Optional Zod schema for validation (used when validation is enabled)
+   */
+  async post(path, body, schema) {
+    const url = `${this.baseUrl}${path}`;
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await fetch(url, {
+        method: "POST",
+        headers: {
+          "X-API-Key": this.apiKey,
+          "Content-Type": "application/json"
+        },
+        body: body ? JSON.stringify(body) : void 0,
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      const rawData = await response.json();
+      const data = transformKeys(rawData);
+      if (!response.ok) {
+        const error = data;
+        const apiResponse = data;
+        throw new OxArchiveError(
+          error.error || `Request failed with status ${response.status}`,
+          response.status,
+          apiResponse.meta?.requestId
+        );
+      }
+      if (this.validate && schema) {
+        const result = schema.safeParse(data);
+        if (!result.success) {
+          const apiResponse = data;
+          throw new OxArchiveError(
+            `Response validation failed: ${result.error.message}`,
+            422,
+            apiResponse.meta?.requestId
+          );
+        }
+        return result.data;
+      }
+      return data;
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof OxArchiveError) {
+        throw error;
+      }
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new OxArchiveError(`Request timeout after ${this.timeout}ms`, 408);
+      }
+      throw new OxArchiveError(
+        error instanceof Error ? error.message : "Unknown error",
+        500
+      );
+    }
+  }
 };
 
 // src/schemas.ts
@@ -1386,6 +1454,147 @@ var DataQualityResource = class {
   }
 };
 
+// src/resources/web3.ts
+var Web3Resource = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Get a SIWE challenge message to sign.
+   *
+   * @param address - Ethereum wallet address
+   * @returns SIWE message and nonce. Sign the message with personal_sign (EIP-191).
+   */
+  async challenge(address) {
+    return this.http.post("/v1/auth/web3/challenge", { address });
+  }
+  /**
+   * Create a free-tier account and get an API key.
+   *
+   * @param message - The SIWE message from {@link challenge}
+   * @param signature - Hex-encoded signature from personal_sign
+   * @returns API key, tier, and wallet address
+   */
+  async signup(message, signature) {
+    return this.http.post("/v1/web3/signup", { message, signature });
+  }
+  /**
+   * List all API keys for the authenticated wallet.
+   *
+   * @param message - The SIWE message from {@link challenge}
+   * @param signature - Hex-encoded signature from personal_sign
+   * @returns List of API keys and wallet address
+   */
+  async listKeys(message, signature) {
+    return this.http.post("/v1/web3/keys", { message, signature });
+  }
+  /**
+   * Revoke a specific API key.
+   *
+   * @param message - The SIWE message from {@link challenge}
+   * @param signature - Hex-encoded signature from personal_sign
+   * @param keyId - UUID of the key to revoke
+   * @returns Confirmation message and wallet address
+   */
+  async revokeKey(message, signature, keyId) {
+    return this.http.post("/v1/web3/keys/revoke", {
+      message,
+      signature,
+      key_id: keyId
+    });
+  }
+  /**
+   * Get pricing info for a paid subscription (x402 flow, step 1).
+   *
+   * Returns the payment details needed to sign a USDC transfer on Base.
+   * After signing, pass the payment signature to {@link subscribe}.
+   *
+   * @param tier - Subscription tier: 'build' ($49/mo) or 'pro' ($199/mo)
+   * @returns Payment details (amount, asset, network, pay-to address)
+   */
+  async subscribeQuote(tier) {
+    const url = `${this.http.getBaseUrl()}/v1/web3/subscribe`;
+    const timeout = this.http.getTimeout();
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+    try {
+      const response = await fetch(url, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ tier }),
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      const rawData = await response.json();
+      const data = transformKeys(rawData);
+      if (response.status === 402) {
+        return data.payment;
+      }
+      throw new OxArchiveError(
+        data.error || `Unexpected status ${response.status}`,
+        response.status
+      );
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof OxArchiveError) throw error;
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new OxArchiveError(`Request timeout after ${timeout}ms`, 408);
+      }
+      throw new OxArchiveError(
+        error instanceof Error ? error.message : "Unknown error",
+        500
+      );
+    }
+  }
+  /**
+   * Complete a paid subscription with a signed x402 payment (step 2).
+   *
+   * Requires a payment signature from signing a USDC transfer (EIP-3009)
+   * for the amount returned by {@link subscribeQuote}.
+   *
+   * @param tier - Subscription tier: 'build' or 'pro'
+   * @param paymentSignature - Signed x402 payment (from EIP-3009 USDC transfer on Base)
+   * @returns API key, tier, expiration, and wallet address
+   */
+  async subscribe(tier, paymentSignature) {
+    const url = `${this.http.getBaseUrl()}/v1/web3/subscribe`;
+    const timeout = this.http.getTimeout();
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+    try {
+      const response = await fetch(url, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "payment-signature": paymentSignature
+        },
+        body: JSON.stringify({ tier }),
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      const rawData = await response.json();
+      const data = transformKeys(rawData);
+      if (!response.ok) {
+        throw new OxArchiveError(
+          data.error || "Subscribe failed",
+          response.status
+        );
+      }
+      return data;
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof OxArchiveError) throw error;
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new OxArchiveError(`Request timeout after ${timeout}ms`, 408);
+      }
+      throw new OxArchiveError(
+        error instanceof Error ? error.message : "Unknown error",
+        500
+      );
+    }
+  }
+};
+
 // src/exchanges.ts
 var HyperliquidClient = class {
   /**
@@ -1505,7 +1714,9 @@ var Hip3Client = class {
    * OHLCV candle data
    */
   candles;
+  http;
   constructor(http) {
+    this.http = http;
     const basePath = "/v1/hyperliquid/hip3";
     const coinTransform = (c) => c;
     this.instruments = new Hip3InstrumentsResource(http, basePath, coinTransform);
@@ -1515,6 +1726,52 @@ var Hip3Client = class {
     this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
     this.candles = new CandlesResource(http, basePath, coinTransform);
   }
+  /**
+   * Get per-coin data freshness across all data types
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @returns Per-coin freshness with last_updated and lag_ms for each data type
+   */
+  async freshness(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/freshness/${coin}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get combined market summary (price, funding, OI) in one call
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @returns Combined market summary
+   */
+  async summary(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/summary/${coin}`,
+      void 0,
+      this.http.validationEnabled ? CoinSummaryResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get mark/oracle/mid price history (projected from OI data)
+   *
+   * @param coin - The coin symbol (case-sensitive, e.g., 'km:US500')
+   * @param params - Time range, cursor, and interval parameters
+   * @returns CursorResponse with price snapshots
+   */
+  async priceHistory(coin, params) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip3/prices/${coin}`,
+      params,
+      this.http.validationEnabled ? PriceSnapshotArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
 };
 var LighterClient = class {
   /**
@@ -1541,7 +1798,9 @@ var LighterClient = class {
    * OHLCV candle data
    */
   candles;
+  http;
   constructor(http) {
+    this.http = http;
     const basePath = "/v1/lighter";
     this.orderbook = new OrderBookResource(http, basePath);
     this.trades = new TradesResource(http, basePath);
@@ -1550,6 +1809,52 @@ var LighterClient = class {
     this.openInterest = new OpenInterestResource(http, basePath);
     this.candles = new CandlesResource(http, basePath);
   }
+  /**
+   * Get per-coin data freshness across all data types
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @returns Per-coin freshness with last_updated and lag_ms for each data type
+   */
+  async freshness(coin) {
+    const response = await this.http.get(
+      `/v1/lighter/freshness/${coin.toUpperCase()}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get combined market summary (price, funding, OI) in one call
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @returns Combined market summary
+   */
+  async summary(coin) {
+    const response = await this.http.get(
+      `/v1/lighter/summary/${coin.toUpperCase()}`,
+      void 0,
+      this.http.validationEnabled ? CoinSummaryResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get mark/oracle price history (projected from OI data)
+   *
+   * @param coin - The coin symbol (e.g., 'BTC', 'ETH')
+   * @param params - Time range, cursor, and interval parameters
+   * @returns CursorResponse with price snapshots
+   */
+  async priceHistory(coin, params) {
+    const response = await this.http.get(
+      `/v1/lighter/prices/${coin.toUpperCase()}`,
+      params,
+      this.http.validationEnabled ? PriceSnapshotArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
 };
 
 // src/client.ts
@@ -1569,6 +1874,10 @@ var OxArchive = class {
    * Data quality metrics: status, coverage, incidents, latency, SLA
    */
   dataQuality;
+  /**
+   * Wallet-based auth: get API keys via SIWE signature
+   */
+  web3;
   /**
    * @deprecated Use client.hyperliquid.orderbook instead
    */
@@ -1607,6 +1916,7 @@ var OxArchive = class {
     this.hyperliquid = new HyperliquidClient(this.http);
     this.lighter = new LighterClient(this.http);
     this.dataQuality = new DataQualityResource(this.http);
+    this.web3 = new Web3Resource(this.http);
     const legacyBase = "/v1/hyperliquid";
     this.orderbook = new OrderBookResource(this.http, legacyBase);
     this.trades = new TradesResource(this.http, legacyBase);