@nktkas/hyperliquid 0.26.0 → 0.27.0

package/src/api/exchange/validatorL1Stream.ts

@@ -0,0 +1,136 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/**
+ * Validator vote on risk-free rate for aligned quote asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#validator-vote-on-risk-free-rate-for-aligned-quote-asset
+ */
+export const ValidatorL1StreamRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Action to perform. */
+      action: v.pipe(
+        v.object({
+          /** Type of action. */
+          type: v.pipe(
+            v.literal("validatorL1Stream"),
+            v.description("Type of action."),
+          ),
+          /** Risk-free rate as a decimal string (e.g., "0.05" for 5%). */
+          riskFreeRate: v.pipe(
+            UnsignedDecimal,
+            v.description('Risk-free rate as a decimal string (e.g., "0.05" for 5%).'),
+          ),
+        }),
+        v.description("Action to perform."),
+      ),
+      /** Unique request identifier (current timestamp in ms). */
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Unique request identifier (current timestamp in ms)."),
+      ),
+      /** Cryptographic signature. */
+      signature: v.pipe(
+        Signature,
+        v.description("Cryptographic signature."),
+      ),
+      /** Expiration time of the action. */
+      expiresAfter: v.pipe(
+        v.optional(UnsignedInteger),
+        v.description("Expiration time of the action."),
+      ),
+    }),
+    v.description("Validator vote on risk-free rate for aligned quote asset."),
+  );
+})();
+export type ValidatorL1StreamRequest = v.InferOutput<typeof ValidatorL1StreamRequest>;
+
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#validator-vote-on-risk-free-rate-for-aligned-quote-asset
+ */
+export const ValidatorL1StreamResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type ValidatorL1StreamResponse = v.InferOutput<typeof ValidatorL1StreamResponse>;
+
+// ============================================================
+// 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 validatorL1Stream} function. */
+export type ValidatorL1StreamParameters = ExtractRequestAction<v.InferInput<typeof ValidatorL1StreamRequest>>;
+
+/** Request options for the {@linkcode validatorL1Stream} function. */
+export type ValidatorL1StreamOptions = ExtractRequestOptions<v.InferInput<typeof ValidatorL1StreamRequest>>;
+
+/** Successful variant of {@linkcode ValidatorL1StreamResponse} without errors. */
+export type ValidatorL1StreamSuccessResponse = ExcludeErrorResponse<ValidatorL1StreamResponse>;
+
+/**
+ * Validator vote on risk-free rate for aligned quote asset.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#validator-vote-on-risk-free-rate-for-aligned-quote-asset
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { validatorL1Stream } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await validatorL1Stream(
+ *   { transport, wallet },
+ *   { riskFreeRate: "0.05" },
+ * );
+ * ```
+ */
+export async function validatorL1Stream(
+  config: ExchangeRequestConfig | MultiSignRequestConfig,
+  params: DeepImmutable<ValidatorL1StreamParameters>,
+  opts?: ValidatorL1StreamOptions,
+): Promise<ValidatorL1StreamSuccessResponse> {
+  const request = parser(ValidatorL1StreamRequest)({
+    action: {
+      type: "validatorL1Stream",
+      ...params,
+    },
+    nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
+    signature: { // Placeholder; actual signature generated in `executeL1Action`
+      r: "0x0000000000000000000000000000000000000000000000000000000000000000",
+      s: "0x0000000000000000000000000000000000000000000000000000000000000000",
+      v: 27,
+    },
+    expiresAfter: typeof config.defaultExpiresAfter === "number"
+      ? config.defaultExpiresAfter
+      : await config.defaultExpiresAfter?.(),
+  });
+  return await executeL1Action(config, request, opts?.signal);
+}

package/src/api/exchange/vaultDistribute.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
+// ============================================================
 
-/**
- * Distribute funds from a vault between followers.
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Distribute funds from a vault between followers. */
 export const VaultDistributeRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -67,16 +60,38 @@ export const VaultDistributeRequest = /* @__PURE__ */ (() => {
 })();
 export type VaultDistributeRequest = v.InferOutput<typeof VaultDistributeRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const VaultDistributeResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type VaultDistributeResponse = v.InferOutput<typeof VaultDistributeResponse>;
+
+// ============================================================
+// 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 vaultDistribute} function. */
 export type VaultDistributeParameters = ExtractRequestAction<v.InferInput<typeof VaultDistributeRequest>>;
+
 /** Request options for the {@linkcode vaultDistribute} function. */
 export type VaultDistributeOptions = ExtractRequestOptions<v.InferInput<typeof VaultDistributeRequest>>;
 
