@hfunlabs/hyperliquid 0.27.1-hfunlabs.3 → 0.27.1-hfunlabs.5

package/src/src/api/info/l3Orders.ts

@@ -0,0 +1,201 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+export const SideSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([v.literal("B"), v.literal("A")]),
+    v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+  );
+})();
+export type Side = v.InferOutput<typeof SideSchema>;
+
+/** L3 order details. */
+export const L3OrderSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** Asset symbol. */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol."),
+      ),
+      /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+      side: v.pipe(
+        SideSchema,
+        v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+      ),
+      /** Limit price. */
+      limitPx: v.pipe(
+        UnsignedDecimal,
+        v.description("Limit price."),
+      ),
+      /** Size. */
+      sz: v.pipe(
+        UnsignedDecimal,
+        v.description("Size."),
+      ),
+      /** Order ID. */
+      oid: v.pipe(
+        UnsignedInteger,
+        v.description("Order ID."),
+      ),
+      /** Timestamp when the order was placed (in ms since epoch). */
+      timestamp: v.pipe(
+        UnsignedInteger,
+        v.description("Timestamp when the order was placed (in ms since epoch)."),
+      ),
+    }),
+    v.description("L3 order details."),
+  );
+})();
+export type L3Order = v.InferOutput<typeof L3OrderSchema>;
+
+/**
+ * Request L3 orders within a price range.
+ */
+export const L3OrdersRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("l3Orders"),
+        v.description("Type of request."),
+      ),
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Minimum price (inclusive). */
+      pxMin: v.pipe(
+        UnsignedDecimal,
+        v.description("Minimum price (inclusive)."),
+      ),
+      /** Maximum price (inclusive). */
+      pxMax: v.pipe(
+        UnsignedDecimal,
+        v.description("Maximum price (inclusive)."),
+      ),
+    }),
+    v.description("Request L3 orders within a price range."),
+  );
+})();
+export type L3OrdersRequest = v.InferOutput<typeof L3OrdersRequest>;
+
+/**
+ * L3 orders within a price range.
+ */
+export const L3OrdersResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Asset symbol. */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol."),
+      ),
+      /** Timestamp of the snapshot (in ms since epoch). */
+      time: v.pipe(
+        UnsignedInteger,
+        v.description("Timestamp of the snapshot (in ms since epoch)."),
+      ),
+      /** Bid and ask orders (index 0 = bids, index 1 = asks). */
+      orders: v.pipe(
+        v.tuple([v.array(L3OrderSchema), v.array(L3OrderSchema)]),
+        v.description("Bid and ask orders (index 0 = bids, index 1 = asks)."),
+      ),
+    }),
+    v.description("L3 orders snapshot for a price range."),
+  );
+})();
+export type L3OrdersResponse = v.InferOutput<typeof L3OrdersResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode l3Orders} function. */
+export const L3OrdersParametersSchema = /* @__PURE__ */ (() => {
+  return v.union([
+    v.object({
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Price level to query orders at. (Deprecated; use `pxMin`/`pxMax`.) */
+      px: v.pipe(
+        UnsignedDecimal,
+        v.description("Price level to query orders at. (Deprecated; use `pxMin`/`pxMax`.)"),
+      ),
+    }),
+    v.object({
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Minimum price (inclusive). */
+      pxMin: v.pipe(
+        UnsignedDecimal,
+        v.description("Minimum price (inclusive)."),
+      ),
+      /** Maximum price (inclusive). */
+      pxMax: v.pipe(
+        UnsignedDecimal,
+        v.description("Maximum price (inclusive)."),
+      ),
+    }),
+  ]);
+})();
+export type L3OrdersParameters = v.InferInput<typeof L3OrdersParametersSchema>;
+
+/**
+ * Request L3 orders within a price range.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns L3 orders snapshot for a price range.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { l3Orders } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await l3Orders(
+ *   { transport },
+ *   { coin: "BTC", pxMin: "35000", pxMax: "37000" },
+ * );
+ * ```
+ */
+export function l3Orders(
+  config: InfoRequestConfig,
+  params: DeepImmutable<L3OrdersParameters>,
+  signal?: AbortSignal,
+): Promise<L3OrdersResponse> {
+  const parsedParams = parser(L3OrdersParametersSchema)(params);
+  const pxMin = "px" in parsedParams ? parsedParams.px : parsedParams.pxMin;
+  const pxMax = "px" in parsedParams ? parsedParams.px : parsedParams.pxMax;
+  const request = parser(L3OrdersRequest)({
+    type: "l3Orders",
+    coin: parsedParams.coin,
+    pxMin,
+    pxMax,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/l4Orders.ts

@@ -99,7 +99,7 @@ export const L4OrderSchema = /* @__PURE__ */ (() => {
 })();
 
 /**
- * Request L4 orders at a specific price level.
+ * Request L4 orders within a price range.
  */
 export const L4OrdersRequest = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -114,13 +114,18 @@ export const L4OrdersRequest = /* @__PURE__ */ (() => {
         v.string(),
         v.description("Asset symbol (e.g., ETH)."),
       ),
-      /** Price level to query orders at. */
-      px: v.pipe(
+      /** Minimum price (inclusive). */
+      pxMin: v.pipe(
+        UnsignedDecimal,
+        v.description("Minimum price (inclusive)."),
+      ),
+      /** Maximum price (inclusive). */
+      pxMax: v.pipe(
         UnsignedDecimal,
-        v.description("Price level to query orders at."),
+        v.description("Maximum price (inclusive)."),
       ),
     }),
-    v.description("Request L4 orders at a specific price level."),
+    v.description("Request L4 orders within a price range."),
   );
 })();
 export type L4OrdersRequest = v.InferOutput<typeof L4OrdersRequest>;
