@nktkas/hyperliquid 0.25.1 → 0.25.2

package/src/src/api/info/orderStatus.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, Hex, parser, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { DetailedOrderSchema, OrderProcessingStatusSchema } from "../_common_schemas.js";
 
 // -------------------- Schemas --------------------
 
@@ -40,7 +42,7 @@ export type OrderStatusRequest = v.InferOutput<typeof OrderStatusRequest>;
  */
 export const OrderStatusResponse = /* @__PURE__ */ (() => {
   return v.pipe(
-    v.union([
+    v.variant("status", [
       v.object({
         /** Indicates that the order was found. */
         status: v.pipe(
@@ -51,192 +53,9 @@ export const OrderStatusResponse = /* @__PURE__ */ (() => {
         order: 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>(() => OrderStatusResponse.options[0].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/perpDeployAuctionStatus.ts

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

package/src/src/api/info/perpDexLimits.ts

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

package/src/src/api/info/perpDexs.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, parser } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 
@@ -39,7 +39,7 @@ export const PerpDexsResponse = /* @__PURE__ */ (() => {
               v.description("Short name of the perpetual dex."),
             ),
             /** Complete name of the perpetual dex. */
-            full_name: v.pipe(
+            fullName: v.pipe(
               v.string(),
               v.description("Complete name of the perpetual dex."),
             ),
@@ -49,11 +49,20 @@ export const PerpDexsResponse = /* @__PURE__ */ (() => {
               v.description("Hex address of the dex deployer."),
             ),
             /** Hex address of the oracle updater, or null if not available. */
-            oracle_updater: v.pipe(
+            oracleUpdater: v.pipe(
               v.nullable(Address),
               v.description("Hex address of the oracle updater, or null if not available."),
             ),
-            override_fee_recipient: v.null(), // FIXME: find out what this field is
+            /** Hex address of the fee recipient, or null if not available. */
+            feeRecipient: v.pipe(
+              v.nullable(Address),
+              v.description("Hex address of the fee recipient, or null if not available."),
+            ),
+            /** Mapping of asset names to their streaming open interest caps. */
+            assetToStreamingOiCap: v.pipe(
+              v.array(v.tuple([v.string(), v.string()])),
+              v.description("Mapping of asset names to their streaming open interest caps."),
+            ),
           }),
           v.description(" Perpetual dex metadata."),
         ),

package/src/src/api/info/perpsAtOpenInterestCap.ts

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

package/src/src/api/info/portfolio.ts

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

package/src/src/api/info/preTransferCheck.ts

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

package/src/src/api/info/predictedFundings.ts

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

package/src/src/api/info/recentTrades.ts

@@ -1,6 +1,6 @@
 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, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 
@@ -34,7 +34,7 @@ export type RecentTradesRequest = v.InferOutput<typeof RecentTradesRequest>;
 export const RecentTradesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Trade details. */
+      /** Trade for a specific asset. */
       v.pipe(
         v.object({
           /** Asset symbol (e.g., BTC). */
@@ -78,7 +78,7 @@ export const RecentTradesResponse = /* @__PURE__ */ (() => {
             v.description("Addresses of users involved in the trade [Maker, Taker]."),
           ),
         }),
-        v.description("Trade details."),
+        v.description("Trade for a specific asset."),
       ),
     ),
     v.description("Array of recent trades."),

package/src/src/api/info/referral.ts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
 
 // -------------------- Schemas --------------------
 
@@ -36,7 +36,7 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
     v.object({
       /** Referrer details. */
       referredBy: v.pipe(
-        v.union([
+        v.nullable(
           v.object({
             /** Referrer address. */
             referrer: v.pipe(
@@ -50,8 +50,7 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
               v.description("Referral code used."),
             ),
           }),
-          v.null(),
-        ]),
+        ),
         v.description("Referrer details."),
       ),
       /** Cumulative traded volume. */
@@ -76,7 +75,7 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
       ),
       /** Current state of the referrer. */
       referrerState: v.pipe(
-        v.union([
+        v.variant("stage", [
           v.object({
             /** Referrer is ready to receive rewards. */
             stage: v.pipe(

package/src/src/api/info/spotClearinghouseState.ts

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

package/src/src/api/info/spotDeployState.ts

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

package/src/src/api/info/spotMeta.ts

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

package/src/src/api/info/spotMetaAndAssetCtxs.ts

@@ -1,6 +1,8 @@
 import * as v from "valibot";
-import { Address, Hex, Integer, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
-import type { InfoRequestConfig } from "./_common.js";
+import { parser, UnsignedDecimal } from "../_base.js";
+import type { InfoRequestConfig } from "./_base.js";
+
+import { SpotMetaResponse } from "./spotMeta.js";
 
 // -------------------- Schemas --------------------
 
@@ -29,114 +31,7 @@ export type SpotMetaAndAssetCtxsRequest = v.InferOutput<typeof SpotMetaAndAssetC
 export const SpotMetaAndAssetCtxsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.tuple([
-      /** Metadata for assets. */
-      v.pipe(
-        v.object({
-          /** Trading universes available for spot trading. */
-          universe: v.pipe(
-            v.array(
-              /** Trading universe details. */
-              v.pipe(
-                v.object({
-                  /** Token indices included in this universe. */
-                  tokens: v.pipe(
-                    v.array(UnsignedInteger),
-                    v.description("Token indices included in this universe."),
-                  ),
-                  /** Name of the universe. */
-                  name: v.pipe(
-                    v.string(),
-                    v.description("Name of the universe."),
-                  ),
-                  /** Unique identifier of the universe. */
-                  index: v.pipe(
-                    UnsignedInteger,
-                    v.description("Unique identifier of the universe."),
-                  ),
-                  /** Indicates if the token is the primary representation in the system. */
-                  isCanonical: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the token is the primary representation in the system."),
-                  ),
-                }),
-                v.description("Trading universe details."),
-              ),
-            ),
-            v.description("Trading universes available for spot trading."),
-          ),
-          /** Tokens available for spot trading. */
-          tokens: v.pipe(
-            v.array(
-              /** Spot token details. */
-              v.pipe(
-                v.object({
-                  /** Name of the token. */
-                  name: v.pipe(
-                    v.string(),
-                    v.description("Name of the token."),
-                  ),
-                  /** Minimum decimal places for order sizes. */
-                  szDecimals: v.pipe(
-                    UnsignedInteger,
-                    v.description("Minimum decimal places for order sizes."),
-                  ),
-                  /** Number of decimals for the token's smallest unit. */
-                  weiDecimals: v.pipe(
-                    UnsignedInteger,
-                    v.description("Number of decimals for the token's smallest unit."),
-                  ),
-                  /** Unique identifier for the token. */
-                  index: v.pipe(
-                    UnsignedInteger,
-                    v.description("Unique identifier for the token."),
-                  ),
-                  /** Token ID. */
-                  tokenId: v.pipe(
-                    Hex,
-                    v.description("Token ID."),
-                  ),
-                  /** Indicates if the token is the primary representation in the system. */
-                  isCanonical: v.pipe(
-                    v.boolean(),
-                    v.description("Indicates if the token is the primary representation in the system."),
-                  ),
-                  /** EVM contract details. */
-                  evmContract: v.pipe(
-                    v.nullable(
-                      v.object({
-                        /** Contract address. */
-                        address: v.pipe(
-                          Address,
-                          v.description("Contract address."),
-                        ),
-                        /** Extra decimals in the token's smallest unit. */
-                        evm_extra_wei_decimals: v.pipe(
-                          Integer,
-                          v.description("Extra decimals in the token's smallest unit."),
-                        ),
-                      }),
-                    ),
-                    v.description("EVM contract details."),
-                  ),
-                  /** Full display name of the token. */
-                  fullName: v.pipe(
-                    v.nullable(v.string()),
-                    v.description("Full display name of the token."),
-                  ),
-                  /** Deployer trading fee share for the token. */
-                  deployerTradingFeeShare: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Deployer trading fee share for the token."),
-                  ),
-                }),
-                v.description("Spot token details."),
-              ),
-            ),
-            v.description("Tokens available for spot trading."),
-          ),
-        }),
-        v.description("Metadata for assets."),
-      ),
+      SpotMetaResponse,
       /** Context for each spot asset. */
       v.pipe(
         v.array(

package/src/src/api/info/spotPairDeployAuctionStatus.ts

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