@nktkas/hyperliquid 0.25.1 → 0.25.3

package/src/src/api/subscription/l2Book.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { type DeepImmutable, Integer, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, Integer, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { L2BookResponse } from "../info/l2Book.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to L2 order book events for a specific asset. */
@@ -45,52 +47,9 @@ export const L2BookRequest = /* @__PURE__ */ (() => {
 })();
 export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
 
-/** L2 order book level. */
-const L2BookLevel = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Price. */
-      px: v.pipe(
-        UnsignedDecimal,
-        v.description("Price."),
-      ),
-      /** Total size. */
-      sz: v.pipe(
-        UnsignedDecimal,
-        v.description("Total size."),
-      ),
-      /** Number of individual orders. */
-      n: v.pipe(
-        UnsignedInteger,
-        v.description("Number of individual orders."),
-      ),
-    }),
-    v.description("L2 order book level."),
-  );
-})();
-
 /** Event of L2 order book snapshot. */
 export const L2BookEvent = /* @__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 levels (index 0 = bids, index 1 = asks). */
-      levels: v.pipe(
-        v.tuple([v.array(L2BookLevel), v.array(L2BookLevel)]),
-        v.description("Bid and ask levels (index 0 = bids, index 1 = asks)."),
-      ),
-    }),
-    v.description("Event of L2 order book snapshot."),
-  );
+  return L2BookResponse;
 })();
 export type L2BookEvent = v.InferOutput<typeof L2BookEvent>;
 

package/src/src/api/subscription/notification.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
 // -------------------- Schemas --------------------

package/src/src/api/subscription/openOrders.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { DetailedOrderSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to open order events for a specific user. */
@@ -46,142 +48,7 @@ export const OpenOrdersEvent = /* @__PURE__ */ (() => {
       ),
       /** Array of open orders with additional display information. */
       orders: v.pipe(
-        v.array(
-          /** Open order with additional display information. */
-          v.pipe(
-            v.object({
-              /** 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)."),
-              ),
-              /** Original size at order placement. */
-              origSz: v.pipe(
-                UnsignedDecimal,
-                v.description("Original size at order placement."),
-              ),
-              /** 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."),
-              ),
-              /** Child orders associated with this order. */
-              children: v.pipe(
-                // deno-lint-ignore no-explicit-any
-                v.lazy<any>(() => OpenOrdersEvent.entries.orders),
-                v.description("Child orders associated with this order."),
-              ),
-              /** 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.
-               * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
-               */
-              orderType: v.pipe(
-                v.union([
-                  v.literal("Market"),
-                  v.literal("Limit"),
-                  v.literal("Stop Market"),
-                  v.literal("Stop Limit"),
-                  v.literal("Take Profit Market"),
-                  v.literal("Take Profit Limit"),
-                ]),
-                v.description(
-                  "Order type for market execution." +
-                    '\n- `"Market"`: Executes immediately at the market price. ' +
-                    '\n- `"Limit"`: Executes at the specified limit price or better. ' +
-                    '\n- `"Stop Market"`: Activates as a market order when a stop price is reached. ' +
-                    '\n- `"Stop Limit"`: Activates as a limit order when a stop price is reached. ' +
-                    '\n- `"Take Profit Market"`: Executes as a market order when a take profit price is reached. ' +
-                    '\n- `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached. ',
-                ),
-              ),
-              /**
-               * Time-in-force options.
-               * - `"Gtc"`: Remains active until filled or canceled.
-               * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
-               * - `"Alo"`: Adds liquidity only.
-               * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
-               * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
-               */
-              tif: v.pipe(
-                v.union([
-                  v.union([
-                    v.literal("Gtc"),
-                    v.literal("Ioc"),
-                    v.literal("Alo"),
-                    v.literal("FrontendMarket"),
-                    v.literal("LiquidationMarket"),
-                  ]),
-                  v.null(),
-                ]),
-                v.description(
-                  "Time-in-force options." +
-                    '\n- `"Gtc"`: Remains active until filled or canceled. ' +
-                    '\n- `"Ioc"`: Fills immediately or cancels any unfilled portion. ' +
-                    '\n- `"Alo"`: Adds liquidity only. ' +
-                    '\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI. ' +
-                    '\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.',
-                ),
-              ),
-              /** Client Order ID. */
-              cloid: v.pipe(
-                v.union([v.pipe(Hex, v.length(34)), v.null()]),
-                v.description("Client Order ID."),
-              ),
-            }),
-            v.description("Open order with additional display information."),
-          ),
-        ),
+        v.array(DetailedOrderSchema),
         v.description("Array of open orders with additional display information."),
       ),
     }),