@@ -159,14 +164,47 @@ export type L4OrdersResponse = v.InferOutput<typeof L4OrdersResponse>;
 import type { InfoRequestConfig } from "./_types.js";
 
 /** Request parameters for the {@linkcode l4Orders} function. */
-export type L4OrdersParameters = Omit<v.InferInput<typeof L4OrdersRequest>, "type">;
+export const L4OrdersParametersSchema = /* @__PURE__ */ (() => {
+  return v.union([
+    v.object({
+      /** Asset symbol (e.g., ETH). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., ETH)."),
+      ),
+      /** Price level to query orders at. (Deprecated; use `pxMin`/`pxMax`.) */
+      px: v.pipe(
+        UnsignedDecimal,
+        v.description("Price level to query orders at. (Deprecated; use `pxMin`/`pxMax`.)"),
+      ),
+    }),
+    v.object({
+      /** Asset symbol (e.g., ETH). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., ETH)."),
+      ),
+      /** Minimum price (inclusive). */
+      pxMin: v.pipe(
+        UnsignedDecimal,
+        v.description("Minimum price (inclusive)."),
+      ),
+      /** Maximum price (inclusive). */
+      pxMax: v.pipe(
+        UnsignedDecimal,
+        v.description("Maximum price (inclusive)."),
+      ),
+    }),
+  ]);
+})();
+export type L4OrdersParameters = v.InferInput<typeof L4OrdersParametersSchema>;
 
 /**
- * Request L4 orders at a specific price level.
+ * Request L4 orders within a price range.
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
  * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
- * @returns L4 orders snapshot at a specific price level.
+ * @returns L4 orders snapshot for a price range.
  *
  * @throws {TransportError} When the transport layer throws an error.
  *
@@ -178,7 +216,7 @@ export type L4OrdersParameters = Omit<v.InferInput<typeof L4OrdersRequest>, "typ
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  * const data = await l4Orders(
  *   { transport },
- *   { coin: "ETH", px: "1000" },
+ *   { coin: "ETH", pxMin: "900", pxMax: "1100" },
  * );
  * ```
  */
@@ -187,9 +225,14 @@ export function l4Orders(
   params: DeepImmutable<L4OrdersParameters>,
   signal?: AbortSignal,
 ): Promise<L4OrdersResponse> {
+  const parsedParams = parser(L4OrdersParametersSchema)(params);
+  const pxMin = "px" in parsedParams ? parsedParams.px : parsedParams.pxMin;
+  const pxMax = "px" in parsedParams ? parsedParams.px : parsedParams.pxMax;
   const request = parser(L4OrdersRequest)({
     type: "l4Orders",
-    ...params,
+    coin: parsedParams.coin,
+    pxMin,
+    pxMax,
   });
   return config.transport.request("info", request, signal);
-}
+}

package/src/src/api/info/~client.ts

@@ -21,6 +21,7 @@ import { gossipRootIps } from "./gossipRootIps.js";
 import { historicalOrders } from "./historicalOrders.js";
 import { isVip } from "./isVip.js";
 import { l2Book } from "./l2Book.js";
+import { l3Orders } from "./l3Orders.js";
 import { l4Orders } from "./l4Orders.js";
 import { leadingVaults } from "./leadingVaults.js";
 import { legalCheck } from "./legalCheck.js";
@@ -576,10 +577,10 @@ export class InfoClient<T extends IRequestTransport = IRequestTransport> impleme
   }
 
   /**
-   * Request L4 orders at a specific price level.
+   * Request L3 orders within a price range.
    * @param params - Parameters specific to the API request.
    * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
-   * @returns L4 orders snapshot at a specific price level.
+   * @returns L3 orders snapshot for a price range.
    *
    * @throws {TransportError} When the transport layer throws an error.
    *
@@ -591,7 +592,32 @@ export class InfoClient<T extends IRequestTransport = IRequestTransport> impleme
    * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
    *
    * const client = new hl.InfoClient({ transport });
-   * const data = await client.l4Orders({ coin: "ETH", px: "1000" });
+   * const data = await client.l3Orders({ coin: "BTC", pxMin: "35000", pxMax: "37000" });
+   * ```
+   */
+  l3Orders(
+    ...args: OmitFirst<OverloadedParameters<typeof l3Orders>>
+  ): ReturnType<typeof l3Orders> {
+    return l3Orders(this, ...args);
+  }
+
+  /**
+   * Request L4 orders within a price range.
+   * @param params - Parameters specific to the API request.
+   * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+   * @returns L4 orders snapshot for a price range.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.HttpTransport(); // or `WebSocketTransport`
+   *
+   * const client = new hl.InfoClient({ transport });
+   * const data = await client.l4Orders({ coin: "ETH", pxMin: "900", pxMax: "1100" });
    * ```
    */
   l4Orders(
@@ -1809,6 +1835,7 @@ export type * from "./gossipRootIps.js";
 export type * from "./historicalOrders.js";
 export type * from "./isVip.js";
 export type * from "./l2Book.js";
+export type * from "./l3Orders.js";
 export type * from "./l4Orders.js";
 export type * from "./leadingVaults.js";
 export type * from "./legalCheck.js";

package/src/src/api/info/~mod.ts

@@ -43,6 +43,7 @@ export * from "./gossipRootIps.js";
 export * from "./historicalOrders.js";
 export * from "./isVip.js";
 export * from "./l2Book.js";
+export * from "./l3Orders.js";
 export * from "./l4Orders.js";
 export * from "./leadingVaults.js";
 export * from "./legalCheck.js";