@nktkas/hyperliquid 0.25.0 → 0.25.2

package/src/src/api/exchange/{_common.ts → _base.ts}

@@ -1,5 +1,5 @@
 import type { IRequestTransport } from "../../transport/base.js";
-import { Address, Hex, Integer, parser, type Prettify } from "../_common.js";
+import { Address, Hex, Integer, parser, type Prettify } from "../_base.js";
 import {
   type AbstractWallet,
   getWalletAddress,

package/src/src/api/exchange/approveAgent.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeUserSignedAction,
@@ -8,7 +8,7 @@ import {
   getSignatureChainId,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -72,7 +72,7 @@ export const ApproveAgentRequest = /* @__PURE__ */ (() => {
 })();
 export type ApproveAgentRequest = v.InferOutput<typeof ApproveAgentRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/approveBuilderFee.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, Percent, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, Percent, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeUserSignedAction,
@@ -8,7 +8,7 @@ import {
   getSignatureChainId,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -72,7 +72,7 @@ export const ApproveBuilderFeeRequest = /* @__PURE__ */ (() => {
 })();
 export type ApproveBuilderFeeRequest = v.InferOutput<typeof ApproveBuilderFeeRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/batchModify.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,9 +6,11 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
+import { PlaceOrderParamsSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /**
@@ -38,103 +40,7 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
                 v.description("Order ID or Client Order ID."),
               ),
               /** New order parameters. */
-              order: v.pipe(
-                v.object({
-                  /** Asset ID. */
-                  a: v.pipe(
-                    UnsignedInteger,
-                    v.description("Asset ID."),
-                  ),
-                  /** Position side (`true` for long, `false` for short). */
-                  b: v.pipe(
-                    v.boolean(),
-                    v.description("Position side (`true` for long, `false` for short)."),
-                  ),
-                  /** Price. */
-                  p: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Price."),
-                  ),
-                  /** Size (in base currency units). */
-                  s: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Size (in base currency units)."),
-                  ),
-                  /** Is reduce-only? */
-                  r: v.pipe(
-                    v.boolean(),
-                    v.description("Is reduce-only?"),
-                  ),
-                  /** Order type. */
-                  t: v.pipe(
-                    v.union([
-                      v.object({
-                        /** Limit order parameters. */
-                        limit: v.pipe(
-                          v.object({
-                            /**
-                             * Time-in-force.
-                             * - `"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.literal("Gtc"),
-                                v.literal("Ioc"),
-                                v.literal("Alo"),
-                                v.literal("FrontendMarket"),
-                                v.literal("LiquidationMarket"),
-                              ]),
-                              v.description(
-                                "Time-in-force." +
-                                  '\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.',
-                              ),
-                            ),
-                          }),
-                          v.description("Limit order parameters."),
-                        ),
-                      }),
-                      v.object({
-                        /** Trigger order parameters. */
-                        trigger: v.pipe(
-                          v.object({
-                            /** Is market order? */
-                            isMarket: v.pipe(
-                              v.boolean(),
-                              v.description("Is market order?"),
-                            ),
-                            /** Trigger price. */
-                            triggerPx: v.pipe(
-                              UnsignedDecimal,
-                              v.description("Trigger price."),
-                            ),
-                            /** Indicates whether it is take profit or stop loss. */
-                            tpsl: v.pipe(
-                              v.union([v.literal("tp"), v.literal("sl")]),
-                              v.description("Indicates whether it is take profit or stop loss."),
-                            ),
-                          }),
-                          v.description("Trigger order parameters."),
-                        ),
-                      }),
-                    ]),
-                    v.description("Order type."),
-                  ),
-                  /** Client Order ID. */
-                  c: v.pipe(
-                    v.optional(v.pipe(Hex, v.length(34))),
-                    v.description("Client Order ID."),
-                  ),
-                }),
-                v.description("New order parameters."),
-              ),
+              order: PlaceOrderParamsSchema,
             })),
             v.description("Order modifications."),
           ),

package/src/src/api/exchange/cDeposit.ts

@@ -1,4 +1,4 @@
-import { type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeUserSignedAction,
@@ -8,7 +8,7 @@ import {
   getSignatureChainId,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -67,7 +67,7 @@ export const CDepositRequest = /* @__PURE__ */ (() => {
 })();
 export type CDepositRequest = v.InferOutput<typeof CDepositRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/cSignerAction.ts

@@ -1,4 +1,4 @@
-import { type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -20,7 +20,7 @@ export const CSignerActionRequest = /* @__PURE__ */ (() => {
     v.object({
       /** Action to perform. */
       action: v.pipe(
-        v.union([
+        v.variant("type", [
           v.object({
             /** Type of action. */
             type: v.pipe(
@@ -69,7 +69,7 @@ export const CSignerActionRequest = /* @__PURE__ */ (() => {
 })();
 export type CSignerActionRequest = v.InferOutput<typeof CSignerActionRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/cValidatorAction.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -20,7 +20,7 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
     v.object({
       /** Action to perform. */
       action: v.pipe(
-        v.union([
+        v.variant("type", [
           v.object({
             /** Type of action. */
             type: v.pipe(
@@ -32,7 +32,7 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
               v.object({
                 /** Validator node IP address. */
                 node_ip: v.pipe(
-                  v.union([
+                  v.nullable(
                     v.object({
                       /** IP address. */
                       Ip: v.pipe(
@@ -41,8 +41,7 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
                         v.description("IP address."),
                       ),
                     }),
-                    v.null(),
-                  ]),
+                  ),
                   v.description("Validator node IP address."),
                 ),
                 /** Validator name. */
@@ -181,7 +180,7 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
 })();
 export type CValidatorActionRequest = v.InferOutput<typeof CValidatorActionRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/cWithdraw.ts

@@ -1,4 +1,4 @@
-import { type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeUserSignedAction,
@@ -8,7 +8,7 @@ import {
   getSignatureChainId,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -67,7 +67,7 @@ export const CWithdrawRequest = /* @__PURE__ */ (() => {
 })();
 export type CWithdrawRequest = v.InferOutput<typeof CWithdrawRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/cancel.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------

package/src/src/api/exchange/cancelByCloid.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------

package/src/src/api/exchange/claimRewards.ts

@@ -1,11 +1,11 @@
-import { parser, UnsignedInteger } from "../_common.js";
+import { parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -49,7 +49,7 @@ export const ClaimRewardsRequest = /* @__PURE__ */ (() => {
 })();
 export type ClaimRewardsRequest = v.InferOutput<typeof ClaimRewardsRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/convertToMultiSigUser.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeUserSignedAction,
@@ -8,7 +8,7 @@ import {
   getSignatureChainId,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -112,7 +112,7 @@ export const ConvertToMultiSigUserRequest = /* @__PURE__ */ (() => {
 })();
 export type ConvertToMultiSigUserRequest = v.InferOutput<typeof ConvertToMultiSigUserRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/createSubAccount.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------

package/src/src/api/exchange/createVault.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------

package/src/src/api/exchange/evmUserModify.ts

@@ -1,4 +1,4 @@
-import { type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import { type DeepImmutable, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,7 +6,7 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -55,7 +55,7 @@ export const EvmUserModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type EvmUserModifyRequest = v.InferOutput<typeof EvmUserModifyRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/modify.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
@@ -6,9 +6,11 @@ import {
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
+import { PlaceOrderParamsSchema } from "../_common_schemas.js";
+
 // -------------------- Schemas --------------------
 
 /**
@@ -35,103 +37,7 @@ export const ModifyRequest = /* @__PURE__ */ (() => {
             v.description("Order ID or Client Order ID."),
           ),
           /** New order parameters. */
-          order: v.pipe(
-            v.object({
-              /** Asset ID. */
-              a: v.pipe(
-                UnsignedInteger,
-                v.description("Asset ID."),
-              ),
-              /** Position side (`true` for long, `false` for short). */
-              b: v.pipe(
-                v.boolean(),
-                v.description("Position side (`true` for long, `false` for short)."),
-              ),
-              /** Price. */
-              p: v.pipe(
-                UnsignedDecimal,
-                v.description("Price."),
-              ),
-              /** Size (in base currency units). */
-              s: v.pipe(
-                UnsignedDecimal,
-                v.description("Size (in base currency units)."),
-              ),
-              /** Is reduce-only? */
-              r: v.pipe(
-                v.boolean(),
-                v.description("Is reduce-only?"),
-              ),
-              /** Order type. */
-              t: v.pipe(
-                v.union([
-                  v.object({
-                    /** Limit order parameters. */
-                    limit: v.pipe(
-                      v.object({
-                        /**
-                         * Time-in-force.
-                         * - `"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.literal("Gtc"),
-                            v.literal("Ioc"),
-                            v.literal("Alo"),
-                            v.literal("FrontendMarket"),
-                            v.literal("LiquidationMarket"),
-                          ]),
-                          v.description(
-                            "Time-in-force." +
-                              '\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.',
-                          ),
-                        ),
-                      }),
-                      v.description("Limit order parameters."),
-                    ),
-                  }),
-                  v.object({
-                    /** Trigger order parameters. */
-                    trigger: v.pipe(
-                      v.object({
-                        /** Is market order? */
-                        isMarket: v.pipe(
-                          v.boolean(),
-                          v.description("Is market order?"),
-                        ),
-                        /** Trigger price. */
-                        triggerPx: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Trigger price."),
-                        ),
-                        /** Indicates whether it is take profit or stop loss. */
-                        tpsl: v.pipe(
-                          v.union([v.literal("tp"), v.literal("sl")]),
-                          v.description("Indicates whether it is take profit or stop loss."),
-                        ),
-                      }),
-                      v.description("Trigger order parameters."),
-                    ),
-                  }),
-                ]),
-                v.description("Order type."),
-              ),
-              /** Client Order ID. */
-              c: v.pipe(
-                v.optional(v.pipe(Hex, v.length(34))),
-                v.description("Client Order ID."),
-              ),
-            }),
-            v.description("New order parameters."),
-          ),
+          order: PlaceOrderParamsSchema,
         }),
         v.description("Action to perform."),
       ),
@@ -161,7 +67,7 @@ export const ModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type ModifyRequest = v.InferOutput<typeof ModifyRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------

package/src/src/api/exchange/multiSig.ts

@@ -1,4 +1,4 @@
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeMultiSigAction,
@@ -6,11 +6,9 @@ import {
   type ExtractRequestOptions,
   getSignatureChainId,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
-// -------------------- Schemas --------------------
-
 import { ApproveAgentRequest } from "./approveAgent.js";
 import { ApproveBuilderFeeRequest } from "./approveBuilderFee.js";
 import { BatchModifyRequest } from "./batchModify.js";
@@ -53,6 +51,8 @@ import { UsdSendRequest } from "./usdSend.js";
 import { VaultModifyRequest } from "./vaultModify.js";
 import { VaultTransferRequest } from "./vaultTransfer.js";
 
+// -------------------- Schemas --------------------
+
 /**
  * A multi-signature request.
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
@@ -95,7 +95,7 @@ export const MultiSigRequest = /* @__PURE__ */ (() => {
               ),
               /** The underlying action to be executed through multi-sig. */
               action: v.pipe(
-                v.union([
+                v.variant("type", [
                   ApproveAgentRequest.entries.action,
                   ApproveBuilderFeeRequest.entries.action,
                   BatchModifyRequest.entries.action,
@@ -172,7 +172,7 @@ export const MultiSigRequest = /* @__PURE__ */ (() => {
 })();
 export type MultiSigRequest = v.InferOutput<typeof MultiSigRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export {
   CancelSuccessResponse,
   CreateSubAccountResponse,

package/src/src/api/exchange/noop.ts

@@ -1,11 +1,11 @@
-import { parser, UnsignedInteger } from "../_common.js";
+import { parser, UnsignedInteger } from "../_base.js";
 import {
   type ExchangeRequestConfig,
   executeL1Action,
   type ExtractRequestOptions,
   type MultiSignRequestConfig,
   Signature,
-} from "./_common.js";
+} from "./_base.js";
 import * as v from "valibot";
 
 // -------------------- Schemas --------------------
@@ -49,7 +49,7 @@ export const NoopRequest = /* @__PURE__ */ (() => {
 })();
 export type NoopRequest = v.InferOutput<typeof NoopRequest>;
 
-import { SuccessResponse } from "./_common.js";
+import { SuccessResponse } from "./_base.js";
 export { SuccessResponse };
 
 // -------------------- Function --------------------