@nktkas/hyperliquid 0.26.0 → 0.27.0

package/dist/src/signing/mod.js

@@ -5,7 +5,7 @@
  * ```ts
  * import { signL1Action } from "@nktkas/hyperliquid/signing";
  * import { CancelRequest, parser } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  *
@@ -32,7 +32,7 @@
  * ```ts
  * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
  * import { ApproveAgentRequest, ApproveAgentTypes, parser } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  *
@@ -60,7 +60,7 @@
  * ```ts
  * import { signL1Action, signMultiSigAction } from "@nktkas/hyperliquid/signing";
  * import { MultiSigRequest, parser, ScheduleCancelRequest } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const multiSigUser = "0x...";
@@ -168,7 +168,7 @@ function toUint64Bytes(n) {
  * ```ts
  * import { signL1Action } from "@nktkas/hyperliquid/signing";
  * import { CancelRequest, parser } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  *
@@ -222,7 +222,7 @@ export async function signL1Action(args) {
  * ```ts
  * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
  * import { ApproveAgentRequest, ApproveAgentTypes, parser } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  *
@@ -277,7 +277,7 @@ export async function signUserSignedAction(args) {
  * ```ts
  * import { signL1Action, signMultiSigAction } from "@nktkas/hyperliquid/signing";
  * import { MultiSigRequest, parser, ScheduleCancelRequest } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const multiSigUser = "0x...";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nktkas/hyperliquid",
-  "version": "0.26.0",
+  "version": "0.27.0",
   "description": "Unofficial Hyperliquid API SDK for all major JS runtimes, written in TypeScript.",
   "keywords": [
     "api",

package/src/api/_base.ts

@@ -2,7 +2,9 @@
 import * as v from "valibot";
 import { HyperliquidError } from "../_base.ts";
 
-// -------------------- Types --------------------
+// ============================================================
+// Types
+// ============================================================
 
 export type MaybePromise<T> = T | Promise<T>;
 
@@ -34,7 +36,9 @@ export type OverloadedParameters<T> = T extends {
   : T extends (...args: infer A) => unknown ? A
   : never;
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
 
 export const UnsignedDecimal = /* @__PURE__ */ (() => {
   return v.pipe(

package/src/api/exchange/_base/_execute.ts

@@ -1,9 +1,16 @@
 import { getSemaphore } from "@henrygd/semaphore";
-import { getWalletAddress, signL1Action, signMultiSigAction, signUserSignedAction } from "../../../signing/mod.ts";
+import { Hex, type MaybePromise, parser } from "../../_base.ts";
+import {
+  type AbstractWallet,
+  getWalletAddress,
+  getWalletChainId,
+  signL1Action,
+  signMultiSigAction,
+  signUserSignedAction,
+} from "../../../signing/mod.ts";
 import { assertSuccessResponse } from "./_errors.ts";
 import type { AnyResponse, AnySuccessResponse, ExchangeRequestConfig, MultiSignRequestConfig } from "./_types.ts";
-import { globalNonceManager } from "./_nonce.ts";
-import { getSignatureChainId } from "./_helpers.ts";
+import { getNonce } from "./_nonce.ts";
 
 export async function executeL1Action<T extends AnySuccessResponse>(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
@@ -28,7 +35,7 @@ export async function executeL1Action<T extends AnySuccessResponse>(
 
   // Main logic
   try {
-    const nonce = globalNonceManager.getNonce();
+    const nonce = await getNonce(config, walletAddress);
 
     // Multi-signature request
     if ("signers" in config) {
@@ -130,7 +137,7 @@ export async function executeUserSignedAction<T extends AnySuccessResponse>(
 
   // Main logic
   try {
-    const nonce = globalNonceManager.getNonce();
+    const nonce = await getNonce(config, walletAddress);
     if ("time" in action) request.action.time = nonce;
     if ("nonce" in action) request.action.nonce = nonce;
 
@@ -242,3 +249,27 @@ export async function executeMultiSigAction<T extends AnySuccessResponse>(
     sem?.release();
   }
 }
+
+/** Get the signature chain ID from the config value / function or from the wallet. */
+export async function getSignatureChainId(
+  config:
+    | {
+      wallet: AbstractWallet;
+      signatureChainId?: string | (() => MaybePromise<string>);
+    }
+    | {
+      signers: readonly AbstractWallet[];
+      signatureChainId?: string | (() => MaybePromise<string>);
+    },
+): Promise<`0x${string}`> {
+  if ("signatureChainId" in config && config.signatureChainId) {
+    const signatureChainId = typeof config.signatureChainId === "string"
+      ? config.signatureChainId
+      : await config.signatureChainId();
+    return parser(Hex)(signatureChainId);
+  } else if ("wallet" in config) {
+    return await getWalletChainId(config.wallet);
+  } else {
+    return await getWalletChainId(config.signers[0]);
+  }
+}

package/src/api/exchange/_base/_nonce.ts

@@ -15,4 +15,15 @@ class NonceManager {
   }
 }
 
-export const globalNonceManager = /* @__PURE__ */ new NonceManager();
+const globalNonceManager = /* @__PURE__ */ new NonceManager();
+
+/** Get nonce from config or use global nonce manager. */
+export async function getNonce(
+  config: { nonceManager?: number | ((address: string) => Promise<number> | number) },
+  address: string,
+): Promise<number> {
+  const { nonceManager } = config;
+  if (typeof nonceManager === "number") return nonceManager;
+  if (typeof nonceManager === "function") return await nonceManager(address);
+  return globalNonceManager.getNonce();
+}

package/src/api/exchange/_base/_types.ts

@@ -54,6 +54,15 @@ export interface ExchangeRequestConfig<
    * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#expires-after
    */
   defaultExpiresAfter?: number | (() => MaybePromise<number>);
+  /**
+   * A fixed nonce or a function that returns a nonce to be used for signing requests.
+   *
+   * Defaults to a global nonce manager that uses the current timestamp in milliseconds,
+   * and increments if the timestamp is not greater than the last nonce.
+   *
+   * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#hyperliquid-nonces
+   */
+  nonceManager?: number | ((address: string) => MaybePromise<number>);
 }
 
 /** Configuration for Exchange API requests using multi-signature wallets. */
@@ -86,3 +95,20 @@ export type ExtractRequestOptions<T extends { action: Record<string, unknown> }>
   }
   & Omit<T, "action" | "nonce" | "signature">
 >;
+
+export type ExcludeErrorResponse<T> = T extends { status: "err" } ? never // Response with error status
+  : T extends { response: { data: { statuses: ReadonlyArray<infer S> } } } // Responses with multiple statuses
+    ? Exclude<S, { error: unknown }> extends never ? never
+    : Prettify<
+      Omit<T, "response"> & {
+        response: Prettify<Omit<T["response"], "data"> & { data: { statuses: Array<Exclude<S, { error: unknown }>> } }>;
+      }
+    >
+  : T extends { response: { data: { status: infer S } } } // Responses with single status
+    ? S extends { error: unknown } ? never
+    : Prettify<
+      Omit<T, "response"> & {
+        response: Prettify<Omit<T["response"], "data"> & { data: { status: Exclude<S, { error: unknown }> } }>;
+      }
+    >
+  : T;

package/src/api/exchange/_base/mod.ts

@@ -1,5 +1,4 @@
 export * from "./_errors.ts";
 export * from "./_execute.ts";
-export * from "./_helpers.ts";
 export * from "./_schemas.ts";
 export * from "./_types.ts";

package/src/api/exchange/agentEnableDexAbstraction.ts

@@ -1,18 +1,15 @@
 import * as v from "valibot";
-import { parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Enable HIP-3 DEX abstraction.
- * @see null
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#enable-hip-3-dex-abstraction-agent
  */
 export const AgentEnableDexAbstractionRequest = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -49,16 +46,39 @@ export const AgentEnableDexAbstractionRequest = /* @__PURE__ */ (() => {
 })();
 export type AgentEnableDexAbstractionRequest = v.InferOutput<typeof AgentEnableDexAbstractionRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#enable-hip-3-dex-abstraction-agent
+ */
+export const AgentEnableDexAbstractionResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type AgentEnableDexAbstractionResponse = v.InferOutput<typeof AgentEnableDexAbstractionResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
 
-// -------------------- Function --------------------
+import { parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeL1Action,
+  type ExtractRequestOptions,
+  type MultiSignRequestConfig,
+} from "./_base/mod.ts";
 
 /** Request options for the {@linkcode agentEnableDexAbstraction} function. */
 export type AgentEnableDexAbstractionOptions = ExtractRequestOptions<
   v.InferInput<typeof AgentEnableDexAbstractionRequest>
 >;
 
+/** Successful variant of {@linkcode AgentEnableDexAbstractionResponse} without errors. */
+export type AgentEnableDexAbstractionSuccessResponse = ExcludeErrorResponse<AgentEnableDexAbstractionResponse>;
+
 /**
  * Enable HIP-3 DEX abstraction.
  * @param config - General configuration for Exchange API requests.
@@ -69,12 +89,12 @@ export type AgentEnableDexAbstractionOptions = ExtractRequestOptions<
  * @throws {ApiRequestError} When the API returns an unsuccessful response.
  * @throws {TransportError} When the transport layer throws an error.
  *
- * @see null
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#enable-hip-3-dex-abstraction-agent
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { agentEnableDexAbstraction } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
@@ -85,7 +105,7 @@ export type AgentEnableDexAbstractionOptions = ExtractRequestOptions<
 export async function agentEnableDexAbstraction(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   opts?: AgentEnableDexAbstractionOptions,
-): Promise<SuccessResponse> {
+): Promise<AgentEnableDexAbstractionSuccessResponse> {
   const request = parser(AgentEnableDexAbstractionRequest)({
     action: {
       type: "agentEnableDexAbstraction",

package/src/api/exchange/approveAgent.ts

@@ -1,16 +1,11 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeUserSignedAction,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  getSignatureChainId,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, Hex, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Approve an agent to sign on behalf of the master account.
@@ -71,16 +66,42 @@ export const ApproveAgentRequest = /* @__PURE__ */ (() => {
 })();
 export type ApproveAgentRequest = v.InferOutput<typeof ApproveAgentRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-an-api-wallet
+ */
+export const ApproveAgentResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type ApproveAgentResponse = v.InferOutput<typeof ApproveAgentResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
 
-// -------------------- Function --------------------
+import { type DeepImmutable, parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeUserSignedAction,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  getSignatureChainId,
+  type MultiSignRequestConfig,
+} from "./_base/mod.ts";
 
 /** Action parameters for the {@linkcode approveAgent} function. */
 export type ApproveAgentParameters = ExtractRequestAction<v.InferInput<typeof ApproveAgentRequest>>;
+
 /** Request options for the {@linkcode approveAgent} function. */
 export type ApproveAgentOptions = ExtractRequestOptions<v.InferInput<typeof ApproveAgentRequest>>;
 
+/** Successful variant of {@linkcode ApproveAgentResponse} without errors. */
+export type ApproveAgentSuccessResponse = ExcludeErrorResponse<ApproveAgentResponse>;
+
 /** EIP-712 types for the {@linkcode approveAgent} function. */
 export const ApproveAgentTypes = {
   "HyperliquidTransaction:ApproveAgent": [
@@ -106,7 +127,7 @@ export const ApproveAgentTypes = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { approveAgent } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
@@ -121,7 +142,7 @@ export async function approveAgent(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<ApproveAgentParameters>,
   opts?: ApproveAgentOptions,
-): Promise<SuccessResponse> {
+): Promise<ApproveAgentSuccessResponse> {
   const request = parser(ApproveAgentRequest)({
     action: {
       type: "approveAgent",

package/src/api/exchange/approveBuilderFee.ts

@@ -1,16 +1,11 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, Percent, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeUserSignedAction,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  getSignatureChainId,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, Hex, Percent, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Approve a maximum fee rate for a builder.
@@ -71,16 +66,42 @@ export const ApproveBuilderFeeRequest = /* @__PURE__ */ (() => {
 })();
 export type ApproveBuilderFeeRequest = v.InferOutput<typeof ApproveBuilderFeeRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#approve-a-builder-fee
+ */
+export const ApproveBuilderFeeResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type ApproveBuilderFeeResponse = v.InferOutput<typeof ApproveBuilderFeeResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
 
-// -------------------- Function --------------------
+import { type DeepImmutable, parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeUserSignedAction,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  getSignatureChainId,
+  type MultiSignRequestConfig,
+} from "./_base/mod.ts";
 
 /** Action parameters for the {@linkcode approveBuilderFee} function. */
 export type ApproveBuilderFeeParameters = ExtractRequestAction<v.InferInput<typeof ApproveBuilderFeeRequest>>;
+
 /** Request options for the {@linkcode approveBuilderFee} function. */
 export type ApproveBuilderFeeOptions = ExtractRequestOptions<v.InferInput<typeof ApproveBuilderFeeRequest>>;
 
+/** Successful variant of {@linkcode ApproveBuilderFeeResponse} without errors. */
+export type ApproveBuilderFeeSuccessResponse = ExcludeErrorResponse<ApproveBuilderFeeResponse>;
+
 /** EIP-712 types for the {@linkcode approveBuilderFee} function. */
 export const ApproveBuilderFeeTypes = {
   "HyperliquidTransaction:ApproveBuilderFee": [
@@ -106,7 +127,7 @@ export const ApproveBuilderFeeTypes = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { approveBuilderFee } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
@@ -121,7 +142,7 @@ export async function approveBuilderFee(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<ApproveBuilderFeeParameters>,
   opts?: ApproveBuilderFeeOptions,
-): Promise<SuccessResponse> {
+): Promise<ApproveBuilderFeeSuccessResponse> {
   const request = parser(ApproveBuilderFeeRequest)({
     action: {
       type: "approveBuilderFee",

package/src/api/exchange/batchModify.ts

@@ -1,17 +1,13 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-import { PlaceOrderParamsSchema } from "../_common_schemas.ts";
+// ============================================================
+// API Schemas
+// ============================================================
 
-// -------------------- Schemas --------------------
+import { Address, Hex, UnsignedInteger } from "../_base.ts";
+import { Signature } from "./_base/mod.ts";
+import { PlaceOrderParamsSchema } from "../_common_schemas.ts";
+import { OrderResponse } from "./order.ts";
 
 /**
  * Modify multiple orders.
@@ -73,16 +69,36 @@ export const BatchModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type BatchModifyRequest = v.InferOutput<typeof BatchModifyRequest>;
 
-import { OrderSuccessResponse } from "./order.ts";
-export { OrderSuccessResponse };
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-multiple-orders
+ */
+export const BatchModifyResponse = OrderResponse;
+export type BatchModifyResponse = OrderResponse;
+
+// ============================================================
+// Execution Logic
+// ============================================================
 
-// -------------------- Function --------------------
+import { type DeepImmutable, parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeL1Action,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  type MultiSignRequestConfig,
+} from "./_base/mod.ts";
 
 /** Action parameters for the {@linkcode batchModify} function. */
 export type BatchModifyParameters = ExtractRequestAction<v.InferInput<typeof BatchModifyRequest>>;
+
 /** Request options for the {@linkcode batchModify} function. */
 export type BatchModifyOptions = ExtractRequestOptions<v.InferInput<typeof BatchModifyRequest>>;
 
+/** Successful variant of {@linkcode BatchModifyResponse} without errors. */
+export type BatchModifySuccessResponse = ExcludeErrorResponse<BatchModifyResponse>;
+
 /**
  * Modify multiple orders.
  * @param config - General configuration for Exchange API requests.
@@ -98,7 +114,7 @@ export type BatchModifyOptions = ExtractRequestOptions<v.InferInput<typeof Batch
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { batchModify } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
@@ -127,7 +143,7 @@ export async function batchModify(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<BatchModifyParameters>,
   opts?: BatchModifyOptions,
-): Promise<OrderSuccessResponse> {
+): Promise<BatchModifySuccessResponse> {
   const request = parser(BatchModifyRequest)({
     action: {
       type: "batchModify",

package/src/api/exchange/cDeposit.ts

@@ -1,16 +1,11 @@
 import * as v from "valibot";
-import { type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeUserSignedAction,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  getSignatureChainId,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Hex, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Transfer native token from the user spot account into staking for delegating to validators.
@@ -66,16 +61,42 @@ export const CDepositRequest = /* @__PURE__ */ (() => {
 })();
 export type CDepositRequest = v.InferOutput<typeof CDepositRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/**
+ * Successful response without specific data or error response.
+ * @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."),
+  );
+})();
+export type CDepositResponse = v.InferOutput<typeof CDepositResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
 
-// -------------------- Function --------------------
+import { type DeepImmutable, parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeUserSignedAction,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  getSignatureChainId,
+  type MultiSignRequestConfig,
+} from "./_base/mod.ts";
 
 /** Action parameters for the {@linkcode cDeposit} function. */
 export type CDepositParameters = ExtractRequestAction<v.InferInput<typeof CDepositRequest>>;
+
 /** Request options for the {@linkcode cDeposit} function. */
 export type CDepositOptions = ExtractRequestOptions<v.InferInput<typeof CDepositRequest>>;
 
+/** Successful variant of {@linkcode CDepositResponse} without errors. */
+export type CDepositSuccessResponse = ExcludeErrorResponse<CDepositResponse>;
+
 /** EIP-712 types for the {@linkcode cDeposit} function. */
 export const CDepositTypes = {
   "HyperliquidTransaction:CDeposit": [
@@ -100,7 +121,7 @@ export const CDepositTypes = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { cDeposit } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const transport = new HttpTransport(); // or `WebSocketTransport`
@@ -115,7 +136,7 @@ export async function cDeposit(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<CDepositParameters>,
   opts?: CDepositOptions,
-): Promise<SuccessResponse> {
+): Promise<CDepositSuccessResponse> {
   const request = parser(CDepositRequest)({
     action: {
       type: "cDeposit",