@nktkas/hyperliquid 0.25.1 → 0.25.2

package/src/src/api/info/historicalOrders.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { DetailedOrderSchema, OrderProcessingStatusSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -38,192 +40,9 @@ export const HistoricalOrdersResponse = /* @__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."),
-              ),
-              /** 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.array(v.lazy<any>(() => HistoricalOrdersResponse.item.entries.order)),
-                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("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: DetailedOrderSchema,
+          /** Order processing status. */
+          status: OrderProcessingStatusSchema,
           /** Timestamp when the status was last updated (in ms since epoch). */
           statusTimestamp: v.pipe(
             UnsignedInteger,

package/src/src/api/info/isVip.ts

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

package/src/src/api/info/l2Book.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { type DeepImmutable, Integer, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { type DeepImmutable, Integer, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { L2BookLevelSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -47,31 +49,6 @@ 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."),
-  );
-})();
-type L2BookLevel = v.InferOutput<typeof L2BookLevel>;
-
 /**
  * L2 order book snapshot.
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#l2-book-snapshot
@@ -91,7 +68,7 @@ export const L2BookResponse = /* @__PURE__ */ (() => {
       ),
       /** Bid and ask levels (index 0 = bids, index 1 = asks). */
       levels: v.pipe(
-        v.tuple([v.array(L2BookLevel), v.array(L2BookLevel)]),
+        v.tuple([v.array(L2BookLevelSchema), v.array(L2BookLevelSchema)]),
         v.description("Bid and ask levels (index 0 = bids, index 1 = asks)."),
       ),
     }),

package/src/src/api/info/leadingVaults.ts

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

package/src/src/api/info/legalCheck.ts

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

package/src/src/api/info/liquidatable.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { parser } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 

package/src/src/api/info/marginTable.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 

package/src/src/api/info/maxBuilderFee.ts

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

package/src/src/api/info/maxMarketOrderNtls.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { parser, UnsignedDecimal } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { parser, UnsignedDecimal } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 

package/src/src/api/info/meta.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { MarginTableResponse } from "./marginTable.js";
 
 // -------------------- Schemas --------------------
 
@@ -84,42 +86,18 @@ export const MetaResponse = /* @__PURE__ */ (() => {
           v.pipe(
             v.tuple([
               UnsignedInteger,
-              v.object({
-                /** Description of the margin table. */
-                description: v.pipe(
-                  v.string(),
-                  v.description("Description of the margin table."),
-                ),
-                /** Array of margin tiers defining leverage limits. */
-                marginTiers: v.pipe(
-                  v.array(
-                    /** Individual tier in a margin requirements table. */
-                    v.pipe(
-                      v.object({
-                        /** Lower position size boundary for this tier. */
-                        lowerBound: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Lower position size boundary for this tier."),
-                        ),
-                        /** Maximum allowed leverage for this tier. */
-                        maxLeverage: v.pipe(
-                          UnsignedInteger,
-                          v.minValue(1),
-                          v.description("Maximum allowed leverage for this tier."),
-                        ),
-                      }),
-                      v.description("Individual tier in a margin requirements table."),
-                    ),
-                  ),
-                  v.description("Array of margin tiers defining leverage limits."),
-                ),
-              }),
+              MarginTableResponse,
             ]),
             v.description("Tuple of margin table ID and its details."),
           ),
         ),
         v.description("Margin requirement tables for different leverage tiers."),
       ),
+      /** Collateral token index. */
+      collateralToken: v.pipe(
+        UnsignedInteger,
+        v.description("Collateral token index."),
+      ),
     }),
     v.description("Metadata for perpetual assets."),
   );

package/src/src/api/info/metaAndAssetCtxs.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Decimal, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Decimal, type DeepImmutable, parser, UnsignedDecimal } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { MetaResponse } from "./meta.js";
 
 // -------------------- Schemas --------------------
 
