@nktkas/hyperliquid 0.26.0 → 0.27.0

package/src/api/exchange/multiSig.ts

@@ -1,57 +1,52 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeMultiSigAction,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  getSignatureChainId,
-  Signature,
-} from "./_base/mod.ts";
 
-import { ApproveAgentRequest } from "./approveAgent.ts";
-import { ApproveBuilderFeeRequest } from "./approveBuilderFee.ts";
-import { BatchModifyRequest } from "./batchModify.ts";
-import { CancelRequest, CancelSuccessResponse } from "./cancel.ts";
-import { CancelByCloidRequest } from "./cancelByCloid.ts";
-import { ClaimRewardsRequest } from "./claimRewards.ts";
-import { CDepositRequest } from "./cDeposit.ts";
-import { ConvertToMultiSigUserRequest } from "./convertToMultiSigUser.ts";
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, Hex, UnsignedInteger } from "../_base.ts";
+import { Signature } from "./_base/mod.ts";
+import { ApproveAgentRequest, ApproveAgentResponse } from "./approveAgent.ts";
+import { ApproveBuilderFeeRequest, ApproveBuilderFeeResponse } from "./approveBuilderFee.ts";
+import { BatchModifyRequest, BatchModifyResponse } from "./batchModify.ts";
+import { CancelRequest, CancelResponse } from "./cancel.ts";
+import { CancelByCloidRequest, CancelByCloidResponse } from "./cancelByCloid.ts";
+import { ClaimRewardsRequest, ClaimRewardsResponse } from "./claimRewards.ts";
+import { CDepositRequest, CDepositResponse } from "./cDeposit.ts";
+import { ConvertToMultiSigUserRequest, ConvertToMultiSigUserResponse } from "./convertToMultiSigUser.ts";
 import { CreateSubAccountRequest, CreateSubAccountResponse } from "./createSubAccount.ts";
 import { CreateVaultRequest, CreateVaultResponse } from "./createVault.ts";
