@nktkas/hyperliquid 0.30.2 → 0.31.0

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

@@ -13,151 +13,77 @@ import { OrderResponse } from "./order.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
  */
 export const BatchModifyRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
+  return v.object({
+    /** Action to perform. */
+    action: v.object({
+      /** Type of action. */
+      type: v.literal("batchModify"),
+      /** Order modifications. */
+      modifies: v.array(
         v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("batchModify"),
-            v.description("Type of action."),
-          ),
-          /** Order modifications. */
-          modifies: v.pipe(
-            v.array(
+          /** Order ID or Client Order ID. */
+          oid: v.union([UnsignedInteger, Cloid]),
+          /** New order parameters. */
+          order: v.object({
+            /** Asset ID. */
+            a: UnsignedInteger,
+            /** Position side (`true` for long, `false` for short). */
+            b: v.boolean(),
+            /** Price. */
+            p: v.pipe(
+              UnsignedDecimal,
+              v.check((input) => Number(input) > 0, "Value must be greater than zero."),
+            ),
+            /** Size (in base currency units). */
+            s: UnsignedDecimal,
+            /** Is reduce-only? */
+            r: v.boolean(),
+            /** Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
+            t: v.union([
               v.object({
-                /** Order ID or Client Order ID. */
-                oid: v.pipe(
-                  v.union([UnsignedInteger, Cloid]),
-                  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.check((input) => Number(input) > 0, "Value must be greater than zero."),
-                      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 (`limit` for limit orders, `trigger` for stop-loss/take-profit orders). */
-                    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.picklist(["Gtc", "Ioc", "Alo", "FrontendMarket", "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.check((input) => Number(input) > 0, "Value must be greater than zero."),
-                                v.description("Trigger price."),
-                              ),
-                              /** Indicates whether it is take profit or stop loss. */
-                              tpsl: v.pipe(
-                                v.picklist(["tp", "sl"]),
-                                v.description("Indicates whether it is take profit or stop loss."),
-                              ),
-                            }),
-                            v.description("Trigger order parameters."),
-                          ),
-                        }),
-                      ]),
-                      v.description(
-                        "Order type (`limit` for limit orders, `trigger` for stop-loss/take-profit orders).",
-                      ),
-                    ),
-                    /** Client Order ID. */
-                    c: v.pipe(
-                      v.optional(Cloid),
-                      v.description("Client Order ID."),
-                    ),
-                  }),
-                  v.description("New order parameters."),
-                ),
+                /** Limit order parameters. */
+                limit: 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.picklist(["Gtc", "Ioc", "Alo", "FrontendMarket", "LiquidationMarket"]),
+                }),
               }),
-            ),
-            v.description("Order modifications."),
-          ),
+              v.object({
+                /** Trigger order parameters. */
+                trigger: v.object({
+                  /** Is market order? */
+                  isMarket: v.boolean(),
+                  /** Trigger price. */
+                  triggerPx: v.pipe(
+                    UnsignedDecimal,
+                    v.check((input) => Number(input) > 0, "Value must be greater than zero."),
+                  ),
+                  /** Indicates whether it is take profit or stop loss. */
+                  tpsl: v.picklist(["tp", "sl"]),
+                }),
+              }),
+            ]),
+            /** Client Order ID. */
+            c: v.optional(Cloid),
+          }),
         }),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Vault address (for vault trading). */
-      vaultAddress: v.pipe(
-        v.optional(Address),
-        v.description("Vault address (for vault trading)."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
       ),
     }),
-    v.description("Modify multiple orders."),
-  );
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    nonce: UnsignedInteger,
+    /** ECDSA signature components. */
+    signature: SignatureSchema,
+    /** Vault address (for vault trading). */
+    vaultAddress: v.optional(Address),
+    /** Expiration time of the action. */
+    expiresAfter: v.optional(UnsignedInteger),
+  });
 })();
 export type BatchModifyRequest = v.InferOutput<typeof BatchModifyRequest>;
 
@@ -166,10 +92,7 @@ export type BatchModifyRequest = v.InferOutput<typeof BatchModifyRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
  */
 export const BatchModifyResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    OrderResponse,
-    v.description("Response for order batch modifications."),
-  );
+  return OrderResponse;
 })();
 export type BatchModifyResponse = OrderResponse;
 

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

