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

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

@@ -0,0 +1,195 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/** L4 order details. */
+export const L4OrderSchema = /* @__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(
+        v.union([v.literal("B"), v.literal("A")]),
+        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)."),
+      ),
+      /** Condition for triggering the order. */
+      triggerCondition: v.pipe(
+        v.string(),
+        v.description("Condition for triggering the order."),
+      ),
+      /** Indicates if the order is a trigger order. */
+      isTrigger: v.pipe(
+        v.boolean(),
+        v.description("Indicates if the order is a trigger order."),
+      ),
+      /** Trigger price. */
+      triggerPx: v.pipe(
+        UnsignedDecimal,
+        v.description("Trigger price."),
+      ),
+      /** Indicates if the order is a position TP/SL order. */
+      isPositionTpsl: v.pipe(
+        v.boolean(),
+        v.description("Indicates if the order is a position TP/SL order."),
+      ),
+      /** Indicates whether the order is reduce-only. */
+      reduceOnly: v.pipe(
+        v.boolean(),
+        v.description("Indicates whether the order is reduce-only."),
+      ),
+      /**
+       * Order type for market execution.
+       * - `"Market"`: Executes immediately at the market price.
+       * - `"Limit"`: Executes at the specified limit price or better.
+       * - `"Stop Market"`: Activates as a market order when a stop price is reached.
+       * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
+       * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
+       * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
+       */
+      orderType: v.pipe(
+        v.string(),
+        v.description("Order type for market execution."),
+      ),
+      /** Time-in-force option (e.g., "Gtc", "Ioc", "Alo"). */
+      tif: v.pipe(
+        v.nullable(v.string()),
+        v.description("Time-in-force option."),
+      ),
+      /** Client Order ID. */
+      cloid: v.pipe(
+        v.nullable(v.string()),
+        v.description("Client Order ID."),
+      ),
+    }),
+    v.description("L4 order details."),
+  );
+})();
+
+/**
+ * Request L4 orders at a specific price level.
+ */
+export const L4OrdersRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("l4Orders"),
+        v.description("Type of request."),
+      ),
+      /** Asset symbol (e.g., ETH). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., ETH)."),
+      ),
+      /** Price level to query orders at. */
+      px: v.pipe(
+        UnsignedDecimal,
+        v.description("Price level to query orders at."),
+      ),
+    }),
+    v.description("Request L4 orders at a specific price level."),
+  );
+})();
+export type L4OrdersRequest = v.InferOutput<typeof L4OrdersRequest>;
+
+/**
+ * L4 orders snapshot at a specific price level.
+ */
+export const L4OrdersResponse = /* @__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)."),
+      ),
+      /** Array of L4 orders at this price level. */
+      orders: v.pipe(
+        v.array(L4OrderSchema),
+        v.description("Array of L4 orders at this price level."),
+      ),
+    }),
+    v.description("L4 orders snapshot at a specific price level."),
+  );
+})();
+export type L4OrdersResponse = v.InferOutput<typeof L4OrdersResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode l4Orders} function. */
+export type L4OrdersParameters = Omit<v.InferInput<typeof L4OrdersRequest>, "type">;
+
+/**
+ * Request L4 orders at a specific price level.
+ * @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.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { l4Orders } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await l4Orders(
+ *   { transport },
+ *   { coin: "ETH", px: "1000" },
+ * );
+ * ```
+ */
+export function l4Orders(
+  config: InfoRequestConfig,
+  params: DeepImmutable<L4OrdersParameters>,
+  signal?: AbortSignal,
+): Promise<L4OrdersResponse> {
+  const request = parser(L4OrdersRequest)({
+    type: "l4Orders",
+    ...params,
+  });
+  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 { l4Orders } from "./l4Orders.js";
 import { leadingVaults } from "./leadingVaults.js";
 import { legalCheck } from "./legalCheck.js";
 import { liquidatable } from "./liquidatable.js";
@@ -574,6 +575,31 @@ export class InfoClient<T extends IRequestTransport = IRequestTransport> impleme
     return l2Book(this, ...args);
   }
 