-import { CSignerActionRequest } from "./cSignerAction.ts";
-import { CValidatorActionRequest } from "./cValidatorAction.ts";
-import { CWithdrawRequest } from "./cWithdraw.ts";
-import { EvmUserModifyRequest } from "./evmUserModify.ts";
-import { ModifyRequest } from "./modify.ts";
-import { NoopRequest } from "./noop.ts";
-import { OrderRequest, OrderSuccessResponse } from "./order.ts";
-import { RegisterReferrerRequest } from "./registerReferrer.ts";
-import { ReserveRequestWeightRequest } from "./reserveRequestWeight.ts";
-import { ScheduleCancelRequest } from "./scheduleCancel.ts";
-import { SetDisplayNameRequest } from "./setDisplayName.ts";
-import { SetReferrerRequest } from "./setReferrer.ts";
-import { SpotDeployRequest } from "./spotDeploy.ts";
-import { SubAccountModifyRequest } from "./subAccountModify.ts";
-import { TokenDelegateRequest } from "./tokenDelegate.ts";
-import { TwapOrderRequest, TwapOrderSuccessResponse } from "./twapOrder.ts";
-import { UsdClassTransferRequest } from "./usdClassTransfer.ts";
-import { VaultDistributeRequest } from "./vaultDistribute.ts";
-import { Withdraw3Request } from "./withdraw3.ts";
-import { PerpDeployRequest } from "./perpDeploy.ts";
-import { SendAssetRequest } from "./sendAsset.ts";
-import { SpotSendRequest } from "./spotSend.ts";
-import { SpotUserRequest } from "./spotUser.ts";
-import { SubAccountSpotTransferRequest } from "./subAccountSpotTransfer.ts";
-import { SubAccountTransferRequest } from "./subAccountTransfer.ts";
-import { TwapCancelRequest, TwapCancelSuccessResponse } from "./twapCancel.ts";
-import { UpdateIsolatedMarginRequest } from "./updateIsolatedMargin.ts";
-import { UpdateLeverageRequest } from "./updateLeverage.ts";
-import { UsdSendRequest } from "./usdSend.ts";
-import { VaultModifyRequest } from "./vaultModify.ts";
-import { VaultTransferRequest } from "./vaultTransfer.ts";
-
-// -------------------- Schemas --------------------
+import { CSignerActionRequest, CSignerActionResponse } from "./cSignerAction.ts";
+import { CValidatorActionRequest, CValidatorActionResponse } from "./cValidatorAction.ts";
+import { CWithdrawRequest, CWithdrawResponse } from "./cWithdraw.ts";
+import { EvmUserModifyRequest, EvmUserModifyResponse } from "./evmUserModify.ts";
+import { ModifyRequest, ModifyResponse } from "./modify.ts";
+import { NoopRequest, NoopResponse } from "./noop.ts";
+import { OrderRequest, OrderResponse } from "./order.ts";
+import { RegisterReferrerRequest, RegisterReferrerResponse } from "./registerReferrer.ts";
+import { ReserveRequestWeightRequest, ReserveRequestWeightResponse } from "./reserveRequestWeight.ts";
+import { ScheduleCancelRequest, ScheduleCancelResponse } from "./scheduleCancel.ts";
+import { SetDisplayNameRequest, SetDisplayNameResponse } from "./setDisplayName.ts";
+import { SetReferrerRequest, SetReferrerResponse } from "./setReferrer.ts";
+import { SpotDeployRequest, SpotDeployResponse } from "./spotDeploy.ts";
+import { SubAccountModifyRequest, SubAccountModifyResponse } from "./subAccountModify.ts";
+import { TokenDelegateRequest, TokenDelegateResponse } from "./tokenDelegate.ts";
+import { TwapOrderRequest, TwapOrderResponse } from "./twapOrder.ts";
+import { UsdClassTransferRequest, UsdClassTransferResponse } from "./usdClassTransfer.ts";
+import { VaultDistributeRequest, VaultDistributeResponse } from "./vaultDistribute.ts";
+import { Withdraw3Request, Withdraw3Response } from "./withdraw3.ts";
+import { PerpDeployRequest, PerpDeployResponse } from "./perpDeploy.ts";
+import { SendAssetRequest, SendAssetResponse } from "./sendAsset.ts";
+import { SpotSendRequest, SpotSendResponse } from "./spotSend.ts";
+import { SpotUserRequest, SpotUserResponse } from "./spotUser.ts";
+import { SubAccountSpotTransferRequest, SubAccountSpotTransferResponse } from "./subAccountSpotTransfer.ts";
+import { SubAccountTransferRequest, SubAccountTransferResponse } from "./subAccountTransfer.ts";
+import { TwapCancelRequest, TwapCancelResponse } from "./twapCancel.ts";
+import { UpdateIsolatedMarginRequest, UpdateIsolatedMarginResponse } from "./updateIsolatedMargin.ts";
+import { UpdateLeverageRequest, UpdateLeverageResponse } from "./updateLeverage.ts";
+import { UsdSendRequest, UsdSendResponse } from "./usdSend.ts";
+import { VaultModifyRequest, VaultModifyResponse } from "./vaultModify.ts";
+import { VaultTransferRequest, VaultTransferResponse } from "./vaultTransfer.ts";
 
 /**
  * A multi-signature request.
@@ -172,26 +167,85 @@ export const MultiSigRequest = /* @__PURE__ */ (() => {
 })();
 export type MultiSigRequest = v.InferOutput<typeof MultiSigRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export {
-  CancelSuccessResponse,
-  CreateSubAccountResponse,
-  CreateVaultResponse,
-  OrderSuccessResponse,
-  SuccessResponse,
-  TwapCancelSuccessResponse,
-  TwapOrderSuccessResponse,
-};
+/**
+ * A response related to an action.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
+ */
+export const MultiSigResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([
+      ApproveAgentResponse,
+      ApproveBuilderFeeResponse,
+      BatchModifyResponse,
+      CancelResponse,
+      CancelByCloidResponse,
+      CDepositResponse,
+      ClaimRewardsResponse,
+      ConvertToMultiSigUserResponse,
+      CreateSubAccountResponse,
+      CreateVaultResponse,
+      CSignerActionResponse,
+      CValidatorActionResponse,
+      CWithdrawResponse,
+      EvmUserModifyResponse,
+      ModifyResponse,
+      NoopResponse,
+      OrderResponse,
+      PerpDeployResponse,
+      RegisterReferrerResponse,
+      ReserveRequestWeightResponse,
+      ScheduleCancelResponse,
+      SendAssetResponse,
+      SetDisplayNameResponse,
+      SetReferrerResponse,
+      SpotDeployResponse,
+      SpotSendResponse,
+      SpotUserResponse,
+      SubAccountModifyResponse,
+      SubAccountSpotTransferResponse,
+      SubAccountTransferResponse,
+      TokenDelegateResponse,
+      TwapCancelResponse,
+      TwapOrderResponse,
+      UpdateIsolatedMarginResponse,
+      UpdateLeverageResponse,
+      UsdClassTransferResponse,
+      UsdSendResponse,
+      VaultDistributeResponse,
+      VaultModifyResponse,
+      VaultTransferResponse,
+      Withdraw3Response,
+    ]),
+    v.description("A response related to an action."),
+  );
+})();
+export type MultiSigResponse = v.InferOutput<typeof MultiSigResponse>;
 
