@nktkas/hyperliquid 0.26.0 → 0.27.0

package/src/api/exchange/createSubAccount.ts

@@ -1,20 +1,13 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
 
-/**
- * Create a sub-account.
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature } from "./_base/mod.ts";
+
+/** Create a sub-account. */
 export const CreateSubAccountRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -59,41 +52,63 @@ export type CreateSubAccountRequest = v.InferOutput<typeof CreateSubAccountReque
 /** Response for creating a sub-account. */
 export const CreateSubAccountResponse = /* @__PURE__ */ (() => {
   return v.pipe(
-    v.object({
-      /** Successful status. */
-      status: v.pipe(
-        v.literal("ok"),
-        v.description("Successful status."),
-      ),
-      /** Response details. */
-      response: v.pipe(
+    v.union([
+      v.pipe(
         v.object({
-          /** Type of response. */
-          type: v.pipe(
-            v.literal("createSubAccount"),
-            v.description("Type of response."),
+          /** Successful status. */
+          status: v.pipe(
+            v.literal("ok"),
+            v.description("Successful status."),
           ),
-          /** Sub-account address. */
-          data: v.pipe(
-            Address,
-            v.description("Sub-account address."),
+          /** Response details. */
+          response: v.pipe(
+            v.object({
+              /** Type of response. */
+              type: v.pipe(
+                v.literal("createSubAccount"),
+                v.description("Type of response."),
+              ),
+              /** Sub-account address. */
+              data: v.pipe(
+                Address,
+                v.description("Sub-account address."),
+              ),
+            }),
+            v.description("Response details."),
           ),
         }),
-        v.description("Response details."),
+        v.description("Successful response for creating a sub-account"),
       ),
-    }),
+      ErrorResponse,
+    ]),
     v.description("Response for creating a sub-account."),
   );
 })();
 export type CreateSubAccountResponse = v.InferOutput<typeof CreateSubAccountResponse>;
 
-// -------------------- Function --------------------
+// ============================================================
+// Execution Logic
+// ============================================================
+
+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 createSubAccount} function. */
 export type CreateSubAccountParameters = ExtractRequestAction<v.InferInput<typeof CreateSubAccountRequest>>;
+
 /** Request options for the {@linkcode createSubAccount} function. */
 export type CreateSubAccountOptions = ExtractRequestOptions<v.InferInput<typeof CreateSubAccountRequest>>;
 
+/** Successful variant of {@linkcode CreateSubAccountResponse} without errors. */
+export type CreateSubAccountSuccessResponse = ExcludeErrorResponse<CreateSubAccountResponse>;
+
 /**
  * Create a sub-account.
  * @param config - General configuration for Exchange API requests.
@@ -104,12 +119,11 @@ export type CreateSubAccountOptions = ExtractRequestOptions<v.InferInput<typeof
  * @throws {ApiRequestError} When the API returns an unsuccessful response.
  * @throws {TransportError} When the transport layer throws an error.
  *
- * @see null
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { createSubAccount } 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`
@@ -124,7 +138,7 @@ export async function createSubAccount(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<CreateSubAccountParameters>,
   opts?: CreateSubAccountOptions,
-): Promise<CreateSubAccountResponse> {
+): Promise<CreateSubAccountSuccessResponse> {
   const request = parser(CreateSubAccountRequest)({
     action: {
       type: "createSubAccount",

package/src/api/exchange/createVault.ts

@@ -1,20 +1,13 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
 
-/**
- * Create a vault.
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature } from "./_base/mod.ts";
+
+/** Create a vault. */
 export const CreateVaultRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -76,41 +69,63 @@ export type CreateVaultRequest = v.InferOutput<typeof CreateVaultRequest>;
 /** Response for creating a vault. */
 export const CreateVaultResponse = /* @__PURE__ */ (() => {
   return v.pipe(
-    v.object({
-      /** Successful status. */
-      status: v.pipe(
-        v.literal("ok"),
-        v.description("Successful status."),
-      ),
-      /** Response details. */
-      response: v.pipe(
+    v.union([
+      v.pipe(
         v.object({
-          /** Type of response. */
-          type: v.pipe(
-            v.literal("createVault"),
-            v.description("Type of response."),
+          /** Successful status. */
+          status: v.pipe(
+            v.literal("ok"),
+            v.description("Successful status."),
           ),
-          /** Vault address. */
-          data: v.pipe(
-            Address,
-            v.description("Vault address."),
+          /** Response details. */
+          response: v.pipe(
+            v.object({
+              /** Type of response. */
+              type: v.pipe(
+                v.literal("createVault"),
+                v.description("Type of response."),
+              ),
+              /** Vault address. */
+              data: v.pipe(
+                Address,
+                v.description("Vault address."),
+              ),
+            }),
+            v.description("Response details."),
           ),
         }),
-        v.description("Response details."),
+        v.description("Successful response for creating a vault"),
       ),
-    }),
+      ErrorResponse,
+    ]),
     v.description("Response for creating a vault."),
   );
 })();
 export type CreateVaultResponse = v.InferOutput<typeof CreateVaultResponse>;
 
-// -------------------- Function --------------------
+// ============================================================
+// Execution Logic
+// ============================================================
+
+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 createVault} function. */
 export type CreateVaultParameters = ExtractRequestAction<v.InferInput<typeof CreateVaultRequest>>;
+
 /** Request options for the {@linkcode createVault} function. */
 export type CreateVaultOptions = ExtractRequestOptions<v.InferInput<typeof CreateVaultRequest>>;
 
+/** Successful variant of {@linkcode CreateVaultResponse} without errors. */
+export type CreateVaultSuccessResponse = ExcludeErrorResponse<CreateVaultResponse>;
+
 /**
  * Create a vault.
  * @param config - General configuration for Exchange API requests.
@@ -121,12 +136,11 @@ export type CreateVaultOptions = ExtractRequestOptions<v.InferInput<typeof Creat
  * @throws {ApiRequestError} When the API returns an unsuccessful response.
  * @throws {TransportError} When the transport layer throws an error.
  *
- * @see null
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { createVault } 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`
@@ -145,7 +159,7 @@ export async function createVault(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<CreateVaultParameters>,
   opts?: CreateVaultOptions,
-): Promise<CreateVaultResponse> {
+): Promise<CreateVaultSuccessResponse> {
   const request = parser(CreateVaultRequest)({
     action: {
       type: "createVault",

package/src/api/exchange/evmUserModify.ts

@@ -1,15 +1,11 @@
 import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  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";
 
 /**
  * Configure block type for EVM transactions.
@@ -55,16 +51,41 @@ export const EvmUserModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type EvmUserModifyRequest = v.InferOutput<typeof EvmUserModifyRequest>;
 
-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/hyperevm/dual-block-architecture
+ */
+export const EvmUserModifyResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type EvmUserModifyResponse = v.InferOutput<typeof EvmUserModifyResponse>;
+
+// ============================================================
+// 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 evmUserModify} function. */
 export type EvmUserModifyParameters = ExtractRequestAction<v.InferInput<typeof EvmUserModifyRequest>>;
+
 /** Request options for the {@linkcode evmUserModify} function. */
 export type EvmUserModifyOptions = ExtractRequestOptions<v.InferInput<typeof EvmUserModifyRequest>>;
 
+/** Successful variant of {@linkcode EvmUserModifyResponse} without errors. */
+export type EvmUserModifySuccessResponse = ExcludeErrorResponse<EvmUserModifyResponse>;
+
 /**
  * Configure block type for EVM transactions.
  * @param config - General configuration for Exchange API requests.
@@ -80,7 +101,7 @@ export type EvmUserModifyOptions = ExtractRequestOptions<v.InferInput<typeof Evm
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { evmUserModify } 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`
@@ -95,7 +116,7 @@ export async function evmUserModify(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<EvmUserModifyParameters>,
   opts?: EvmUserModifyOptions,
-): Promise<SuccessResponse> {
+): Promise<EvmUserModifySuccessResponse> {
   const request = parser(EvmUserModifyRequest)({
     action: {
       type: "evmUserModify",

package/src/api/exchange/linkStakingUser.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";
 
 /**
  * Link staking and trading accounts for fee discount attribution.
@@ -87,16 +82,42 @@ export const LinkStakingUserRequest = /* @__PURE__ */ (() => {
 })();
 export type LinkStakingUserRequest = v.InferOutput<typeof LinkStakingUserRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
+ */
+export const LinkStakingUserResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type LinkStakingUserResponse = v.InferOutput<typeof LinkStakingUserResponse>;
+
+// ============================================================
+// 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 linkStakingUser} function. */
 export type LinkStakingUserParameters = ExtractRequestAction<v.InferInput<typeof LinkStakingUserRequest>>;
+
 /** Request options for the {@linkcode linkStakingUser} function. */
 export type LinkStakingUserOptions = ExtractRequestOptions<v.InferInput<typeof LinkStakingUserRequest>>;
 
+/** Successful variant of {@linkcode LinkStakingUserResponse} without errors. */
+export type LinkStakingUserSuccessResponse = ExcludeErrorResponse<LinkStakingUserResponse>;
+
 /** EIP-712 types for the {@linkcode linkStakingUser} function. */
 export const LinkStakingUserTypes = {
   "HyperliquidTransaction:LinkStakingUser": [
@@ -122,7 +143,7 @@ export const LinkStakingUserTypes = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { linkStakingUser } 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`
@@ -137,7 +158,7 @@ export async function linkStakingUser(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<LinkStakingUserParameters>,
   opts?: LinkStakingUserOptions,
-): Promise<SuccessResponse> {
+): Promise<LinkStakingUserSuccessResponse> {
   const request = parser(LinkStakingUserRequest)({
     action: {
       type: "linkStakingUser",

package/src/api/exchange/modify.ts

@@ -1,17 +1,12 @@
 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 { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+import { PlaceOrderParamsSchema } from "../_common_schemas.ts";
 
 /**
  * Modify an order.
@@ -67,16 +62,41 @@ export const ModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type ModifyRequest = v.InferOutput<typeof ModifyRequest>;
 
-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#modify-an-order
+ */
+export const ModifyResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type ModifyResponse = v.InferOutput<typeof ModifyResponse>;
+
+// ============================================================
+// 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 modify} function. */
 export type ModifyParameters = ExtractRequestAction<v.InferInput<typeof ModifyRequest>>;
+
 /** Request options for the {@linkcode modify} function. */
 export type ModifyOptions = ExtractRequestOptions<v.InferInput<typeof ModifyRequest>>;
 
+/** Successful variant of {@linkcode ModifyResponse} without errors. */
+export type ModifySuccessResponse = ExcludeErrorResponse<ModifyResponse>;
+
 /**
  * Modify an order.
  * @param config - General configuration for Exchange API requests.
@@ -92,7 +112,7 @@ export type ModifyOptions = ExtractRequestOptions<v.InferInput<typeof ModifyRequ
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { modify } 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`
@@ -118,7 +138,7 @@ export async function modify(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<ModifyParameters>,
   opts?: ModifyOptions,
-): Promise<SuccessResponse> {
+): Promise<ModifySuccessResponse> {
   const request = parser(ModifyRequest)({
     action: {
       type: "modify",