@@ -0,0 +1,100 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
+
+/** Borrow or lend assets. */
+export const BorrowLendRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Action to perform. */
+    action: v.object({
+      /** Type of action. */
+      type: v.literal("borrowLend"),
+      /** Operation type. */
+      operation: v.picklist(["supply", "withdraw", "repay", "borrow"]),
+      /** Token ID. */
+      token: UnsignedInteger,
+      /** Amount to supply/withdraw (null = full). */
+      amount: v.nullable(UnsignedDecimal),
+    }),
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    nonce: UnsignedInteger,
+    /** ECDSA signature components. */
+    signature: SignatureSchema,
+    /** Vault address (for vault trading). */
+    vaultAddress: v.optional(Address),
+    /** Expiration time of the action. */
+    expiresAfter: v.optional(UnsignedInteger),
+  });
+})();
+export type BorrowLendRequest = v.InferOutput<typeof BorrowLendRequest>;
+
+/** Successful response without specific data or error response. */
+export const BorrowLendResponse = /* @__PURE__ */ (() => {
+  return v.union([SuccessResponse, ErrorResponse]);
+})();
+export type BorrowLendResponse = v.InferOutput<typeof BorrowLendResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type ExchangeConfig, executeL1Action, type ExtractRequestOptions } from "./_base/execute.js";
+import type { ExcludeErrorResponse } from "./_base/errors.js";
+
+/** Schema for user-provided action parameters (excludes system fields). */
+const BorrowLendParameters = /* @__PURE__ */ (() => {
+  return v.omit(
+    v.object(BorrowLendRequest.entries.action.entries),
+    ["type"],
+  );
+})();
+/** Action parameters for the {@linkcode borrowLend} function. */
+export type BorrowLendParameters = v.InferInput<typeof BorrowLendParameters>;
+
+/** Request options for the {@linkcode borrowLend} function. */
+export type BorrowLendOptions = ExtractRequestOptions<v.InferInput<typeof BorrowLendRequest>>;
+
+/** Successful variant of {@linkcode BorrowLendResponse} without errors. */
+export type BorrowLendSuccessResponse = ExcludeErrorResponse<BorrowLendResponse>;
+
+/**
+ * Borrow or lend assets.
+ *
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ *
+ * @returns Successful response without specific data.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { borrowLend } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await borrowLend(
+ *   { transport, wallet },
+ *   { operation: "supply", token: 0, amount: "20" },
+ * );
+ * ```
+ */
+export function borrowLend(
+  config: ExchangeConfig,
+  params: BorrowLendParameters,
+  opts?: BorrowLendOptions,
+): Promise<BorrowLendSuccessResponse> {
+  const action = v.parse(BorrowLendParameters, params);
+  return executeL1Action(config, { type: "borrowLend", ...action }, opts);
+}

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

@@ -12,53 +12,25 @@ import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
  */
 export const CDepositRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("cDeposit"),
-            v.description("Type of action."),
-          ),
-          /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: v.pipe(
-            Hex,
-            v.description("Chain ID in hex format for EIP-712 signing."),
-          ),
-          /** HyperLiquid network type. */
-          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: v.pipe(
-            UnsignedInteger,
-            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
+  return v.object({
+    /** Action to perform. */
+    action: v.object({
+      /** Type of action. */
+      type: v.literal("cDeposit"),
+      /** Chain ID in hex format for EIP-712 signing. */
+      signatureChainId: Hex,
+      /** HyperLiquid network type. */
+      hyperliquidChain: HyperliquidChainSchema,
+      /** Amount of wei to deposit into staking balance (float * 1e8). */
+      wei: v.pipe(UnsignedInteger, v.minValue(1)),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
+      nonce: UnsignedInteger,
     }),
-    v.description("Transfer native token from the user spot account into staking for delegating to validators."),
-  );
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    nonce: UnsignedInteger,
+    /** ECDSA signature components. */
+    signature: SignatureSchema,
+  });
 })();
 export type CDepositRequest = v.InferOutput<typeof CDepositRequest>;
 
@@ -67,10 +39,7 @@ export type CDepositRequest = v.InferOutput<typeof CDepositRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#deposit-into-staking
  */
 export const CDepositResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
+  return v.union([SuccessResponse, ErrorResponse]);
 })();
 export type CDepositResponse = v.InferOutput<typeof CDepositResponse>;
 

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

@@ -9,65 +9,35 @@ import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonS
 
 /** Jail or unjail self as a validator signer. */
 export const CSignerActionRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to jail or unjail the signer. */
-      action: v.pipe(
-        v.union([
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("CSignerAction"),
-              v.description("Type of action."),
-            ),
-            /** Jail the signer. */
-            jailSelf: v.pipe(
-              v.null(),
-              v.description("Jail the signer."),
-            ),
-          }),
-          v.object({
-            /** Type of action. */
-            type: v.pipe(
-              v.literal("CSignerAction"),
-              v.description("Type of action."),
-            ),
-            /** Unjail the signer. */
-            unjailSelf: v.pipe(
-              v.null(),
-              v.description("Unjail the signer."),
-            ),
-          }),
-        ]),
-        v.description("Action to jail or unjail the signer."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Jail or unjail self as a validator signer."),
-  );
+  return v.object({
+    /** Action to jail or unjail the signer. */
+    action: v.variant("type", [
+      v.object({
+        /** Type of action. */
+        type: v.literal("CSignerAction"),
+        /** Jail the signer. */
+        jailSelf: v.null(),
+      }),
+      v.object({
+        /** Type of action. */
+        type: v.literal("CSignerAction"),
+        /** Unjail the signer. */
+        unjailSelf: v.null(),
+      }),
+    ]),
+    /** Nonce (timestamp in ms) used to prevent replay attacks. */
+    nonce: UnsignedInteger,
+    /** ECDSA signature components. */
+    signature: SignatureSchema,
+    /** Expiration time of the action. */
+    expiresAfter: v.optional(UnsignedInteger),
+  });
 })();
 export type CSignerActionRequest = v.InferOutput<typeof CSignerActionRequest>;
 
 /** Successful response without specific data or error response. */
 export const CSignerActionResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
+  return v.union([SuccessResponse, ErrorResponse]);
 })();
 export type CSignerActionResponse = v.InferOutput<typeof CSignerActionResponse>;