-// -------------------- Function --------------------
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.ts";
+import {
+  type ExchangeRequestConfig,
+  type ExcludeErrorResponse,
+  executeMultiSigAction,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  getSignatureChainId,
+} from "./_base/mod.ts";
 
 /** Action parameters for the {@linkcode multiSig} function. */
 export type MultiSigParameters =
   & ExtractRequestAction<v.InferInput<typeof MultiSigRequest>>
   & Pick<v.InferInput<typeof MultiSigRequest>, "nonce">;
+
 /** Request options for the {@linkcode multiSig} function. */
 export type MultiSigOptions = ExtractRequestOptions<v.InferInput<typeof MultiSigRequest>>;
 
+/** Successful variant of {@linkcode MultiSigResponse} without errors. */
+export type MultiSigSuccessResponse = ExcludeErrorResponse<MultiSigResponse>;
+
 /** EIP-712 types for the {@linkcode multiSig} function. */
 export const MultiSigTypes = {
   "HyperliquidTransaction:SendMultiSig": [
@@ -217,7 +271,7 @@ export const MultiSigTypes = {
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { multiSig, parser, ScheduleCancelRequest } from "@nktkas/hyperliquid/api/exchange";
  * import { signL1Action } from "@nktkas/hyperliquid/signing";
- * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { privateKeyToAccount } from "viem/accounts";
  *
  * const wallet = privateKeyToAccount("0x..."); // viem or ethers
  * const multiSigUser = "0x...";
@@ -266,20 +320,11 @@ export const MultiSigTypes = {
  * );
  * ```
  */
-export async function multiSig<
-  T extends
-    | SuccessResponse
-    | CancelSuccessResponse
-    | CreateSubAccountResponse
-    | CreateVaultResponse
-    | OrderSuccessResponse
-    | TwapOrderSuccessResponse
-    | TwapCancelSuccessResponse,
->(
+export async function multiSig(
   config: ExchangeRequestConfig,
   paramsAndNonce: DeepImmutable<MultiSigParameters>,
   opts?: MultiSigOptions,
-): Promise<T> {
+): Promise<MultiSigSuccessResponse> {
   const { nonce, ...params } = paramsAndNonce;
 
   const request = parser(MultiSigRequest)({

package/src/api/exchange/noop.ts

@@ -1,14 +1,11 @@
 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";
 
 /**
  * This action does not do anything (no operation), but causes the nonce to be marked as used.
@@ -49,14 +46,37 @@ export const NoopRequest = /* @__PURE__ */ (() => {
 })();
 export type NoopRequest = v.InferOutput<typeof NoopRequest>;
 
-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#invalidate-pending-nonce-noop
+ */
+export const NoopResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type NoopResponse = v.InferOutput<typeof NoopResponse>;
+
+// ============================================================
+// 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 noop} function. */
 export type NoopOptions = ExtractRequestOptions<v.InferInput<typeof NoopRequest>>;
 
+/** Successful variant of {@linkcode NoopResponse} without errors. */
+export type NoopSuccessResponse = ExcludeErrorResponse<NoopResponse>;
+
 /**
  * This action does not do anything (no operation), but causes the nonce to be marked as used.
  * @param config - General configuration for Exchange API requests.
@@ -72,7 +92,7 @@ export type NoopOptions = ExtractRequestOptions<v.InferInput<typeof NoopRequest>
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { noop } 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`
@@ -83,7 +103,7 @@ export type NoopOptions = ExtractRequestOptions<v.InferInput<typeof NoopRequest>
 export async function noop(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   opts?: NoopOptions,
-): Promise<SuccessResponse> {
+): Promise<NoopSuccessResponse> {
   const request = parser(NoopRequest)({
     action: {
       type: "noop",

package/src/api/exchange/order.ts

@@ -1,17 +1,12 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, 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, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import { Signature } from "./_base/mod.ts";
+import { PlaceOrderParamsSchema } from "../_common_schemas.ts";
 
 /**
  * Place an order(s).
@@ -100,7 +95,10 @@ export const OrderRequest = /* @__PURE__ */ (() => {
 })();
 export type OrderRequest = v.InferOutput<typeof OrderRequest>;
 
-/** Response for order placement and batch modifications. */
+/**
+ * Response for order placement and batch modifications.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
+ */
 export const OrderResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -193,99 +191,29 @@ export const OrderResponse = /* @__PURE__ */ (() => {
 })();
 export type OrderResponse = v.InferOutput<typeof OrderResponse>;
 
-/** Successful variant of {@linkcode OrderResponse} without errors. */
-export const OrderSuccessResponse = /* @__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("order"),
-            v.description("Type of response."),
-          ),
-          /** Specific data. */
-          data: v.pipe(
-            v.object({
-              /** Array of successful order statuses. */
-              statuses: v.pipe(
-                v.array(
-                  v.union([
-                    v.object({
-                      /** Resting order status. */
-                      resting: v.pipe(
-                        v.object({
-                          /** Order ID. */
-                          oid: v.pipe(
-                            UnsignedInteger,
-                            v.description("Order ID."),
-                          ),
-                          /** Client Order ID. */
-                          cloid: v.pipe(
-                            v.optional(v.pipe(Hex, v.length(34))),
-                            v.description("Client Order ID."),
-                          ),
-                        }),
-                        v.description("Resting order status."),
-                      ),
-                    }),
-                    v.object({
-                      /** Filled order status. */
-                      filled: v.pipe(
-                        v.object({
-                          /** Total size filled. */
-                          totalSz: v.pipe(
-                            UnsignedDecimal,
-                            v.description("Total size filled."),
-                          ),
-                          /** Average price of fill. */
-                          avgPx: v.pipe(
-                            UnsignedDecimal,
-                            v.description("Average price of fill."),
-                          ),
-                          /** Order ID. */
-                          oid: v.pipe(
-                            UnsignedInteger,
-                            v.description("Order ID."),
-                          ),
-                          /** Client Order ID. */
-                          cloid: v.pipe(
-                            v.optional(v.pipe(Hex, v.length(34))),
-                            v.description("Client Order ID."),
-                          ),
-                        }),
-                        v.description("Filled order status."),
-                      ),
-                    }),
-                  ]),
-                ),
-                v.description("Array of successful order statuses."),
-              ),
-            }),
-            v.description("Specific data."),
-          ),
-        }),
-        v.description("Response details."),
-      ),
-    }),
-    v.description("Successful variant of `OrderResponse` without errors."),
-  );
-})();
-export type OrderSuccessResponse = v.InferOutput<typeof OrderSuccessResponse>;
+// ============================================================
+// 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 order} function. */
 export type OrderParameters = ExtractRequestAction<v.InferInput<typeof OrderRequest>>;
