@nktkas/hyperliquid 0.26.0 → 0.27.0

package/src/api/exchange/spotUser.ts

@@ -1,20 +1,13 @@
 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
+// ============================================================
 
-/**
- * Opt Out of Spot Dusting.
- * @see null
- */
+import { UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Opt Out of Spot Dusting. */
 export const SpotUserRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -61,16 +54,38 @@ export const SpotUserRequest = /* @__PURE__ */ (() => {
 })();
 export type SpotUserRequest = v.InferOutput<typeof SpotUserRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const SpotUserResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type SpotUserResponse = v.InferOutput<typeof SpotUserResponse>;
+
+// ============================================================
+// 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 spotUser} function. */
 export type SpotUserParameters = ExtractRequestAction<v.InferInput<typeof SpotUserRequest>>;
+
 /** Request options for the {@linkcode spotUser} function. */
 export type SpotUserOptions = ExtractRequestOptions<v.InferInput<typeof SpotUserRequest>>;
 
+/** Successful variant of {@linkcode SpotUserResponse} without errors. */
+export type SpotUserSuccessResponse = ExcludeErrorResponse<SpotUserResponse>;
+
 /**
  * Opt Out of Spot Dusting.
  * @param config - General configuration for Exchange API requests.
@@ -81,12 +96,11 @@ export type SpotUserOptions = ExtractRequestOptions<v.InferInput<typeof SpotUser
  * @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 { spotUser } 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`
@@ -101,7 +115,7 @@ export async function spotUser(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<SpotUserParameters>,
   opts?: SpotUserOptions,
-): Promise<SuccessResponse> {
+): Promise<SpotUserSuccessResponse> {
   const request = parser(SpotUserRequest)({
     action: {
       type: "spotUser",

package/src/api/exchange/subAccountModify.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
+// ============================================================
 
-/**
- * Modify a sub-account's.
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Modify a sub-account's. */
 export const SubAccountModifyRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -61,16 +54,38 @@ export const SubAccountModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type SubAccountModifyRequest = v.InferOutput<typeof SubAccountModifyRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const SubAccountModifyResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type SubAccountModifyResponse = v.InferOutput<typeof SubAccountModifyResponse>;
+
+// ============================================================
+// 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 subAccountModify} function. */
 export type SubAccountModifyParameters = ExtractRequestAction<v.InferInput<typeof SubAccountModifyRequest>>;
+
 /** Request options for the {@linkcode subAccountModify} function. */
 export type SubAccountModifyOptions = ExtractRequestOptions<v.InferInput<typeof SubAccountModifyRequest>>;
 
+/** Successful variant of {@linkcode SubAccountModifyResponse} without errors. */
+export type SubAccountModifySuccessResponse = ExcludeErrorResponse<SubAccountModifyResponse>;
+
 /**
  * Modify a sub-account's.
  * @param config - General configuration for Exchange API requests.
@@ -81,12 +96,11 @@ export type SubAccountModifyOptions = 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 { subAccountModify } 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`
@@ -101,7 +115,7 @@ export async function subAccountModify(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<SubAccountModifyParameters>,
   opts?: SubAccountModifyOptions,
-): Promise<SuccessResponse> {
+): Promise<SubAccountModifySuccessResponse> {
   const request = parser(SubAccountModifyRequest)({
     action: {
       type: "subAccountModify",

package/src/api/exchange/subAccountSpotTransfer.ts

@@ -1,20 +1,13 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, TokenId, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
 
-/**
- * Transfer between sub-accounts (spot).
- * @see null
- */
+import { Address, TokenId, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Transfer between sub-accounts (spot). */
 export const SubAccountSpotTransferRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -70,16 +63,38 @@ export const SubAccountSpotTransferRequest = /* @__PURE__ */ (() => {
 })();
 export type SubAccountSpotTransferRequest = v.InferOutput<typeof SubAccountSpotTransferRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const SubAccountSpotTransferResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type SubAccountSpotTransferResponse = v.InferOutput<typeof SubAccountSpotTransferResponse>;
+
+// ============================================================
+// 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 subAccountSpotTransfer} function. */
 export type SubAccountSpotTransferParameters = ExtractRequestAction<v.InferInput<typeof SubAccountSpotTransferRequest>>;
+
 /** Request options for the {@linkcode subAccountSpotTransfer} function. */
 export type SubAccountSpotTransferOptions = ExtractRequestOptions<v.InferInput<typeof SubAccountSpotTransferRequest>>;
 
+/** Successful variant of {@linkcode SubAccountSpotTransferResponse} without errors. */
+export type SubAccountSpotTransferSuccessResponse = ExcludeErrorResponse<SubAccountSpotTransferResponse>;
+
 /**
  * Transfer between sub-accounts (spot).
  * @param config - General configuration for Exchange API requests.
@@ -90,12 +105,11 @@ export type SubAccountSpotTransferOptions = ExtractRequestOptions<v.InferInput<t
  * @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 { subAccountSpotTransfer } 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 +129,7 @@ export async function subAccountSpotTransfer(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<SubAccountSpotTransferParameters>,
   opts?: SubAccountSpotTransferOptions,
-): Promise<SuccessResponse> {
+): Promise<SubAccountSpotTransferSuccessResponse> {
   const request = parser(SubAccountSpotTransferRequest)({
     action: {
       type: "subAccountSpotTransfer",

package/src/api/exchange/subAccountTransfer.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
+// ============================================================
 
-/**
- * Transfer between sub-accounts (perpetual).
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Transfer between sub-accounts (perpetual). */
 export const SubAccountTransferRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -65,16 +58,38 @@ export const SubAccountTransferRequest = /* @__PURE__ */ (() => {
 })();
 export type SubAccountTransferRequest = v.InferOutput<typeof SubAccountTransferRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const SubAccountTransferResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type SubAccountTransferResponse = v.InferOutput<typeof SubAccountTransferResponse>;
+
+// ============================================================
+// 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 subAccountTransfer} function. */
 export type SubAccountTransferParameters = ExtractRequestAction<v.InferInput<typeof SubAccountTransferRequest>>;
+
 /** Request options for the {@linkcode subAccountTransfer} function. */
 export type SubAccountTransferOptions = ExtractRequestOptions<v.InferInput<typeof SubAccountTransferRequest>>;
 
+/** Successful variant of {@linkcode SubAccountTransferResponse} without errors. */
+export type SubAccountTransferSuccessResponse = ExcludeErrorResponse<SubAccountTransferResponse>;
+
 /**
  * Transfer between sub-accounts (perpetual).
  * @param config - General configuration for Exchange API requests.
@@ -85,12 +100,11 @@ export type SubAccountTransferOptions = ExtractRequestOptions<v.InferInput<typeo
  * @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 { subAccountTransfer } 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`
@@ -105,7 +119,7 @@ export async function subAccountTransfer(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<SubAccountTransferParameters>,
   opts?: SubAccountTransferOptions,
-): Promise<SuccessResponse> {
+): Promise<SubAccountTransferSuccessResponse> {
   const request = parser(SubAccountTransferRequest)({
     action: {
       type: "subAccountTransfer",

package/src/api/exchange/tokenDelegate.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";
 
 /**
  * Delegate or undelegate native tokens to or from a validator.
@@ -76,16 +71,42 @@ export const TokenDelegateRequest = /* @__PURE__ */ (() => {
 })();
 export type TokenDelegateRequest = v.InferOutput<typeof TokenDelegateRequest>;
 
-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#delegate-or-undelegate-stake-from-validator
+ */
+export const TokenDelegateResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type TokenDelegateResponse = v.InferOutput<typeof TokenDelegateResponse>;
+
+// ============================================================
+// 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 tokenDelegate} function. */
 export type TokenDelegateParameters = ExtractRequestAction<v.InferInput<typeof TokenDelegateRequest>>;
+
 /** Request options for the {@linkcode tokenDelegate} function. */
 export type TokenDelegateOptions = ExtractRequestOptions<v.InferInput<typeof TokenDelegateRequest>>;
 
+/** Successful variant of {@linkcode TokenDelegateResponse} without errors. */
+export type TokenDelegateSuccessResponse = ExcludeErrorResponse<TokenDelegateResponse>;
+
 /** EIP-712 types for the {@linkcode tokenDelegate} function. */
 export const TokenDelegateTypes = {
   "HyperliquidTransaction:TokenDelegate": [
@@ -112,7 +133,7 @@ export const TokenDelegateTypes = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { tokenDelegate } 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 +148,7 @@ export async function tokenDelegate(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<TokenDelegateParameters>,
   opts?: TokenDelegateOptions,
-): Promise<SuccessResponse> {
+): Promise<TokenDelegateSuccessResponse> {
   const request = parser(TokenDelegateRequest)({
     action: {
       type: "tokenDelegate",

package/src/api/exchange/twapCancel.ts

@@ -1,15 +1,11 @@
 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
+// ============================================================
+
+import { Address, UnsignedInteger } from "../_base.ts";
+import { Signature } from "./_base/mod.ts";
 
 /**
  * Cancel a TWAP order.
@@ -65,7 +61,10 @@ export const TwapCancelRequest = /* @__PURE__ */ (() => {
 })();
 export type TwapCancelRequest = v.InferOutput<typeof TwapCancelRequest>;
 
-/** Response for canceling a TWAP order. */
+/**
+ * Response for canceling a TWAP order.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-a-twap-order
+ */
 export const TwapCancelResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -111,50 +110,29 @@ export const TwapCancelResponse = /* @__PURE__ */ (() => {
 })();
 export type TwapCancelResponse = v.InferOutput<typeof TwapCancelResponse>;
 
-/** Successful variant of {@linkcode TwapCancelResponse} without errors. */
-export const TwapCancelSuccessResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Successful status. */
-      status: v.pipe(
-        v.literal("ok"),
-        v.description("Successful status."),
-      ),
-      /** Response details. */
-      response: v.pipe(
-        v.object({
-          /** Type of response. */
-          type: v.pipe(
-            v.literal("twapCancel"),
-            v.description("Type of response."),
-          ),
-          /** Specific data. */
-          data: v.pipe(
-            v.object({
-              /** Status of the operation. */
-              status: v.pipe(
-                v.string(),
-                v.description("Status of the operation."),
-              ),
-            }),
-            v.description("Specific data."),
-          ),
-        }),
-        v.description("Response details."),
-      ),
-    }),
-    v.description("Successful variant of `TwapCancelResponse` without errors."),
-  );
-})();
-export type TwapCancelSuccessResponse = v.InferOutput<typeof TwapCancelSuccessResponse>;
+// ============================================================
+// 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 twapCancel} function. */
 export type TwapCancelParameters = ExtractRequestAction<v.InferInput<typeof TwapCancelRequest>>;
+
 /** Request options for the {@linkcode twapCancel} function. */
 export type TwapCancelOptions = ExtractRequestOptions<v.InferInput<typeof TwapCancelRequest>>;
 
+/** Successful variant of {@linkcode TwapCancelResponse} without errors. */
+export type TwapCancelSuccessResponse = ExcludeErrorResponse<TwapCancelResponse>;
+
 /**
  * Cancel a TWAP order.
  * @param config - General configuration for Exchange API requests.
@@ -170,7 +148,7 @@ export type TwapCancelOptions = ExtractRequestOptions<v.InferInput<typeof TwapCa
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { twapCancel } 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`