@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.0-hfunlabs.1

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

@@ -4,15 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address } from "../../_schemas.js";
-import {
-  ErrorResponse,
-  HyperliquidChain,
-  Nonce,
-  Signature,
-  SignatureChainId,
-  SuccessResponse,
-} from "./_base/schemas.js";
+import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
+import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /**
  * Approve an agent to sign on behalf of the master account.
@@ -30,28 +23,50 @@ export const ApproveAgentRequest = /* @__PURE__ */ (() => {
             v.description("Type of action."),
           ),
           /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: SignatureChainId,
+          signatureChainId: v.pipe(
+            Hex,
+            v.description("Chain ID in hex format for EIP-712 signing."),
+          ),
           /** HyperLiquid network type. */
-          hyperliquidChain: HyperliquidChain,
+          hyperliquidChain: v.pipe(
+            HyperliquidChainSchema,
+            v.description("HyperLiquid network type."),
+          ),
           /** Agent address. */
           agentAddress: v.pipe(
             Address,
             v.description("Agent address."),
           ),
-          /** Agent name or null for unnamed agent (default: null). */
+          /** Agent name or null for unnamed agent. */
           agentName: v.pipe(
-            v.optional(v.nullable(v.string()), null),
+            v.nullish(
+              v.pipe(
+                v.string(),
+                v.minLength(1),
+                v.maxLength(17),
+              ),
+              null,
+            ),
             v.description("Agent name or null for unnamed agent."),
           ),
           /** Nonce (timestamp in ms) used to prevent replay attacks. */
-          nonce: Nonce,
+          nonce: v.pipe(
+            UnsignedInteger,
+            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+          ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
     }),
     v.description("Approve an agent to sign on behalf of the master account."),
   );

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

@@ -4,15 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Percent } from "../../_schemas.js";
-import {
-  ErrorResponse,
-  HyperliquidChain,
-  Nonce,
-  Signature,
-  SignatureChainId,
-  SuccessResponse,
-} from "./_base/schemas.js";
+import { Address, Hex, Percent, UnsignedInteger } from "../../_schemas.js";
+import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /**
  * Approve a maximum fee rate for a builder.
@@ -30,9 +23,15 @@ export const ApproveBuilderFeeRequest = /* @__PURE__ */ (() => {
             v.description("Type of action."),
           ),
           /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: SignatureChainId,
+          signatureChainId: v.pipe(
+            Hex,
+            v.description("Chain ID in hex format for EIP-712 signing."),
+          ),
           /** HyperLiquid network type. */
-          hyperliquidChain: HyperliquidChain,
+          hyperliquidChain: v.pipe(
+            HyperliquidChainSchema,
+            v.description("HyperLiquid network type."),
+          ),
           /** Max fee rate (e.g., "0.01%"). */
           maxFeeRate: v.pipe(
             Percent,
@@ -44,14 +43,23 @@ export const ApproveBuilderFeeRequest = /* @__PURE__ */ (() => {
             v.description("Builder address."),
           ),
           /** Nonce (timestamp in ms) used to prevent replay attacks. */
-          nonce: Nonce,
+          nonce: v.pipe(
+            UnsignedInteger,
+            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+          ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
     }),
     v.description("Approve a maximum fee rate for a builder."),
   );

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

@@ -4,8 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
-import { Nonce, Signature } from "./_base/schemas.js";
+import { Address, Cloid, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { SignatureSchema } from "./_base/commonSchemas.js";
 import { OrderResponse } from "./order.js";
 
 /**
@@ -29,10 +29,7 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
               v.object({
                 /** Order ID or Client Order ID. */
                 oid: v.pipe(
-                  v.union([
-                    UnsignedInteger,
-                    v.pipe(Hex, v.length(34)),
-                  ]),
+                  v.union([UnsignedInteger, Cloid]),
                   v.description("Order ID or Client Order ID."),
                 ),
                 /** New order parameters. */
@@ -51,6 +48,7 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
                     /** Price. */
                     p: v.pipe(
                       UnsignedDecimal,
+                      v.check((input) => Number(input) > 0, "Value must be greater than zero."),
                       v.description("Price."),
                     ),
                     /** Size (in base currency units). */
@@ -63,7 +61,7 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
                       v.boolean(),
                       v.description("Is reduce-only?"),
                     ),
-                    /** Order type. */
+                    /** Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
                     t: v.pipe(
                       v.union([
                         v.object({
@@ -105,6 +103,7 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
                               /** Trigger price. */
                               triggerPx: v.pipe(
                                 UnsignedDecimal,
+                                v.check((input) => Number(input) > 0, "Value must be greater than zero."),
                                 v.description("Trigger price."),
                               ),
                               /** Indicates whether it is take profit or stop loss. */
@@ -117,11 +116,13 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
                           ),
                         }),
                       ]),