+/** Successful variant of {@linkcode VaultDistributeResponse} without errors. */
+export type VaultDistributeSuccessResponse = ExcludeErrorResponse<VaultDistributeResponse>;
+
 /**
  * Distribute funds from a vault between followers.
  * @param config - General configuration for Exchange API requests.
@@ -87,12 +102,11 @@ export type VaultDistributeOptions = ExtractRequestOptions<v.InferInput<typeof V
  * @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 { vaultDistribute } 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`
@@ -107,7 +121,7 @@ export async function vaultDistribute(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<VaultDistributeParameters>,
   opts?: VaultDistributeOptions,
-): Promise<SuccessResponse> {
+): Promise<VaultDistributeSuccessResponse> {
   const request = parser(VaultDistributeRequest)({
     action: {
       type: "vaultDistribute",

package/src/api/exchange/vaultModify.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 vault's configuration.
- * @see null
- */
+import { Address, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
+
+/** Modify a vault's configuration. */
 export const VaultModifyRequest = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
@@ -65,16 +58,38 @@ export const VaultModifyRequest = /* @__PURE__ */ (() => {
 })();
 export type VaultModifyRequest = v.InferOutput<typeof VaultModifyRequest>;
 
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
+/** Successful response without specific data or error response. */
+export const VaultModifyResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type VaultModifyResponse = v.InferOutput<typeof VaultModifyResponse>;
+
+// ============================================================
+// 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 vaultModify} function. */
 export type VaultModifyParameters = ExtractRequestAction<v.InferInput<typeof VaultModifyRequest>>;
+
 /** Request options for the {@linkcode vaultModify} function. */
 export type VaultModifyOptions = ExtractRequestOptions<v.InferInput<typeof VaultModifyRequest>>;
 
+/** Successful variant of {@linkcode VaultModifyResponse} without errors. */
+export type VaultModifySuccessResponse = ExcludeErrorResponse<VaultModifyResponse>;
+
 /**
  * Modify a vault's configuration.
  * @param config - General configuration for Exchange API requests.
@@ -85,12 +100,11 @@ export type VaultModifyOptions = ExtractRequestOptions<v.InferInput<typeof Vault
  * @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 { vaultModify } 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`
@@ -109,7 +123,7 @@ export async function vaultModify(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<VaultModifyParameters>,
   opts?: VaultModifyOptions,
-): Promise<SuccessResponse> {
+): Promise<VaultModifySuccessResponse> {
   const request = parser(VaultModifyRequest)({
     action: {
       type: "vaultModify",

package/src/api/exchange/vaultTransfer.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 { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Deposit or withdraw from a vault.
@@ -65,16 +61,41 @@ export const VaultTransferRequest = /* @__PURE__ */ (() => {
 })();
 export type VaultTransferRequest = v.InferOutput<typeof VaultTransferRequest>;
 
-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-or-withdraw-from-a-vault
+ */
+export const VaultTransferResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type VaultTransferResponse = v.InferOutput<typeof VaultTransferResponse>;
+
+// ============================================================
+// 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 vaultTransfer} function. */
 export type VaultTransferParameters = ExtractRequestAction<v.InferInput<typeof VaultTransferRequest>>;
+
 /** Request options for the {@linkcode vaultTransfer} function. */
 export type VaultTransferOptions = ExtractRequestOptions<v.InferInput<typeof VaultTransferRequest>>;
 
+/** Successful variant of {@linkcode VaultTransferResponse} without errors. */
+export type VaultTransferSuccessResponse = ExcludeErrorResponse<VaultTransferResponse>;
+
 /**
  * Deposit or withdraw from a vault.
  * @param config - General configuration for Exchange API requests.
@@ -90,7 +111,7 @@ export type VaultTransferOptions = ExtractRequestOptions<v.InferInput<typeof Vau
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { vaultTransfer } 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 +126,7 @@ export async function vaultTransfer(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<VaultTransferParameters>,
   opts?: VaultTransferOptions,
-): Promise<SuccessResponse> {
+): Promise<VaultTransferSuccessResponse> {
   const request = parser(VaultTransferRequest)({
     action: {
       type: "vaultTransfer",

package/src/api/exchange/withdraw3.ts

@@ -1,16 +1,11 @@
 import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, 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, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.ts";
 
 /**
  * Initiate a withdrawal request.
@@ -71,16 +66,42 @@ export const Withdraw3Request = /* @__PURE__ */ (() => {
 })();
 export type Withdraw3Request = v.InferOutput<typeof Withdraw3Request>;
 
-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#initiate-a-withdrawal-request
+ */
+export const Withdraw3Response = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.union([SuccessResponse, ErrorResponse]),
+    v.description("Successful response without specific data or error response."),
+  );
+})();
+export type Withdraw3Response = v.InferOutput<typeof Withdraw3Response>;
+
+// ============================================================
+// 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 withdraw3} function. */
 export type Withdraw3Parameters = ExtractRequestAction<v.InferInput<typeof Withdraw3Request>>;
+
 /** Request options for the {@linkcode withdraw3} function. */
 export type Withdraw3Options = ExtractRequestOptions<v.InferInput<typeof Withdraw3Request>>;
 
+/** Successful variant of {@linkcode Withdraw3Response} without errors. */
+export type Withdraw3SuccessResponse = ExcludeErrorResponse<Withdraw3Response>;
+
 /** EIP-712 types for the {@linkcode withdraw3} function. */
 export const Withdraw3Types = {
   "HyperliquidTransaction:Withdraw": [
@@ -106,7 +127,7 @@ export const Withdraw3Types = {
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
  * import { withdraw3 } 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 withdraw3(
   config: ExchangeRequestConfig | MultiSignRequestConfig,
   params: DeepImmutable<Withdraw3Parameters>,
   opts?: Withdraw3Options,
-): Promise<SuccessResponse> {
+): Promise<Withdraw3SuccessResponse> {
   const request = parser(Withdraw3Request)({
     action: {
       type: "withdraw3",