@@ -34,98 +36,7 @@ export type MetaAndAssetCtxsRequest = v.InferOutput<typeof MetaAndAssetCtxsReque
 export const MetaAndAssetCtxsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.tuple([
-      /** Metadata for assets. */
-      v.pipe(
-        v.object({
-          /** Trading universes available for perpetual trading. */
-          universe: v.pipe(
-            v.array(
-              /** Trading universe parameters for perpetual asset. */
-              v.pipe(
-                v.object({
-                  /** Minimum decimal places for order sizes. */
-                  szDecimals: v.pipe(
-                    UnsignedInteger,
-                    v.description("Minimum decimal places for order sizes."),
-                  ),
-                  /** Name of the universe. */
-                  name: v.pipe(
-                    v.string(),
-                    v.description("Name of the universe."),
-                  ),
-                  /** Maximum allowed leverage. */
-                  maxLeverage: v.pipe(
-                    UnsignedInteger,
-                    v.minValue(1),
-                    v.description("Maximum allowed leverage."),
-                  ),
-                  /** Unique identifier for the margin requirements table. */
-                  marginTableId: v.pipe(
-                    UnsignedInteger,
-                    v.description("Unique identifier for the margin requirements table."),
-                  ),
-                  /** Indicates if only isolated margin trading is allowed. */
-                  onlyIsolated: v.pipe(
-                    v.optional(v.literal(true)),
-                    v.description("Indicates if only isolated margin trading is allowed."),
-                  ),
-                  /** Indicates if the universe is delisted. */
-                  isDelisted: v.pipe(
-                    v.optional(v.literal(true)),
-                    v.description("Indicates if the universe is delisted."),
-                  ),
-                }),
-                v.description("Trading universe parameters for perpetual asset."),
-              ),
-            ),
-            v.description("Trading universes available for perpetual trading."),
-          ),
-          /** Margin requirement tables for different leverage tiers. */
-          marginTables: v.pipe(
-            v.array(
-              /** Tuple of margin table ID and its details. */
-              v.pipe(
-                v.tuple([
-                  UnsignedInteger,
-                  v.object({
-                    /** Description of the margin table. */
-                    description: v.pipe(
-                      v.string(),
-                      v.description("Description of the margin table."),
-                    ),
-                    /** Array of margin tiers defining leverage limits. */
-                    marginTiers: v.pipe(
-                      v.array(
-                        /** Individual tier in a margin requirements table. */
-                        v.pipe(
-                          v.object({
-                            /** Lower position size boundary for this tier. */
-                            lowerBound: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Lower position size boundary for this tier."),
-                            ),
-                            /** Maximum allowed leverage for this tier. */
-                            maxLeverage: v.pipe(
-                              UnsignedInteger,
-                              v.minValue(1),
-                              v.description("Maximum allowed leverage for this tier."),
-                            ),
-                          }),
-                          v.description("Individual tier in a margin requirements table."),
-                        ),
-                      ),
-                      v.description("Array of margin tiers defining leverage limits."),
-                    ),
-                  }),
-                ]),
-                v.description("Tuple of margin table ID and its details."),
-              ),
-            ),
-            v.description("Margin requirement tables for different leverage tiers."),
-          ),
-        }),
-        v.description("Metadata for assets."),
-      ),
+      MetaResponse,
       /** Array of contexts for each perpetual asset. */
       v.pipe(
         v.array(

package/src/src/api/info/openOrders.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { OrderSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -38,59 +40,7 @@ export type OpenOrdersRequest = v.InferOutput<typeof OpenOrdersRequest>;
  */
 export const OpenOrdersResponse = /* @__PURE__ */ (() => {
   return v.pipe(
-    v.array(
-      /** Open order details. */
-      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."),
-          ),
-          /** Client Order ID. */
-          cloid: v.pipe(
-            v.optional(v.pipe(Hex, v.length(34))),
-            v.description("Client Order ID."),
-          ),
-          /** Indicates if the order is reduce-only. */
-          reduceOnly: v.pipe(
-            v.optional(v.literal(true)),
-            v.description("Indicates if the order is reduce-only."),
-          ),
-        }),
-        v.description("Open order details."),
-      ),
-    ),
+    v.array(OrderSchema),
     v.description("Array of open orders."),
   );
 })();