-                      v.description("Order type."),
+                      v.description(
+                        "Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders).",
+                      ),
                     ),
                     /** Client Order ID. */
                     c: v.pipe(
-                      v.optional(v.pipe(Hex, v.length(34))),
+                      v.optional(Cloid),
                       v.description("Client Order ID."),
                     ),
                   }),
@@ -135,9 +136,15 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Vault address (for vault trading). */
       vaultAddress: v.pipe(
         v.optional(Address),

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

@@ -4,15 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { UnsignedInteger } from "../../_schemas.js";
-import {
-  ErrorResponse,
-  HyperliquidChain,
-  Nonce,
-  Signature,
-  SignatureChainId,
-  SuccessResponse,
-} from "./_base/schemas.js";
+import { Hex, UnsignedInteger } from "../../_schemas.js";
+import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /**
  * Transfer native token from the user spot account into staking for delegating to validators.
@@ -30,23 +23,39 @@ export const CDepositRequest = /* @__PURE__ */ (() => {
             v.description("Type of action."),
           ),
           /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: SignatureChainId,
+          signatureChainId: v.pipe(
+            Hex,
+            v.description("Chain ID in hex format for EIP-712 signing."),
+          ),
           /** HyperLiquid network type. */
-          hyperliquidChain: HyperliquidChain,
+          hyperliquidChain: v.pipe(
+            HyperliquidChainSchema,
+            v.description("HyperLiquid network type."),
+          ),
           /** Amount of wei to deposit into staking balance (float * 1e8). */
           wei: v.pipe(
             UnsignedInteger,
+            v.minValue(1),
             v.description("Amount of wei to deposit into staking balance (float * 1e8)."),
           ),
           /** Nonce (timestamp in ms) used to prevent replay attacks. */
-          nonce: Nonce,
+          nonce: v.pipe(
+            UnsignedInteger,
+            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+          ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
     }),
     v.description("Transfer native token from the user spot account into staking for delegating to validators."),
   );

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

