@0xarchive/sdk 1.2.0 → 1.4.0

package/README.md

@@ -92,11 +92,11 @@ The `depth` parameter controls how many price levels are returned per side. Tier
 | Tier | Max Depth |
 |------|-----------|
 | Free | 20 |
-| Build | 50 |
-| Pro | 100 |
+| Build | 200 |
+| Pro | Full Depth |
 | Enterprise | Full Depth |
 
-**Note:** Hyperliquid source data only contains 20 levels. Higher limits apply to Lighter.xyz data.
+**Note:** Hyperliquid L2 source data contains 20 levels. Full-depth L2 (derived from L4) and Lighter.xyz provide full depth on Pro+. Depth limits apply to L2 snapshot endpoints only — L4 and L2 diff endpoints return full data.
 
 #### Lighter Orderbook Granularity
 
@@ -568,6 +568,38 @@ while (l3History.nextCursor) {
 }
 ```
 
+### L2 Order Book (Full-Depth)
+
+Access L2 full-depth orderbook derived from L4 data. Available for Hyperliquid and HIP-3.
+
+```typescript
+// L2 full-depth orderbook (Build+ tier)
+const l2 = await client.hyperliquid.l2Orderbook.get('BTC');
+
+// L2 orderbook at a specific timestamp with depth
+const l2Historical = await client.hyperliquid.l2Orderbook.get('BTC', {
+  timestamp: 1704067200000,
+  depth: 50
+});
+
+// L2 orderbook history (Build+ tier)
+const l2History = await client.hyperliquid.l2Orderbook.history('BTC', {
+  start: Date.now() - 86400000,
+  end: Date.now(),
+  limit: 1000
+});
+
+// L2 tick-level diffs (Pro+ tier)
+const l2Diffs = await client.hyperliquid.l2Orderbook.diffs('BTC', {
+  start: Date.now() - 3600000,
+  end: Date.now(),
+  limit: 1000
+});
+
+// HIP-3 L2 orderbook
+const hip3L2 = await client.hyperliquid.hip3.l2Orderbook.get('km:US500');
+```
+
 ### Freshness
 
 Check when each data type was last updated for a specific coin. Useful for verifying data recency before pulling it. Available for all exchanges.
@@ -1066,6 +1098,8 @@ const ws = new OxArchiveWs({
 | `funding` | Funding rate snapshots | Yes | Replay/stream only |
 | `ticker` | Price and 24h volume | Yes | Real-time only |
 | `all_tickers` | All market tickers | No | Real-time only |
+| `l4_diffs` | L4 orderbook diffs with user attribution (Pro+) | Yes | Real-time only |
+| `l4_orders` | Order lifecycle events with user attribution (Pro+) | Yes | Real-time only |
 
 #### HIP-3 Builder Perps Channels
 
@@ -1077,6 +1111,8 @@ const ws = new OxArchiveWs({
 | `hip3_open_interest` | HIP-3 open interest snapshots | Yes | Replay/stream only |
 | `hip3_funding` | HIP-3 funding rate snapshots | Yes | Replay/stream only |
 | `hip3_liquidations` | HIP-3 liquidation events (Feb 2026+) | Yes | Yes (replay only) |
+| `hip3_l4_diffs` | HIP-3 L4 orderbook diffs (Pro+) | Yes | Real-time only |
+| `hip3_l4_orders` | HIP-3 order lifecycle events (Pro+) | Yes | Real-time only |
 
 > **Note:** HIP-3 coins are case-sensitive (e.g., `km:US500`, `xyz:XYZ100`). Do not uppercase them.
 

package/dist/index.d.mts

@@ -132,6 +132,18 @@ interface Trade {
     makerAddress?: string;
     /** Taker's wallet address (for market-level WebSocket trades) */
     takerAddress?: string;
+    /** Builder address that routed this order. Present only when the order was placed through a builder. */
+    builderAddress?: string;
+    /** Builder fee charged on this fill, paid to the builder (in quote currency, typically USDC). Present only when builderAddress is set. */
+    builderFee?: string;
+    /** HIP-3 deployer fee share on this fill (in quote currency). Negative for the maker side (rebate), positive for the taker side. Present only on HIP-3 fills. */
+    deployerFee?: string;
+    /** Priority fee burned in HYPE (not USDC) for write priority on the Hyperliquid validator queue. Independent of builderFee and deployerFee — paid to the network, not to a builder or deployer. Present only when the order paid for priority. */
+    priorityGas?: number;
+    /** Client order ID */
+    cloid?: string;
+    /** TWAP execution ID */
+    twapId?: number;
 }
 /**
  * Cursor-based pagination parameters (recommended)
@@ -2288,6 +2300,49 @@ declare class L4OrderBookResource {
     history(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
 }
 
+interface L2OrderBookParams {
+    timestamp?: number | string;
+    depth?: number;
+}
+/**
+ * L2 Full-Depth Order Book API resource (derived from L4 data)
+ *
+ * Access aggregated price-level orderbook snapshots, history, and tick-level diffs.
+ * Data available from March 10, 2026.
+ *
+ * @example
+ * ```typescript
+ * // Get current full-depth L2 orderbook
+ * const orderbook = await client.hyperliquid.l2Orderbook.get('BTC');
+ *
+ * // Get L2 orderbook at a historical timestamp
+ * const historical = await client.hyperliquid.l2Orderbook.get('BTC', {
+ *   timestamp: 1711900800000
+ * });
+ *
+ * // Get L2 orderbook history
+ * const history = await client.hyperliquid.l2Orderbook.history('BTC', {
+ *   start: Date.now() - 86400000,
+ *   end: Date.now(),
+ *   limit: 100
+ * });
+ * ```
+ */
+declare class L2OrderBookResource {
+    private http;
+    private basePath;
+    private coinTransform;
+    constructor(http: HttpClient, basePath?: string, coinTransform?: (s: string) => string);
+    /** Get full-depth L2 order book snapshot. */
+    get(symbol: string, params?: L2OrderBookParams): Promise<any>;
+    /** Get paginated L2 full-depth history. */
+    history(symbol: string, params: CursorPaginationParams & {
+        depth?: number;
+    }): Promise<CursorResponse<any[]>>;
+    /** Get tick-level L2 order book diffs. */
+    diffs(symbol: string, params: CursorPaginationParams): Promise<CursorResponse<any[]>>;
+}
+
 interface L3OrderBookParams {
     timestamp?: number | string;
     depth?: number;
@@ -2382,6 +2437,10 @@ declare class HyperliquidClient {
      * L4 order book (snapshots, diffs, history)
      */
     readonly l4Orderbook: L4OrderBookResource;
+    /**
+     * L2 full-depth order book (derived from L4)
+     */
+    readonly l2Orderbook: L2OrderBookResource;
     /**
      * HIP-3 builder-deployed perpetuals (February 2026+)
      */
@@ -2461,6 +2520,10 @@ declare class Hip3Client {
      * L4 order book (snapshots, diffs, history)
      */
     readonly l4Orderbook: L4OrderBookResource;
+    /**
+     * L2 full-depth order book (derived from L4)
+     */
+    readonly l2Orderbook: L2OrderBookResource;
     private http;
     constructor(http: HttpClient);
     /**
@@ -3003,6 +3066,109 @@ declare class OxArchiveWs {
     private handleMessage;
 }
 
+/**
+ * L4 order book reconstructor with matching engine.
+ *
+ * Reconstructs Hyperliquid and HIP-3 L4 order books from checkpoints and diffs.
+ * The same class works for both exchanges — the diff format is identical.
+ *
+ * When a new order crosses the spread, the matching engine filled opposite-side
+ * orders at crossing prices. Without removing them, the reconstructed book will
+ * be "crossed" (best bid > best ask).
+ *
+ * Ref: https://github.com/hyperliquid-dex/order_book_server
+ */
+interface L4Order {
+    oid: number;
+    userAddress: string;
+    side: 'B' | 'A';
+    price: number;
+    size: number;
+}
+interface L2Level {
+    px: number;
+    sz: number;
+    n: number;
+}
+interface L4Diff {
+    diff_type?: 'new' | 'update' | 'remove';
+    diffType?: 'new' | 'update' | 'remove';
+    oid: number;
+    side: 'B' | 'A';
+    price: number;
+    new_size?: number | null;
+    newSize?: number | null;
+    user_address?: string;
+    userAddress?: string;
+    block_number?: number;
+    blockNumber?: number;
+}
+interface L4Checkpoint {
+    bids: Array<{
+        oid: number;
+        user_address?: string;
+        userAddress?: string;
+        side: string;
+        price: number;
+        size: number;
+    }>;
+    asks: Array<{
+        oid: number;
+        user_address?: string;
+        userAddress?: string;
+        side: string;
+        price: number;
+        size: number;
+    }>;
+}
+/**
+ * L4 orderbook reconstructor with matching engine.
+ *
+ * Works identically for Hyperliquid and HIP-3 — same diff format,
+ * same checkpoint format, same crossing logic.
+ *
+ * @example
+ * ```typescript
+ * const book = new L4OrderBookReconstructor();
+ * book.loadCheckpoint(checkpoint);
+ *
+ * // Group diffs by block, apply in order
+ * for (const bn of sortedBlockNumbers) {
+ *   const nr = nonRestingByBlock.get(bn);
+ *   for (const diff of blocks.get(bn)!) {
+ *     book.applyDiff(diff, nr);
+ *   }
+ * }
+ *
+ * console.log(book.isCrossed()); // false
+ * const { bids: l2Bids, asks: l2Asks } = book.deriveL2();
+ * ```
+ */
+declare class L4OrderBookReconstructor {
+    private orders;
+    private bidPrices;
+    private askPrices;
+    /** Initialize from an L4 checkpoint. */
+    loadCheckpoint(checkpoint: L4Checkpoint): void;
+    /** Apply a single L4 diff with matching engine. */
+    applyDiff(diff: L4Diff, nonRestingOids?: Set<number>): void;
+    /** Return bids sorted by price descending. */
+    bids(): L4Order[];
+    /** Return asks sorted by price ascending. */
+    asks(): L4Order[];
+    bestBid(): number | null;
+    bestAsk(): number | null;
+    /** Check if the book is crossed. Should be false after correct reconstruction. */
+    isCrossed(): boolean;
+    get bidCount(): number;
+    get askCount(): number;
+    /** Aggregate L4 orders into L2 price levels. */
+    deriveL2(): {
+        bids: L2Level[];
+        asks: L2Level[];
+    };
+}
+
 /**
  * Zod schemas for runtime validation of API responses
  *
@@ -3180,6 +3346,12 @@ declare const TradeSchema: z.ZodObject<{
     userAddress: z.ZodOptional<z.ZodString>;
     makerAddress: z.ZodOptional<z.ZodString>;
     takerAddress: z.ZodOptional<z.ZodString>;
+    builderAddress: z.ZodOptional<z.ZodString>;
+    builderFee: z.ZodOptional<z.ZodString>;
+    deployerFee: z.ZodOptional<z.ZodString>;
+    priorityGas: z.ZodOptional<z.ZodNumber>;
+    cloid: z.ZodOptional<z.ZodString>;
+    twapId: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     coin: string;
     timestamp: string;
@@ -3198,6 +3370,12 @@ declare const TradeSchema: z.ZodObject<{
     userAddress?: string | undefined;
     makerAddress?: string | undefined;
     takerAddress?: string | undefined;
+    builderAddress?: string | undefined;
+    builderFee?: string | undefined;
+    deployerFee?: string | undefined;
+    priorityGas?: number | undefined;
+    cloid?: string | undefined;
+    twapId?: number | undefined;
 }, {
     coin: string;
     timestamp: string;
@@ -3216,6 +3394,12 @@ declare const TradeSchema: z.ZodObject<{
     userAddress?: string | undefined;
     makerAddress?: string | undefined;
     takerAddress?: string | undefined;
+    builderAddress?: string | undefined;
+    builderFee?: string | undefined;
+    deployerFee?: string | undefined;
+    priorityGas?: number | undefined;
+    cloid?: string | undefined;
+    twapId?: number | undefined;
 }>;
 declare const InstrumentTypeSchema: z.ZodEnum<["perp", "spot"]>;
 declare const InstrumentSchema: z.ZodObject<{
@@ -4130,6 +4314,12 @@ declare const TradeArrayResponseSchema: z.ZodObject<{
         userAddress: z.ZodOptional<z.ZodString>;
         makerAddress: z.ZodOptional<z.ZodString>;
         takerAddress: z.ZodOptional<z.ZodString>;
+        builderAddress: z.ZodOptional<z.ZodString>;
+        builderFee: z.ZodOptional<z.ZodString>;
+        deployerFee: z.ZodOptional<z.ZodString>;
+        priorityGas: z.ZodOptional<z.ZodNumber>;
+        cloid: z.ZodOptional<z.ZodString>;
+        twapId: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         coin: string;
         timestamp: string;
@@ -4148,6 +4338,12 @@ declare const TradeArrayResponseSchema: z.ZodObject<{
         userAddress?: string | undefined;
         makerAddress?: string | undefined;
         takerAddress?: string | undefined;
+        builderAddress?: string | undefined;
+        builderFee?: string | undefined;
+        deployerFee?: string | undefined;
+        priorityGas?: number | undefined;
+        cloid?: string | undefined;
+        twapId?: number | undefined;
     }, {
         coin: string;
         timestamp: string;
@@ -4166,6 +4362,12 @@ declare const TradeArrayResponseSchema: z.ZodObject<{
         userAddress?: string | undefined;
         makerAddress?: string | undefined;
         takerAddress?: string | undefined;
+        builderAddress?: string | undefined;
+        builderFee?: string | undefined;
+        deployerFee?: string | undefined;
+        priorityGas?: number | undefined;
+        cloid?: string | undefined;
+        twapId?: number | undefined;
     }>, "many">;
     meta: z.ZodObject<{
         count: z.ZodNumber;
@@ -4199,6 +4401,12 @@ declare const TradeArrayResponseSchema: z.ZodObject<{
         userAddress?: string | undefined;
         makerAddress?: string | undefined;
         takerAddress?: string | undefined;
+        builderAddress?: string | undefined;
+        builderFee?: string | undefined;
+        deployerFee?: string | undefined;
+        priorityGas?: number | undefined;
+        cloid?: string | undefined;
+        twapId?: number | undefined;
     }[];
     success: boolean;
     meta: {
@@ -4225,6 +4433,12 @@ declare const TradeArrayResponseSchema: z.ZodObject<{
         userAddress?: string | undefined;
         makerAddress?: string | undefined;
         takerAddress?: string | undefined;
+        builderAddress?: string | undefined;
+        builderFee?: string | undefined;
+        deployerFee?: string | undefined;
+        priorityGas?: number | undefined;
+        cloid?: string | undefined;
+        twapId?: number | undefined;
     }[];
     success: boolean;
     meta: {
@@ -5462,4 +5676,4 @@ type ValidatedCandle = z.infer<typeof CandleSchema>;
 type ValidatedLiquidation = z.infer<typeof LiquidationSchema>;
 type ValidatedWsServerMessage = z.infer<typeof WsServerMessageSchema>;
 
-export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CoinFreshness, CoinFreshnessResponseSchema, CoinFreshnessSchema, type CoinSummary, CoinSummaryResponseSchema, CoinSummarySchema, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeFreshnessInfo, DataTypeFreshnessInfoSchema, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingHistoryParams, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, type Hip3Instrument, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationVolume, LiquidationVolumeArrayResponseSchema, type LiquidationVolumeParams, LiquidationVolumeSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OiFundingInterval, type OpenInterest, OpenInterestArrayResponseSchema, type OpenInterestHistoryParams, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceHistoryParams, type PriceLevel, PriceLevelSchema, type PriceSnapshot, PriceSnapshotArrayResponseSchema, PriceSnapshotSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SiweChallenge, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type Web3ApiKey, type Web3KeysList, type Web3PaymentRequired, type Web3RevokeResult, type Web3SignupResult, type Web3SubscribeResult, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsGapDetected, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsL4Batch, type WsL4Snapshot, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplaySnapshot, WsReplaySnapshotSchema, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };
+export { type ApiError, type ApiMeta, ApiMetaSchema, type ApiResponse, ApiResponseSchema, type Candle, CandleArrayResponseSchema, type CandleHistoryParams, type CandleInterval, CandleIntervalSchema, CandleSchema, type ClientOptions, type CoinFreshness, CoinFreshnessResponseSchema, CoinFreshnessSchema, type CoinSummary, CoinSummaryResponseSchema, CoinSummarySchema, type CompletenessMetrics, type CoverageGap, type CoverageResponse, type CursorResponse, type DataCadence, type DataFreshness, type DataTypeCoverage, type DataTypeFreshnessInfo, DataTypeFreshnessInfoSchema, type DataTypeStatus, type ExchangeCoverage, type ExchangeLatency, type ExchangeStatus, type FundingHistoryParams, type FundingRate, FundingRateArrayResponseSchema, FundingRateResponseSchema, FundingRateSchema, type GetOrderBookParams, type GetTradesCursorParams, Hip3Client, type Hip3Instrument, HyperliquidClient, type Incident, type IncidentSeverityValue, type IncidentStatusValue, type IncidentsResponse, type Instrument, InstrumentArrayResponseSchema, InstrumentResponseSchema, InstrumentSchema, type InstrumentType, InstrumentTypeSchema, type L2Level, type L2OrderBookParams, L2OrderBookResource, type L4Checkpoint, type L4Diff, type L4Order, L4OrderBookReconstructor, type LatencyResponse, LighterClient, type LighterGranularity, type LighterInstrument, type Liquidation, LiquidationArrayResponseSchema, type LiquidationHistoryParams, LiquidationSchema, LiquidationSideSchema, type LiquidationVolume, LiquidationVolumeArrayResponseSchema, type LiquidationVolumeParams, LiquidationVolumeSchema, type LiquidationsByUserParams, type ListIncidentsParams, type OiFundingInterval, type OpenInterest, OpenInterestArrayResponseSchema, type OpenInterestHistoryParams, OpenInterestResponseSchema, OpenInterestSchema, type OrderBook, OrderBookArrayResponseSchema, type OrderBookHistoryParams, OrderBookReconstructor, OrderBookResponseSchema, OrderBookSchema, type OrderbookDelta, OxArchive, OxArchiveError, OxArchiveWs, type Pagination, type PriceHistoryParams, type PriceLevel, PriceLevelSchema, type PriceSnapshot, PriceSnapshotArrayResponseSchema, PriceSnapshotSchema, type ReconstructOptions, type ReconstructedOrderBook, type RestApiLatency, type SiweChallenge, type SlaActual, type SlaParams, type SlaResponse, type SlaTargets, type StatusResponse, type SymbolCoverageOptions, type SymbolCoverageResponse, type SymbolDataTypeCoverage, type SystemStatusValue, type TickData, type TickHistoryParams, type Timestamp, type TimestampedRecord, TimestampedRecordSchema, type Trade, TradeArrayResponseSchema, type TradeDirection, TradeDirectionSchema, TradeSchema, type TradeSide, TradeSideSchema, type ValidatedApiMeta, type ValidatedCandle, type ValidatedFundingRate, type ValidatedInstrument, type ValidatedLiquidation, type ValidatedOpenInterest, type ValidatedOrderBook, type ValidatedPriceLevel, type ValidatedTrade, type ValidatedWsServerMessage, type Web3ApiKey, type Web3KeysList, type Web3PaymentRequired, type Web3RevokeResult, type Web3SignupResult, type Web3SubscribeResult, type WebSocketLatency, type WsChannel, WsChannelSchema, type WsClientMessage, type WsConnectionState, WsConnectionStateSchema, type WsData, WsDataSchema, type WsError, WsErrorSchema, type WsEventHandlers, type WsGapDetected, type WsHistoricalBatch, WsHistoricalBatchSchema, type WsHistoricalData, WsHistoricalDataSchema, type WsHistoricalTickData, type WsL4Batch, type WsL4Snapshot, type WsOptions, type WsPing, type WsPong, WsPongSchema, type WsReplay, type WsReplayCompleted, WsReplayCompletedSchema, type WsReplayPause, type WsReplayPaused, WsReplayPausedSchema, type WsReplayResume, type WsReplayResumed, WsReplayResumedSchema, type WsReplaySeek, type WsReplaySnapshot, WsReplaySnapshotSchema, type WsReplayStarted, WsReplayStartedSchema, type WsReplayStop, type WsReplayStopped, WsReplayStoppedSchema, type WsServerMessage, WsServerMessageSchema, type WsStream, type WsStreamCompleted, WsStreamCompletedSchema, type WsStreamProgress, WsStreamProgressSchema, type WsStreamStarted, WsStreamStartedSchema, type WsStreamStop, type WsStreamStopped, WsStreamStoppedSchema, type WsSubscribe, type WsSubscribed, WsSubscribedSchema, type WsUnsubscribe, type WsUnsubscribed, WsUnsubscribedSchema, OxArchive as default, reconstructFinal, reconstructOrderBook };