+
 /** Request options for the {@linkcode order} function. */
 export type OrderOptions = ExtractRequestOptions<v.InferInput<typeof OrderRequest>>;
 
+/** Successful variant of {@linkcode OrderResponse} without errors. */
+export type OrderSuccessResponse = ExcludeErrorResponse<OrderResponse>;
+
 /**
  * Place an order(s).
  * @param config - General configuration for Exchange API requests.
@@ -301,7 +229,7 @@ export type OrderOptions = ExtractRequestOptions<v.InferInput<typeof OrderReques
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { order } 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`

package/src/api/exchange/perpDeploy.ts

@@ -1,15 +1,11 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
 
-// -------------------- Schemas --------------------
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Deploying HIP-3 assets.
@@ -308,16 +304,41 @@ export const PerpDeployRequest = /* @__PURE__ */ (() => {
 })();
 export type PerpDeployRequest = v.InferOutput<typeof PerpDeployRequest>;
 
-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/deploying-hip-3-assets
+ */
+export const PerpDeployResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type PerpDeployResponse = v.InferOutput<typeof PerpDeployResponse>;
+
+// ============================================================
+// 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 perpDeploy} function. */
 export type PerpDeployParameters = ExtractRequestAction<v.InferInput<typeof PerpDeployRequest>>;