+  /**
+   * Request L4 orders at a specific price level.
+   * @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.
+   *
+   * @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", px: "1000" });
+   * ```
+   */
+  l4Orders(
+    ...args: OmitFirst<OverloadedParameters<typeof l4Orders>>
+  ): ReturnType<typeof l4Orders> {
+    return l4Orders(this, ...args);
+  }
+
   /**
    * Request leading vaults for a user.
    * @param params - Parameters specific to the API request.
@@ -1783,6 +1809,7 @@ export type * from "./gossipRootIps.js";
 export type * from "./historicalOrders.js";
 export type * from "./isVip.js";
 export type * from "./l2Book.js";
+export type * from "./l4Orders.js";
 export type * from "./leadingVaults.js";
 export type * from "./legalCheck.js";
 export type * from "./liquidatable.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 "./l4Orders.js";
 export * from "./leadingVaults.js";
 export * from "./legalCheck.js";
 export * from "./liquidatable.js";

package/src/src/api/subscription/allDexsClearinghouseState.ts

@@ -0,0 +1,109 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../_base.js";
+import { ClearinghouseStateResponse } from "../info/clearinghouseState.js";
+
+/** Subscription to clearinghouse state events across all DEXes for a specific user. */
+export const AllDexsClearinghouseStateRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of subscription. */
+      type: v.pipe(
+        v.literal("allDexsClearinghouseState"),
+        v.description("Type of subscription."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Subscription to clearinghouse state events across all DEXes for a specific user."),
+  );
+})();
+export type AllDexsClearinghouseStateRequest = v.InferOutput<typeof AllDexsClearinghouseStateRequest>;
+
+/** Event of clearinghouse state across all DEXes for a specific user. */
+export const AllDexsClearinghouseStateEvent = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** Array of tuples containing DEX name and clearinghouse state. Empty string represents main DEX. */
+      clearinghouseStates: v.pipe(
+        v.array(
+          v.tuple([
+            /** DEX name (empty string for main dex). */
+            v.pipe(
+              v.string(),
+              v.description("DEX name (empty string for main dex)."),
+            ),
+            /** Account summary for perpetual trading. */
+            ClearinghouseStateResponse,
+          ]),
+        ),
+        v.description("Array of tuples containing DEX name and clearinghouse state. Empty string represents main DEX."),
+      ),
+    }),
+    v.description("Event of clearinghouse state across all DEXes for a specific user."),
+  );
+})();
+export type AllDexsClearinghouseStateEvent = v.InferOutput<typeof AllDexsClearinghouseStateEvent>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_types.js";
+import type { Subscription } from "../../transport/base.js";
+
+/** Request parameters for the {@linkcode allDexsClearinghouseState} function. */
+export type AllDexsClearinghouseStateParameters = Omit<v.InferInput<typeof AllDexsClearinghouseStateRequest>, "type">;
+
+/**
+ * Subscribe to clearinghouse state updates across all DEXes for a specific user.
+ * @param config - General configuration for Subscription API subscriptions.
+ * @param params - Parameters specific to the API subscription.
+ * @param listener - A callback function to be called when the event is received.
+ * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { allDexsClearinghouseState } from "@nktkas/hyperliquid/api/subscription";
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await allDexsClearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ */
+export function allDexsClearinghouseState(
+  config: SubscriptionRequestConfig,
+  params: DeepImmutable<AllDexsClearinghouseStateParameters>,
+  listener: (data: AllDexsClearinghouseStateEvent) => void,
+): Promise<Subscription> {
+  const payload = parser(AllDexsClearinghouseStateRequest)({
+    type: "allDexsClearinghouseState",
+    ...params,
+  });
+  return config.transport.subscribe<AllDexsClearinghouseStateEvent>(payload.type, payload, (e) => {
+    if (e.detail.user === payload.user) {
+      listener(e.detail);
+    }
+  });
+}

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

@@ -5,6 +5,7 @@ import type { SubscriptionRequestConfig } from "./_types.js";
 import { activeAssetCtx } from "./activeAssetCtx.js";
 import { activeAssetData } from "./activeAssetData.js";
 import { activeSpotAssetCtx } from "./activeSpotAssetCtx.js";
+import { allDexsClearinghouseState } from "./allDexsClearinghouseState.js";
 import { allMids } from "./allMids.js";
 import { assetCtxs } from "./assetCtxs.js";
 import { bbo } from "./bbo.js";
@@ -41,6 +42,10 @@ export type {
   ActiveSpotAssetCtxEvent as WsActiveSpotAssetCtxEvent,
   ActiveSpotAssetCtxParameters as WsActiveSpotAssetCtxParameters,
 } from "./activeSpotAssetCtx.js";
+export type {
+  AllDexsClearinghouseStateEvent as WsAllDexsClearinghouseStateEvent,
+  AllDexsClearinghouseStateParameters as WsAllDexsClearinghouseStateParameters,
+} from "./allDexsClearinghouseState.js";
 export type { AllMidsEvent as WsAllMidsEvent, AllMidsParameters as WsAllMidsParameters } from "./allMids.js";
 export type { AssetCtxsEvent as WsAssetCtxsEvent, AssetCtxsParameters as WsAssetCtxsParameters } from "./assetCtxs.js";
 export type { BboEvent as WsBboEvent, BboParameters as WsBboParameters } from "./bbo.js";
@@ -206,6 +211,31 @@ export class SubscriptionClient<
     return activeSpotAssetCtx(this, ...args);
   }
 
+  /**
+   * Subscribe to clearinghouse state updates across all DEXes for a specific user.
+   * @param params - Parameters specific to the API subscription.
+   * @param listener - A callback function to be called when the event is received.
+   * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+   *
+   * @throws {TransportError} When the transport layer throws an error.
+   *
+   * @see null
+   * @example
+   * ```ts
+   * import * as hl from "@nktkas/hyperliquid";
+   *
+   * const transport = new hl.WebSocketTransport();
+   *
+   * const client = new hl.SubscriptionClient({ transport });
+   * const sub = await client.allDexsClearinghouseState({ user: "0x..." }, (data) => console.log(data));
+   * ```
+   */
+  allDexsClearinghouseState(
+    ...args: OmitFirst<OverloadedParameters<typeof allDexsClearinghouseState>>
+  ): ReturnType<typeof allDexsClearinghouseState> {
+    return allDexsClearinghouseState(this, ...args);
+  }
+
   /**
    * Subscribe to mid prices for all actively traded assets.
    * @param params - Parameters specific to the API subscription.

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

@@ -29,6 +29,7 @@ export type { SubscriptionRequestConfig } from "./_types.js";
 export * from "./activeAssetCtx.js";
 export * from "./activeAssetData.js";
 export * from "./activeSpotAssetCtx.js";
+export * from "./allDexsClearinghouseState.js";
 export * from "./allMids.js";
 export * from "./assetCtxs.js";
 export * from "./bbo.js";