@@ -230,7 +97,7 @@ export function openOrders(
     dex: params.dex ?? "", // same value as in response
   });
   return config.transport.subscribe<OpenOrdersEvent>(payload.type, payload, (e) => {
-    if (e.detail.user === payload.user.toLowerCase() && e.detail.dex === payload.dex) {
+    if (e.detail.user === payload.user && e.detail.dex === payload.dex) {
       listener(e.detail);
     }
   });

package/src/src/api/subscription/orderUpdates.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { OrderProcessingStatusSchema, OrderSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to order updates for a specific user. */
@@ -33,109 +35,9 @@ export const OrderUpdatesEvent = /* @__PURE__ */ (() => {
       v.pipe(
         v.object({
           /** Order details. */
-          order: v.pipe(
-            v.object({
-              /** 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)."),
-              ),
-              /** Original size at order placement. */
-              origSz: v.pipe(
-                UnsignedDecimal,
-                v.description("Original size at order placement."),
-              ),
-              /** Indicates whether the order is reduce-only. */
-              reduceOnly: v.pipe(
-                v.optional(v.literal(true)),
-                v.description("Indicates whether the order is reduce-only."),
-              ),
-              /** Client Order ID. */
-              cloid: v.pipe(
-                v.optional(v.pipe(Hex, v.length(34))),
-                v.description("Client Order ID."),
-              ),
-            }),
-            v.description("Order details."),
-          ),
-          /**
-           * Order processing status.
-           * - `"open"`: Order active and waiting to be filled.
-           * - `"filled"`: Order fully executed.
-           * - `"canceled"`: Order canceled by the user.
-           * - `"triggered"`: Order triggered and awaiting execution.
-           * - `"rejected"`: Order rejected by the system.
-           * - `"marginCanceled"`: Order canceled due to insufficient margin.
-           * - `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault.
-           * - `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap.
-           * - `"selfTradeCanceled"`: Canceled due to self-trade prevention.
-           * - `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position.
-           * - `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled.
-           * - `"delistedCanceled"`: Canceled due to asset delisting.
-           * - `"liquidatedCanceled"`: Canceled due to liquidation.
-           * - `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man's switch).
-           */
-          status: v.pipe(
-            v.union([
-              v.literal("open"),
-              v.literal("filled"),
-              v.literal("canceled"),
-              v.literal("triggered"),
-              v.literal("rejected"),
-              v.literal("marginCanceled"),
-              v.literal("vaultWithdrawalCanceled"),
-              v.literal("openInterestCapCanceled"),
-              v.literal("selfTradeCanceled"),
-              v.literal("reduceOnlyCanceled"),
-              v.literal("siblingFilledCanceled"),
-              v.literal("delistedCanceled"),
-              v.literal("liquidatedCanceled"),
-              v.literal("scheduledCancel"),
-              v.literal("reduceOnlyRejected"),
-            ]),
-            v.description(
-              "Order processing status." +
-                '\n- `"open"`: Order active and waiting to be filled. ' +
-                '\n- `"filled"`: Order fully executed. ' +
-                '\n- `"canceled"`: Order canceled by the user. ' +
-                '\n- `"triggered"`: Order triggered and awaiting execution. ' +
-                '\n- `"rejected"`: Order rejected by the system. ' +
-                '\n- `"marginCanceled"`: Order canceled due to insufficient margin. ' +
-                '\n- `"vaultWithdrawalCanceled"`: Canceled due to a user withdrawal from vault. ' +
-                '\n- `"openInterestCapCanceled"`: Canceled due to order being too aggressive when open interest was at cap. ' +
-                '\n- `"selfTradeCanceled"`: Canceled due to self-trade prevention. ' +
-                '\n- `"reduceOnlyCanceled"`: Canceled reduced-only order that does not reduce position. ' +
-                '\n- `"siblingFilledCanceled"`: Canceled due to sibling ordering being filled. ' +
-                '\n- `"delistedCanceled"`: Canceled due to asset delisting. ' +
-                '\n- `"liquidatedCanceled"`: Canceled due to liquidation. ' +
-                '\n- `"scheduledCancel"`: Canceled due to exceeding scheduled cancel deadline (dead man\'s switch).',
-            ),
-          ),
+          order: OrderSchema,
+          /** Order processing status. */
+          status: OrderProcessingStatusSchema,
           /** Timestamp when the status was last updated (in ms since epoch). */
           statusTimestamp: v.pipe(
             UnsignedInteger,

package/src/src/api/subscription/trades.ts

@@ -1,8 +1,10 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { SubscriptionRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser } from "../_base.js";
+import type { SubscriptionRequestConfig } from "./_base.js";
 import type { Subscription } from "../../transport/base.js";
 
+import { RecentTradesResponse } from "../info/recentTrades.js";
+
 // -------------------- Schemas --------------------
 
 /** Subscription to trade events for a specific asset. */
@@ -27,57 +29,7 @@ export type TradesRequest = v.InferOutput<typeof TradesRequest>;
 
 /** Event of array of trades for a specific asset. */
 export const TradesEvent = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      /** Trade for a specific asset. */
-      v.pipe(
-        v.object({
-          /** Asset symbol (e.g., BTC). */
-          coin: v.pipe(
-            v.string(),
-            v.description("Asset symbol (e.g., BTC)."),
-          ),
-          /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
-          side: v.pipe(
-            v.union([v.literal("B"), v.literal("A")]),
-            v.description('Trade side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-          ),
-          /** Trade price. */
-          px: v.pipe(
-            UnsignedDecimal,
-            v.description("Trade price."),
-          ),
-          /** Trade size. */
-          sz: v.pipe(
-            UnsignedDecimal,
-            v.description("Trade size."),
-          ),
-          /** Trade timestamp (in ms since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Trade timestamp (in ms since epoch)."),
-          ),
-          /** Transaction hash. */
-          hash: v.pipe(
-            v.pipe(Hex, v.length(66)),
-            v.description("Transaction hash."),
-          ),
-          /** Trade ID. */
-          tid: v.pipe(
-            UnsignedInteger,
-            v.description("Trade ID."),
-          ),
-          /** Addresses of users involved in the trade [Maker, Taker]. */
-          users: v.pipe(
-            v.tuple([Address, Address]),
-            v.description("Addresses of users involved in the trade [Maker, Taker]."),
-          ),
-        }),
-        v.description("Trade for a specific asset."),
-      ),
-    ),
-    v.description("Event of array of trades for a specific asset."),
-  );
+  return RecentTradesResponse;
 })();
 export type TradesEvent = v.InferOutput<typeof TradesEvent>;