+
 /** Request options for the {@linkcode perpDeploy} function. */
 export type PerpDeployOptions = ExtractRequestOptions<v.InferInput<typeof PerpDeployRequest>>;
 
+/** Successful variant of {@linkcode PerpDeployResponse} without errors. */
+export type PerpDeploySuccessResponse = ExcludeErrorResponse<PerpDeployResponse>;
+
 /**
  * Deploying HIP-3 assets.
  * @param config - General configuration for Exchange API requests.
@@ -333,7 +354,7 @@ export type PerpDeployOptions = ExtractRequestOptions<v.InferInput<typeof PerpDe
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { perpDeploy } 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`
@@ -361,7 +382,7 @@ export async function perpDeploy(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<PerpDeployParameters>,
   opts?: PerpDeployOptions,
-): Promise<SuccessResponse> {
+): Promise<PerpDeploySuccessResponse> {
   const request = parser(PerpDeployRequest)({
     action: {
       type: "perpDeploy",

package/src/api/exchange/registerReferrer.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
+// ============================================================
 
-/**
- * Create a referral code.
- * @see null
- */
+import { UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Create a referral code. */
 export const RegisterReferrerRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -56,16 +49,38 @@ export const RegisterReferrerRequest = /* @__PURE__ */ (() => {
 })();
 export type RegisterReferrerRequest = v.InferOutput<typeof RegisterReferrerRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const RegisterReferrerResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type RegisterReferrerResponse = v.InferOutput<typeof RegisterReferrerResponse>;
+
+// ============================================================
+// 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 registerReferrer} function. */
 export type RegisterReferrerParameters = ExtractRequestAction<v.InferInput<typeof RegisterReferrerRequest>>;
+
 /** Request options for the {@linkcode registerReferrer} function. */
 export type RegisterReferrerOptions = ExtractRequestOptions<v.InferInput<typeof RegisterReferrerRequest>>;
 
+/** Successful variant of {@linkcode RegisterReferrerResponse} without errors. */
+export type RegisterReferrerSuccessResponse = ExcludeErrorResponse<RegisterReferrerResponse>;
+
 /**
  * Create a referral code.
  * @param config - General configuration for Exchange API requests.
@@ -76,12 +91,11 @@ export type RegisterReferrerOptions = 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 { registerReferrer } 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`
@@ -96,7 +110,7 @@ export async function registerReferrer(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<RegisterReferrerParameters>,
   opts?: RegisterReferrerOptions,
-): Promise<SuccessResponse> {
+): Promise<RegisterReferrerSuccessResponse> {
   const request = parser(RegisterReferrerRequest)({
     action: {
       type: "registerReferrer",