@@ -5,13 +5,13 @@ import * as v from "valibot";
 // ============================================================
 
 import { UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
+import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /** Jail or unjail self as a validator signer. */
 export const CSignerActionRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
-      /** Action to perform. */
+      /** Action to jail or unjail the signer. */
       action: v.pipe(
         v.union([
           v.object({
@@ -39,12 +39,18 @@ export const CSignerActionRequest = /* @__PURE__ */ (() => {
             ),
           }),
         ]),
-        v.description("Action to perform."),
+        v.description("Action to jail or unjail the signer."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Expiration time of the action. */
       expiresAfter: v.pipe(
         v.optional(UnsignedInteger),
@@ -100,7 +106,7 @@ export type CSignerActionSuccessResponse = ExcludeErrorResponse<CSignerActionRes
  * @throws {TransportError} When the transport layer throws an error.
  * @throws {ApiRequestError} When the API returns an unsuccessful response.
  *
- * @example
+ * @example Jail self
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { cSignerAction } from "@nktkas/hyperliquid/api/exchange";
@@ -109,13 +115,20 @@ export type CSignerActionSuccessResponse = ExcludeErrorResponse<CSignerActionRes
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * // Jail self
  * await cSignerAction(
  *   { transport, wallet },
  *   { jailSelf: null },
  * );
+ * ```
+ * @example Unjail self
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { cSignerAction } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * // Unjail self
  * await cSignerAction(
  *   { transport, wallet },
  *   { unjailSelf: null },

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

@@ -5,13 +5,13 @@ import * as v from "valibot";
 // ============================================================
 
 import { Address, UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
+import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /** Action related to validator management. */
 export const CValidatorActionRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
-      /** Action to perform. */
+      /** Validator management action. */
       action: v.pipe(
         v.union([
           v.object({
@@ -47,10 +47,10 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
                   v.nullable(v.string()),
                   v.description("Validator description."),
                 ),
-                /** Validator jail status. */
+                /** Whether the validator is unjailed. */
                 unjailed: v.pipe(
                   v.boolean(),
-                  v.description("Validator jail status."),
+                  v.description("Whether the validator is unjailed."),
                 ),
                 /** Enable or disable delegations. */
                 disable_delegations: v.pipe(
@@ -150,12 +150,18 @@ export const CValidatorActionRequest = /* @__PURE__ */ (() => {
             ),
           }),
         ]),
-        v.description("Action to perform."),
+        v.description("Validator management action."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Expiration time of the action. */
       expiresAfter: v.pipe(
         v.optional(UnsignedInteger),
@@ -211,7 +217,7 @@ export type CValidatorActionSuccessResponse = ExcludeErrorResponse<CValidatorAct
  * @throws {TransportError} When the transport layer throws an error.
  * @throws {ApiRequestError} When the API returns an unsuccessful response.
  *
- * @example
+ * @example Change validator profile
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { cValidatorAction } from "@nktkas/hyperliquid/api/exchange";
@@ -220,7 +226,6 @@ export type CValidatorActionSuccessResponse = ExcludeErrorResponse<CValidatorAct
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
  *
- * // Change validator profile
  * await cValidatorAction(
  *   { transport, wallet },
  *   {
@@ -235,31 +240,6 @@ export type CValidatorActionSuccessResponse = ExcludeErrorResponse<CValidatorAct
  *     },
  *   },
  * );
- *
- * // Register a new validator
- * await cValidatorAction(
- *   { transport, wallet },
- *   {
- *     register: {
- *       profile: {
- *         node_ip: { Ip: "1.2.3.4" },
- *         name: "...",
- *         description: "...",
- *         delegations_disabled: true,
- *         commission_bps: 1,
- *         signer: "0x...",
- *       },
- *       unjailed: false,
- *       initial_wei: 1,
- *     },
- *   },
- * );
- *
- * // Unregister a validator
- * await cValidatorAction(
- *   { transport, wallet },
- *   { unregister: null },
- * );
  * ```
  */
 export function cValidatorAction(

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

@@ -4,15 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { UnsignedInteger } from "../../_schemas.js";
-import {
-  ErrorResponse,
-  HyperliquidChain,
-  Nonce,
-  Signature,
-  SignatureChainId,
-  SuccessResponse,
-} from "./_base/schemas.js";
+import { Hex, UnsignedInteger } from "../../_schemas.js";
+import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /**
  * Transfer native token from staking into the user's spot account.
@@ -30,23 +23,39 @@ export const CWithdrawRequest = /* @__PURE__ */ (() => {
             v.description("Type of action."),
           ),
           /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: SignatureChainId,
+          signatureChainId: v.pipe(
+            Hex,
+            v.description("Chain ID in hex format for EIP-712 signing."),
+          ),
           /** HyperLiquid network type. */
-          hyperliquidChain: HyperliquidChain,
+          hyperliquidChain: v.pipe(
+            HyperliquidChainSchema,
+            v.description("HyperLiquid network type."),
+          ),
           /** Amount of wei to withdraw from staking balance (float * 1e8). */
           wei: v.pipe(
             UnsignedInteger,
+            v.minValue(1),
             v.description("Amount of wei to withdraw from staking balance (float * 1e8)."),
           ),
           /** Nonce (timestamp in ms) used to prevent replay attacks. */
-          nonce: Nonce,
+          nonce: v.pipe(
+            UnsignedInteger,
+            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+          ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
     }),
     v.description("Transfer native token from staking into the user's spot account."),
   );

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

@@ -5,7 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { Address, UnsignedInteger } from "../../_schemas.js";
-import { Nonce, Signature } from "./_base/schemas.js";
+import { SignatureSchema } from "./_base/commonSchemas.js";
 
 /**
  * Cancel order(s).
@@ -22,7 +22,7 @@ export const CancelRequest = /* @__PURE__ */ (() => {
             v.literal("cancel"),
             v.description("Type of action."),
           ),
-          /** Orders to cancel. */
+          /** Orders to cancel by asset and order ID. */
           cancels: v.pipe(
             v.array(
               v.object({
@@ -38,15 +38,21 @@ export const CancelRequest = /* @__PURE__ */ (() => {
                 ),
               }),
             ),
-            v.description("Orders to cancel."),
+            v.description("Orders to cancel by asset and order ID."),
           ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Vault address (for vault trading). */
       vaultAddress: v.pipe(
         v.optional(Address),
@@ -86,21 +92,21 @@ export const CancelResponse = /* @__PURE__ */ (() => {
           /** Specific data. */
           data: v.pipe(
             v.object({
-              /** Array of statuses or error messages. */
+              /** Array of statuses for each canceled order. */
               statuses: v.pipe(
                 v.array(
                   v.union([
                     v.literal("success"),
                     v.object({
-                      /** Error message. */
+                      /** Error message returned by the exchange. */
                       error: v.pipe(
                         v.string(),
-                        v.description("Error message."),
+                        v.description("Error message returned by the exchange."),
                       ),
                     }),
                   ]),
                 ),
-                v.description("Array of statuses or error messages."),
+                v.description("Array of statuses for each canceled order."),
               ),
             }),
             v.description("Specific data."),

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

@@ -4,8 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
-import { Nonce, Signature } from "./_base/schemas.js";
+import { Address, Cloid, UnsignedInteger } from "../../_schemas.js";
+import { SignatureSchema } from "./_base/commonSchemas.js";
 import { CancelResponse } from "./cancel.js";
 
 /**
@@ -23,7 +23,7 @@ export const CancelByCloidRequest = /* @__PURE__ */ (() => {
             v.literal("cancelByCloid"),
             v.description("Type of action."),
           ),
-          /** Orders to cancel. */
+          /** Orders to cancel by asset and client order ID. */
           cancels: v.pipe(
             v.array(
               v.object({
@@ -34,20 +34,26 @@ export const CancelByCloidRequest = /* @__PURE__ */ (() => {
                 ),
                 /** Client Order ID. */
                 cloid: v.pipe(
-                  v.pipe(Hex, v.length(34)),
+                  Cloid,
                   v.description("Client Order ID."),
                 ),
               }),
             ),
-            v.description("Orders to cancel."),
+            v.description("Orders to cancel by asset and client order ID."),
           ),
         }),
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Vault address (for vault trading). */
       vaultAddress: v.pipe(
         v.optional(Address),

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

@@ -5,7 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
+import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /** Claim rewards from referral program. */
 export const ClaimRewardsRequest = /* @__PURE__ */ (() => {
@@ -23,9 +23,15 @@ export const ClaimRewardsRequest = /* @__PURE__ */ (() => {
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Expiration time of the action. */
       expiresAfter: v.pipe(
         v.optional(UnsignedInteger),