@0xarchive/sdk 1.3.0 → 1.6.0

package/dist/index.js

@@ -34,6 +34,7 @@ __export(index_exports, {
   FundingRateResponseSchema: () => FundingRateResponseSchema,
   FundingRateSchema: () => FundingRateSchema,
   Hip3Client: () => Hip3Client,
+  Hip4Client: () => Hip4Client,
   HyperliquidClient: () => HyperliquidClient,
   InstrumentArrayResponseSchema: () => InstrumentArrayResponseSchema,
   InstrumentResponseSchema: () => InstrumentResponseSchema,
@@ -71,6 +72,7 @@ __export(index_exports, {
   WsErrorSchema: () => WsErrorSchema,
   WsHistoricalBatchSchema: () => WsHistoricalBatchSchema,
   WsHistoricalDataSchema: () => WsHistoricalDataSchema,
+  WsOutcomeSettledSchema: () => WsOutcomeSettledSchema,
   WsPongSchema: () => WsPongSchema,
   WsReplayCompletedSchema: () => WsReplayCompletedSchema,
   WsReplayPausedSchema: () => WsReplayPausedSchema,
@@ -323,7 +325,13 @@ var TradeSchema = import_zod.z.object({
   startPosition: import_zod.z.string().optional(),
   userAddress: import_zod.z.string().optional(),
   makerAddress: import_zod.z.string().optional(),
-  takerAddress: import_zod.z.string().optional()
+  takerAddress: import_zod.z.string().optional(),
+  builderAddress: import_zod.z.string().optional(),
+  builderFee: import_zod.z.string().optional(),
+  deployerFee: import_zod.z.string().optional(),
+  priorityGas: import_zod.z.number().optional(),
+  cloid: import_zod.z.string().optional(),
+  twapId: import_zod.z.number().optional()
 });
 var InstrumentTypeSchema = import_zod.z.enum(["perp", "spot"]);
 var InstrumentSchema = import_zod.z.object({
@@ -392,11 +400,22 @@ var WsChannelSchema = import_zod.z.enum([
   "lighter_candles",
   "lighter_open_interest",
   "lighter_funding",
+  "lighter_l3_orderbook",
   "hip3_orderbook",
   "hip3_trades",
   "hip3_candles",
   "hip3_open_interest",
-  "hip3_funding"
+  "hip3_funding",
+  "hip3_liquidations",
+  "hip4_orderbook",
+  "hip4_trades",
+  "hip4_open_interest",
+  "l4_diffs",
+  "l4_orders",
+  "hip3_l4_diffs",
+  "hip3_l4_orders",
+  "hip4_l4_diffs",
+  "hip4_l4_orders"
 ]);
 var WsConnectionStateSchema = import_zod.z.enum(["connecting", "connected", "disconnected", "reconnecting"]);
 var WsSubscribedSchema = import_zod.z.object({
@@ -492,6 +511,14 @@ var WsStreamStoppedSchema = import_zod.z.object({
   type: import_zod.z.literal("stream_stopped"),
   snapshots_sent: import_zod.z.number()
 });
+var WsOutcomeSettledSchema = import_zod.z.object({
+  type: import_zod.z.literal("outcome_settled"),
+  coin: import_zod.z.string(),
+  outcome_id: import_zod.z.number(),
+  side: import_zod.z.number(),
+  settlement_value: import_zod.z.number().optional(),
+  settlement_at: import_zod.z.string().optional()
+});
 var WsServerMessageSchema = import_zod.z.discriminatedUnion("type", [
   WsSubscribedSchema,
   WsUnsubscribedSchema,
@@ -509,7 +536,8 @@ var WsServerMessageSchema = import_zod.z.discriminatedUnion("type", [
   WsStreamProgressSchema,
   WsHistoricalBatchSchema,
   WsStreamCompletedSchema,
-  WsStreamStoppedSchema
+  WsStreamStoppedSchema,
+  WsOutcomeSettledSchema
 ]);
 var OrderBookResponseSchema = ApiResponseSchema(OrderBookSchema);
 var OrderBookArrayResponseSchema = ApiResponseSchema(import_zod.z.array(OrderBookSchema));
@@ -1059,16 +1087,26 @@ var TradesResource = class {
   /**
    * Get most recent trades for a symbol.
    *
-   * 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.
+   * Note: This method is available on Lighter (`client.lighter.trades.recent()`),
+   * HIP-3 (`client.hyperliquid.hip3.trades.recent()`), and HIP-4
+   * (`client.hyperliquid.hip4.trades.recent()`) which have real-time ingestion.
+   * Hyperliquid uses hourly S3 backfill and does NOT expose a recent endpoint —
+   * calling `client.hyperliquid.trades.recent()` (or the legacy
+   * `client.trades.recent()`) throws a structured `OxArchiveError` rather than
+   * letting the request fail with an opaque JSON parse error.
    *
    * @param symbol - The symbol (e.g., 'BTC', 'ETH')
    * @param limit - Number of trades to return (default: 100)
    * @returns Array of recent trades
+   * @throws {OxArchiveError} When called on the bare Hyperliquid namespace.
    */
   async recent(symbol, limit) {
+    if (this.basePath === "/v1/hyperliquid" || this.basePath === "/v1") {
+      throw new OxArchiveError(
+        "trades.recent() is not available on Hyperliquid (no real-time ingestion). Use client.hyperliquid.trades.list(symbol, { start, end }) with a time range, or call recent() on a real-time namespace: client.hyperliquid.hip3.trades.recent(), client.hyperliquid.hip4.trades.recent(), or client.lighter.trades.recent().",
+        404
+      );
+    }
     const response = await this.http.get(
       `${this.basePath}/trades/${this.coinTransform(symbol)}/recent`,
       { limit },
@@ -1173,6 +1211,61 @@ var Hip3InstrumentsResource = class {
     return response.data;
   }
 };
+var Hip4InstrumentsResource = class {
+  constructor(http, basePath = "/v1/hyperliquid/hip4", coinTransform) {
+    this.http = http;
+    this.basePath = basePath;
+    this.coinTransform = coinTransform || ((c) => encodeURIComponent(c));
+  }
+  coinTransform;
+  async list() {
+    const response = await this.http.get(
+      `${this.basePath}/instruments`
+    );
+    return response.data;
+  }
+  async get(coin) {
+    const response = await this.http.get(
+      `${this.basePath}/instruments/${this.coinTransform(coin)}`
+    );
+    return response.data;
+  }
+};
+var Hip4OutcomesResource = class {
+  constructor(http, basePath = "/v1/hyperliquid/hip4") {
+    this.http = http;
+    this.basePath = basePath;
+  }
+  /** List per-outcome aggregates. `aggregatedOi` is omitted on list responses. */
+  async list(params) {
+    const response = await this.http.get(
+      `${this.basePath}/outcomes`,
+      params
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
+  /** Get a single outcome aggregate. Response includes `aggregatedOi`. */
+  async get(outcomeId) {
+    const response = await this.http.get(
+      `${this.basePath}/outcomes/${outcomeId}`
+    );
+    return response.data;
+  }
+  /**
+   * Look up an outcome aggregate by its synthesized slug. Accepts the
+   * per-outcome slug (`btc-above-78213-may-04-0600`) OR a per-side slug
+   * (`btc-above-78213-yes-may-04-0600`). Response includes `aggregatedOi`.
+   */
+  async getBySlug(slug) {
+    const response = await this.http.get(
+      `${this.basePath}/outcomes/by-slug/${slug}`
+    );
+    return response.data;
+  }
+};
 
 // src/resources/funding.ts
 var FundingResource = class {
@@ -1365,7 +1458,7 @@ var DataQualityResource = class {
   /**
    * Get overall system health status
    *
-   * @returns StatusResponse with overall status, per-exchange status,
+   * @returns StatusResponse with overall status, per-scope status,
    *          per-data-type status, and active incident count
    *
    * @example
@@ -1384,9 +1477,9 @@ var DataQualityResource = class {
   // Coverage Endpoints
   // ===========================================================================
   /**
-   * Get data coverage summary for all exchanges
+   * Get data coverage summary across venue APIs
    *
-   * @returns CoverageResponse with coverage info for all exchanges and data types
+   * @returns CoverageResponse with coverage info for supported venue APIs and data types
    *
    * @example
    * ```typescript
@@ -1403,10 +1496,10 @@ var DataQualityResource = class {
     return this.http.get(`${this.basePath}/coverage`);
   }
   /**
-   * Get data coverage for a specific exchange
+   * Get data coverage for a specific venue scope
    *
-   * @param exchange - Exchange name ('hyperliquid', 'lighter', or 'hip3')
-   * @returns ExchangeCoverage with coverage info for all data types on this exchange
+   * @param exchange - Venue scope ('hyperliquid', 'lighter', 'hip3', or 'hip4')
+   * @returns ExchangeCoverage with coverage info for all data types on this venue scope
    *
    * @example
    * ```typescript
@@ -1420,12 +1513,12 @@ var DataQualityResource = class {
     );
   }
   /**
-   * Get data coverage for a specific symbol on an exchange
+   * Get data coverage for a specific symbol on a venue scope
    *
    * 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', 'lighter', or 'hip3')
+   * @param exchange - Venue scope ('hyperliquid', 'lighter', 'hip3', or 'hip4')
    * @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
@@ -1503,7 +1596,7 @@ var DataQualityResource = class {
   // Latency Endpoints
   // ===========================================================================
   /**
-   * Get current latency metrics for all exchanges
+   * Get current latency metrics for supported venue APIs
    *
    * @returns LatencyResponse with WebSocket, REST API, and data freshness metrics
    *
@@ -1805,7 +1898,7 @@ var L2OrderBookResource = class {
     if (params?.timestamp != null) query.timestamp = params.timestamp;
     if (params?.depth != null) query.depth = params.depth;
     const resp = await this.http.get(
-      `${this.basePath}/orderbook/${encodeURIComponent(coin)}/l2`,
+      `${this.basePath}/orderbook/${coin}/l2`,
       query
     );
     return resp.data;
@@ -1814,7 +1907,7 @@ var L2OrderBookResource = class {
   async history(symbol, params) {
     const coin = this.coinTransform(symbol);
     const resp = await this.http.get(
-      `${this.basePath}/orderbook/${encodeURIComponent(coin)}/l2/history`,
+      `${this.basePath}/orderbook/${coin}/l2/history`,
       params
     );
     return {
@@ -1826,7 +1919,7 @@ var L2OrderBookResource = class {
   async diffs(symbol, params) {
     const coin = this.coinTransform(symbol);
     const resp = await this.http.get(
-      `${this.basePath}/orderbook/${encodeURIComponent(coin)}/l2/diffs`,
+      `${this.basePath}/orderbook/${coin}/l2/diffs`,
       params
     );
     return {
@@ -1919,6 +2012,10 @@ var HyperliquidClient = class {
    * HIP-3 builder-deployed perpetuals (February 2026+)
    */
   hip3;
+  /**
+   * HIP-4 outcome markets (binary YES/NO; May 2026+)
+   */
+  hip4;
   http;
   constructor(http) {
     this.http = http;
@@ -1934,6 +2031,7 @@ var HyperliquidClient = class {
     this.l4Orderbook = new L4OrderBookResource(http, basePath);
     this.l2Orderbook = new L2OrderBookResource(http, basePath);
     this.hip3 = new Hip3Client(http);
+    this.hip4 = new Hip4Client(http);
   }
   /**
    * Get per-symbol data freshness across all data types
@@ -2086,6 +2184,205 @@ var Hip3Client = class {
     };
   }
 };
+var Hip4Client = class {
+  /**
+   * HIP-4 per-side instruments (one row per `#N`).
+   */
+  instruments;
+  /**
+   * HIP-4 per-outcome aggregates (one row per outcome). HIP-4-specific, no HIP-3 analog.
+   */
+  outcomes;
+  /**
+   * L2 orderbook snapshots (Pro+).
+   */
+  orderbook;
+  /**
+   * Trade/fill history.
+   */
+  trades;
+  /**
+   * Open interest (per side).
+   */
+  openInterest;
+  /**
+   * Order history, flow, and TP/SL (Pro+).
+   */
+  orders;
+  /**
+   * L4 orderbook (snapshots, diffs, history).
+   */
+  l4Orderbook;
+  /**
+   * L2 full-depth orderbook (derived from L4).
+   */
+  l2Orderbook;
+  http;
+  constructor(http) {
+    this.http = http;
+    const basePath = "/v1/hyperliquid/hip4";
+    const coinTransform = (c) => encodeURIComponent(c);
+    this.instruments = new Hip4InstrumentsResource(http, basePath, coinTransform);
+    this.outcomes = new Hip4OutcomesResource(http, basePath);
+    this.orderbook = new OrderBookResource(http, basePath, coinTransform);
+    this.trades = new TradesResource(http, basePath, coinTransform);
+    this.openInterest = new OpenInterestResource(http, basePath, coinTransform);
+    this.orders = new OrdersResource(http, basePath, coinTransform);
+    this.l4Orderbook = new L4OrderBookResource(http, basePath, coinTransform);
+    this.l2Orderbook = new L2OrderBookResource(http, basePath, coinTransform);
+  }
+  /** @internal Encode a HIP-4 coin for use in URL paths. */
+  encodeCoin(coin) {
+    return encodeURIComponent(coin);
+  }
+  /**
+   * List per-outcome aggregates. `aggregatedOi` is omitted on list responses.
+   */
+  async listOutcomes(params) {
+    return this.outcomes.list(params);
+  }
+  /**
+   * Get a single outcome aggregate (includes `aggregatedOi`).
+   */
+  async getOutcome(outcomeId) {
+    return this.outcomes.get(outcomeId);
+  }
+  /**
+   * Look up an outcome aggregate by slug. Accepts the per-outcome slug
+   * (e.g. `btc-above-78213-may-04-0600`) OR a per-side slug
+   * (e.g. `btc-above-78213-yes-may-04-0600`). Includes `aggregatedOi`.
+   */
+  async getOutcomeBySlug(slug) {
+    return this.outcomes.getBySlug(slug);
+  }
+  /**
+   * List all per-side instruments (one row per `#N`).
+   */
+  async getInstruments() {
+    return this.instruments.list();
+  }
+  /**
+   * Get a single per-side instrument by coin (e.g. `#0`).
+   */
+  async getInstrument(coin) {
+    return this.instruments.get(coin);
+  }
+  /**
+   * Get current L2 orderbook snapshot for a HIP-4 coin (Pro+).
+   * @param coin Coin string with leading `#` (e.g. `#0`).
+   */
+  async getOrderbook(coin, params) {
+    return this.orderbook.get(coin, params);
+  }
+  /**
+   * Get historical L2 orderbook snapshots for a HIP-4 coin (Pro+).
+   */
+  async getOrderbookHistory(coin, params) {
+    return this.orderbook.history(coin, params);
+  }
+  /**
+   * Get historical fills for a HIP-4 coin.
+   */
+  async getTrades(coin, params) {
+    return this.trades.list(coin, params);
+  }
+  /**
+   * Get most recent N fills for a HIP-4 coin (latest first).
+   */
+  async getTradesRecent(coin, limit) {
+    return this.trades.recent(coin, limit);
+  }
+  /**
+   * Get per-side open interest history for a HIP-4 coin.
+   * Note: `markPrice` on the response is an implied probability (0..1), not USD.
+   */
+  async getOpenInterest(coin, params) {
+    return this.openInterest.history(coin, params);
+  }
+  /**
+   * Get current per-side open interest for a HIP-4 coin.
+   * Note: `markPrice` on the response is an implied probability (0..1), not USD.
+   */
+  async getOpenInterestCurrent(coin) {
+    return this.openInterest.current(coin);
+  }
+  /**
+   * Get combined market summary for a HIP-4 coin.
+   * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
+   */
+  async getSummary(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip4/summary/${this.encodeCoin(coin)}`,
+      void 0,
+      this.http.validationEnabled ? CoinSummaryResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get per-symbol data freshness across all HIP-4 data types.
+   * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
+   */
+  async getFreshness(coin) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip4/freshness/${this.encodeCoin(coin)}`,
+      void 0,
+      this.http.validationEnabled ? CoinFreshnessResponseSchema : void 0
+    );
+    return response.data;
+  }
+  /**
+   * Get mid-price history for a HIP-4 coin.
+   * Note: returned `markPrice`/`midPrice` are probabilities (0..1), not USD.
+   * @param coin Either bare numeric form (`'0'`) or `#`-prefixed form (`'#0'`). The SDK URL-encodes `#` so both work.
+   */
+  async getPrices(coin, params) {
+    const response = await this.http.get(
+      `/v1/hyperliquid/hip4/prices/${this.encodeCoin(coin)}`,
+      params,
+      this.http.validationEnabled ? PriceSnapshotArrayResponseSchema : void 0
+    );
+    return {
+      data: response.data,
+      nextCursor: response.meta.nextCursor
+    };
+  }
+  /**
+   * Get order lifecycle events for a HIP-4 coin (Pro+).
+   */
+  async getOrderHistory(coin, params) {
+    return this.orders.history(coin, params);
+  }
+  /**
+   * Get time-bucketed order-flow aggregates for a HIP-4 coin (Pro+).
+   */
+  async getOrderFlow(coin, params) {
+    return this.orders.flow(coin, params);
+  }
+  /**
+   * Get TP/SL orders for a HIP-4 coin (Pro+).
+   */
+  async getTpsl(coin, params) {
+    return this.orders.tpsl(coin, params);
+  }
+  /**
+   * Get full L4 reconstruction (current) for a HIP-4 coin (Pro+).
+   */
+  async getL4Orderbook(coin, params) {
+    return this.l4Orderbook.get(coin, params);
+  }
+  /**
+   * Get L4 diffs (event stream) for a HIP-4 coin (Pro+).
+   */
+  async getL4Diffs(coin, params) {
+    return this.l4Orderbook.diffs(coin, params);
+  }
+  /**
+   * Get L4 checkpoint history for a HIP-4 coin (Build+; hard cap limit=10).
+   */
+  async getL4History(coin, params) {
+    return this.l4Orderbook.history(coin, params);
+  }
+};
 var LighterClient = class {
   /**
    * Order book data (L2 snapshots)
@@ -2340,7 +2637,9 @@ var OxArchiveWs = class {
   streamCompleteHandlers = [];
   orderbookHandlers = [];
   tradesHandlers = [];
+  liquidationsHandlers = [];
   gapHandlers = [];
+  outcomeSettledHandlers = [];
   constructor(options) {
     this.options = {
       apiKey: options.apiKey,
@@ -2424,7 +2723,7 @@ var OxArchiveWs = class {
     const key = this.subscriptionKey(channel, coin);
     this.subscriptions.add(key);
     if (this.isConnected()) {
-      this.send({ op: "subscribe", channel, coin });
+      this.send({ op: "subscribe", channel, symbol: coin });
     }
   }
   /**
@@ -2458,7 +2757,7 @@ var OxArchiveWs = class {
     const key = this.subscriptionKey(channel, coin);
     this.subscriptions.delete(key);
     if (this.isConnected()) {
-      this.send({ op: "unsubscribe", channel, coin });
+      this.send({ op: "unsubscribe", channel, symbol: coin });
     }
   }
   /**
@@ -2485,6 +2784,49 @@ var OxArchiveWs = class {
   unsubscribeAllTickers() {
     this.unsubscribe("all_tickers");
   }
+  /**
+   * Subscribe to live liquidation events for a coin (Hyperliquid).
+   *
+   * Each message is a fill row with `is_liquidation: true`. Same wire shape as
+   * trades. Live as of v1.6.0 (Hyperliquid + HIP-3 nodes); historical replay
+   * also supported via `replay('liquidations', ...)`.
+   */
+  subscribeLiquidations(coin) {
+    this.subscribe("liquidations", coin);
+  }
+  /** Unsubscribe from live liquidation events (Hyperliquid). */
+  unsubscribeLiquidations(coin) {
+    this.unsubscribe("liquidations", coin);
+  }
+  /**
+   * Subscribe to live HIP-3 liquidation events for a coin.
+   * Each message is a fill row with `is_liquidation: true`.
+   */
+  subscribeHip3Liquidations(coin) {
+    this.subscribe("hip3_liquidations", coin);
+  }
+  /** Unsubscribe from live HIP-3 liquidation events. */
+  unsubscribeHip3Liquidations(coin) {
+    this.unsubscribe("hip3_liquidations", coin);
+  }
+  /**
+   * Subscribe to a HIP-4 channel for a given outcome coin.
+   *
+   * @param channel One of `hip4_orderbook`, `hip4_trades`, `hip4_open_interest`,
+   *   `hip4_l4_diffs`, `hip4_l4_orders`.
+   * @param coin HIP-4 coin (e.g. `'#0'` or `'0'`). The bare numeric form is
+   *   recommended; both are accepted by the backend.
+   */
+  subscribeHip4(channel, coin) {
+    const fullChannel = channel.startsWith("hip4_") ? channel : `hip4_${channel}`;
+    this.subscribe(fullChannel, coin);
+  }
+  /** Unsubscribe from a HIP-4 channel for a given outcome coin. Accepts the
+   * short channel form (`'orderbook'`) or the full form (`'hip4_orderbook'`). */
+  unsubscribeHip4(channel, coin) {
+    const fullChannel = channel.startsWith("hip4_") ? channel : `hip4_${channel}`;
+    this.unsubscribe(fullChannel, coin);
+  }
   // ==========================================================================
   // Historical Replay (Option B) - Like Tardis.dev
   // ==========================================================================
@@ -2507,7 +2849,7 @@ var OxArchiveWs = class {
     this.send({
       op: "replay",
       channel,
-      coin,
+      symbol: coin,
       start: options.start,
       end: options.end,
       speed: options.speed ?? 1,
@@ -2542,7 +2884,7 @@ var OxArchiveWs = class {
     this.send({
       op: "replay",
       channels,
-      coin,
+      symbol: coin,
       start: options.start,
       end: options.end,
       speed: options.speed ?? 1,
@@ -2598,7 +2940,7 @@ var OxArchiveWs = class {
     this.send({
       op: "stream",
       channel,
-      coin,
+      symbol: coin,
       start: options.start,
       end: options.end,
       batch_size: options.batchSize ?? 1e3,
@@ -2635,7 +2977,7 @@ var OxArchiveWs = class {
     this.send({
       op: "stream",
       channels,
-      coin,
+      symbol: coin,
       start: options.start,
       end: options.end,
       batch_size: options.batchSize ?? 1e3,
@@ -2774,6 +3116,44 @@ var OxArchiveWs = class {
   onTrades(handler) {
     this.tradesHandlers.push(handler);
   }
+  /**
+   * Helper to handle live liquidation events for both `liquidations` and
+   * `hip3_liquidations` channels. Each item is a fill row with
+   * `is_liquidation: true`, surfaced as a `Trade` (the wire shape matches
+   * trades exactly).
+   *
+   * @param handler Called with the channel, coin, and parsed Trade array.
+   *
+   * @example
+   * ```typescript
+   * ws.onLiquidations((channel, coin, fills) => {
+   *   for (const f of fills) {
+   *     console.log(`${channel} ${coin} liq: ${f.side} ${f.size}@${f.price}`);
+   *   }
+   * });
+   * ws.subscribeLiquidations('BTC');
+   * ws.subscribeHip3Liquidations('hyna:BTC');
+   * ```
+   */
+  onLiquidations(handler) {
+    this.liquidationsHandlers.push(handler);
+  }
+  /**
+   * Handle HIP-4 outcome settlement events. Pushed once per `(outcome_id, side)`
+   * when the outcome flips to settled. After this event the server proactively
+   * unsubscribes the client from every hip4_* subscription on the settled coin —
+   * treat the event as a terminal signal for that coin.
+   *
+   * @example
+   * ```typescript
+   * ws.onOutcomeSettled((coin, outcomeId, side, value, at) => {
+   *   console.log(`${coin} (outcome ${outcomeId} side ${side}) settled to ${value} at ${at}`);
+   * });
+   * ```
+   */
+  onOutcomeSettled(handler) {
+    this.outcomeSettledHandlers.push(handler);
+  }
   // Private methods
   send(message) {
     if (this.ws?.readyState === WebSocket.OPEN) {
@@ -2901,16 +3281,28 @@ var OxArchiveWs = class {
         break;
       }
       case "data": {
-        if (message.channel === "orderbook") {
+        if (message.channel === "orderbook" || message.channel === "hip3_orderbook" || message.channel === "hip4_orderbook" || message.channel === "lighter_orderbook") {
           const orderbook = transformOrderbook(message.coin, message.data);
           for (const handler of this.orderbookHandlers) {
             handler(message.coin, orderbook);
           }
-        } else if (message.channel === "trades") {
+        } else if (message.channel === "trades" || message.channel === "hip3_trades" || message.channel === "hip4_trades" || message.channel === "lighter_trades") {
           const trades = transformTrades(message.coin, message.data);
           for (const handler of this.tradesHandlers) {
             handler(message.coin, trades);
           }
+        } else if (message.channel === "liquidations" || message.channel === "hip3_liquidations") {
+          const fills = transformTrades(message.coin, message.data);
+          for (const handler of this.liquidationsHandlers) {
+            handler(message.channel, message.coin, fills);
+          }
+        }
+        break;
+      }
+      case "outcome_settled": {
+        const msg = message;
+        for (const handler of this.outcomeSettledHandlers) {
+          handler(msg.coin, msg.outcome_id, msg.side, msg.settlement_value, msg.settlement_at);
         }
         break;
       }
@@ -3063,6 +3455,7 @@ var L4OrderBookReconstructor = class {
   FundingRateResponseSchema,
   FundingRateSchema,
   Hip3Client,
+  Hip4Client,
   HyperliquidClient,
   InstrumentArrayResponseSchema,
   InstrumentResponseSchema,
@@ -3100,6 +3493,7 @@ var L4OrderBookReconstructor = class {
   WsErrorSchema,
   WsHistoricalBatchSchema,
   WsHistoricalDataSchema,
+  WsOutcomeSettledSchema,
   WsPongSchema,
   WsReplayCompletedSchema,
   WsReplayPausedSchema,