@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.0-hfunlabs.1

package/src/src/api/info/_methods/subAccounts.ts

@@ -39,32 +39,34 @@ export const SubAccountsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.nullable(
       v.array(
-        /** Sub-account details for a user. */
-        v.pipe(
-          v.object({
-            /** Sub-account name. */
-            name: v.pipe(
-              v.string(),
-              v.minLength(1),
-              v.description("Sub-account name."),
-            ),
-            /** Sub-account address. */
-            subAccountUser: v.pipe(
-              Address,
-              v.description("Sub-account address."),
-            ),
-            /** Master account address. */
-            master: v.pipe(
-              Address,
-              v.description("Master account address."),
-            ),
-            /** Perpetual trading clearinghouse state summary. */
-            clearinghouseState: ClearinghouseStateResponse,
-            /** Spot tokens clearinghouse state. */
-            spotState: SpotClearinghouseStateResponse,
-          }),
-          v.description("Sub-account details for a user."),
-        ),
+        v.object({
+          /** Sub-account name. */
+          name: v.pipe(
+            v.string(),
+            v.nonEmpty(),
+            v.description("Sub-account name."),
+          ),
+          /** Sub-account address. */
+          subAccountUser: v.pipe(
+            Address,
+            v.description("Sub-account address."),
+          ),
+          /** Master account address. */
+          master: v.pipe(
+            Address,
+            v.description("Master account address."),
+          ),
+          /** Perpetual trading clearinghouse state summary. */
+          clearinghouseState: v.pipe(
+            ClearinghouseStateResponse,
+            v.description("Perpetual trading clearinghouse state summary."),
+          ),
+          /** Spot tokens clearinghouse state. */
+          spotState: v.pipe(
+            SpotClearinghouseStateResponse,
+            v.description("Spot tokens clearinghouse state."),
+          ),
+        }),
       ),
     ),
     v.description("Array of user sub-account or null if the user does not have any sub-accounts."),
@@ -76,7 +78,7 @@ export type SubAccountsResponse = v.InferOutput<typeof SubAccountsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode subAccounts} function. */
 export type SubAccountsParameters = Omit<v.InferInput<typeof SubAccountsRequest>, "type">;
@@ -86,7 +88,7 @@ export type SubAccountsParameters = Omit<v.InferInput<typeof SubAccountsRequest>
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user sub-account or null if the user does not have any sub-accounts.
  *

package/src/src/api/info/_methods/subAccounts2.ts

@@ -9,7 +9,7 @@ import { ClearinghouseStateResponse } from "./clearinghouseState.js";
 import { SpotClearinghouseStateResponse } from "./spotClearinghouseState.js";
 
 /**
- * Request user sub-accounts V2.
+ * Request user sub-accounts (V2).
  */
 export const SubAccounts2Request = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -25,7 +25,7 @@ export const SubAccounts2Request = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
     }),
-    v.description("Request user sub-accounts."),
+    v.description("Request user sub-accounts (V2)."),
   );
 })();
 export type SubAccounts2Request = v.InferOutput<typeof SubAccounts2Request>;
@@ -37,41 +37,35 @@ export const SubAccounts2Response = /* @__PURE__ */ (() => {
   return v.pipe(
     v.nullable(
       v.array(
-        /** Sub-account details for a user. */
-        v.pipe(
-          v.object({
-            /** Sub-account name. */
-            name: v.pipe(
-              v.string(),
-              v.minLength(1),
-              v.description("Sub-account name."),
-            ),
-            /** Sub-account address. */
-            subAccountUser: v.pipe(
-              Address,
-              v.description("Sub-account address."),
-            ),
-            /** Master account address. */
-            master: v.pipe(
-              Address,
-              v.description("Master account address."),
-            ),
-            /** DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name). */
-            dexToClearinghouseState: v.pipe(
-              v.array(
-                v.tuple([
-                  v.string(),
-                  ClearinghouseStateResponse,
-                ]),
-              ),
-              v.minLength(1),
-              v.description("DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name)."),
-            ),
-            /** Spot tokens clearinghouse state. */
-            spotState: SpotClearinghouseStateResponse,
-          }),
-          v.description("Sub-account details for a user."),
-        ),
+        v.object({
+          /** Sub-account name. */
+          name: v.pipe(
+            v.string(),
+            v.nonEmpty(),
+            v.description("Sub-account name."),
+          ),
+          /** Sub-account address. */
+          subAccountUser: v.pipe(
+            Address,
+            v.description("Sub-account address."),
+          ),
+          /** Master account address. */
+          master: v.pipe(
+            Address,
+            v.description("Master account address."),
+          ),
+          /** DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name). */
+          dexToClearinghouseState: v.pipe(
+            v.array(v.tuple([v.string(), ClearinghouseStateResponse])),
+            v.nonEmpty(),
+            v.description("DEX to clearinghouse state mapping. Always includes the main DEX (empty dex name)."),
+          ),
+          /** Spot tokens clearinghouse state. */
+          spotState: v.pipe(
+            SpotClearinghouseStateResponse,
+            v.description("Spot tokens clearinghouse state."),
+          ),
+        }),
       ),
     ),
     v.description("Array of user sub-account or null if the user does not have any sub-accounts."),
@@ -83,7 +77,7 @@ export type SubAccounts2Response = v.InferOutput<typeof SubAccounts2Response>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode subAccounts2} function. */
 export type SubAccounts2Parameters = Omit<v.InferInput<typeof SubAccounts2Response>, "type">;
@@ -93,7 +87,7 @@ export type SubAccounts2Parameters = Omit<v.InferInput<typeof SubAccounts2Respon
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user sub-account or null if the user does not have any sub-accounts.
  *

package/src/src/api/info/_methods/tokenDetails.ts

@@ -20,7 +20,8 @@ export const TokenDetailsRequest = /* @__PURE__ */ (() => {
       ),
       /** Token ID. */
       tokenId: v.pipe(
-        v.pipe(Hex, v.length(34)),
+        Hex,
+        v.length(34),
         v.description("Token ID."),
       ),
     }),
@@ -144,7 +145,7 @@ export type TokenDetailsResponse = v.InferOutput<typeof TokenDetailsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode tokenDetails} function. */
 export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsRequest>, "type">;
@@ -154,7 +155,7 @@ export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsReques
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Details of a token.
  *

package/src/src/api/info/_methods/twapHistory.ts

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { Address, UnsignedInteger } from "../../_schemas.js";
+import { TwapStateSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request twap history of a user.
@@ -34,115 +35,60 @@ export type TwapHistoryRequest = v.InferOutput<typeof TwapHistoryRequest>;
 export const TwapHistoryResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** TWAP history record. */
-      v.pipe(
-        v.object({
-          /** Creation time of the history record (in seconds since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Creation time of the history record (in seconds since epoch)."),
-          ),
-          /** State of the TWAP order. */
-          state: v.pipe(
+      v.object({
+        /** Creation time of the history record (in seconds since epoch). */
+        time: v.pipe(
+          UnsignedInteger,
+          v.description("Creation time of the history record (in seconds since epoch)."),
+        ),
+        /** State of the TWAP order. */
+        state: v.pipe(
+          TwapStateSchema,
+          v.description("State of the TWAP order."),
+        ),
+        /**
+         * Current status of the TWAP order.
+         * - `"finished"`: Fully executed.
+         * - `"activated"`: Active and executing.
+         * - `"terminated"`: Terminated.
+         * - `"error"`: An error occurred.
+         */
+        status: v.pipe(
+          v.variant("status", [
             v.object({
-              /** Asset symbol. */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol."),
-              ),
-              /** Executed notional value. */
-              executedNtl: v.pipe(
-                UnsignedDecimal,
-                v.description("Executed notional value."),
-              ),
-              /** Executed size. */
-              executedSz: v.pipe(
-                UnsignedDecimal,
-                v.description("Executed size."),
-              ),
-              /** Duration in minutes. */
-              minutes: v.pipe(
-                UnsignedInteger,
-                v.description("Duration in minutes."),
-              ),
-              /** Indicates if the TWAP randomizes execution. */
-              randomize: v.pipe(
-                v.boolean(),
-                v.description("Indicates if the TWAP randomizes execution."),
-              ),
-              /** Indicates if the order is reduce-only. */
-              reduceOnly: v.pipe(
-                v.boolean(),
-                v.description("Indicates if the order is reduce-only."),
-              ),
-              /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
-              side: v.pipe(
-                v.picklist(["B", "A"]),
-                v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+              /** Status of the TWAP order. */
+              status: v.pipe(
+                v.picklist(["finished", "activated", "terminated"]),
+                v.description("Status of the TWAP order."),
               ),
-              /** Order size. */
-              sz: v.pipe(
-                UnsignedDecimal,
-                v.description("Order size."),
-              ),
-              /** Start time of the TWAP order (in ms since epoch). */
-              timestamp: v.pipe(
-                UnsignedInteger,
-                v.description("Start time of the TWAP order (in ms since epoch)."),
+            }),
+            v.object({
+              /** Status of the TWAP order. */
+              status: v.pipe(
+                v.literal("error"),
+                v.description("Status of the TWAP order."),
               ),
-              /** User address. */
-              user: v.pipe(
-                Address,
-                v.description("User address."),
+              /** Error message. */
+              description: v.pipe(
+                v.string(),
+                v.description("Error message."),
               ),
             }),
-            v.description("State of the TWAP order."),
+          ]),
+          v.description(
+            "Current status of the TWAP order." +
+              '\n- `"finished"`: Fully executed.' +
+              '\n- `"activated"`: Active and executing.' +
+              '\n- `"terminated"`: Terminated.' +
+              '\n- `"error"`: An error occurred.',
           ),
-          /**
-           * Current status of the TWAP order.
-           * - `"finished"`: Fully executed.
-           * - `"activated"`: Active and executing.
-           * - `"terminated"`: Terminated.
-           * - `"error"`: An error occurred.
-           */
-          status: v.pipe(
-            v.variant("status", [
-              v.object({
-                /** Status of the TWAP order. */
-                status: v.pipe(
-                  v.picklist(["finished", "activated", "terminated"]),
-                  v.description("Status of the TWAP order."),
-                ),
-              }),
-              v.object({
-                /** Status of the TWAP order. */
-                status: v.pipe(
-                  v.literal("error"),
-                  v.description("Status of the TWAP order."),
-                ),
-                /** Error message. */
-                description: v.pipe(
-                  v.string(),
-                  v.description("Error message."),
-                ),
-              }),
-            ]),
-            v.description(
-              "Current status of the TWAP order." +
-                '\n- `"finished"`: Fully executed.' +
-                '\n- `"activated"`: Active and executing.' +
-                '\n- `"terminated"`: Terminated.' +
-                '\n- `"error"`: An error occurred.',
-            ),
-          ),
-          /** ID of the TWAP. */
-          twapId: v.pipe(
-            v.optional(UnsignedInteger),
-            v.description("ID of the TWAP."),
-          ),
-        }),
-        v.description("TWAP history record."),
-      ),
+        ),
+        /** ID of the TWAP. */
+        twapId: v.pipe(
+          v.optional(UnsignedInteger),
+          v.description("ID of the TWAP."),
+        ),
+      }),
     ),
     v.description("Array of user's TWAP history."),
   );
@@ -153,7 +99,7 @@ export type TwapHistoryResponse = v.InferOutput<typeof TwapHistoryResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode twapHistory} function. */
 export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>, "type">;
@@ -163,7 +109,7 @@ export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user's TWAP history.
  *

package/src/src/api/info/_methods/txDetails.ts

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
+import { Hex } from "../../_schemas.js";
+import { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request transaction details by transaction hash.
@@ -19,7 +20,8 @@ export const TxDetailsRequest = /* @__PURE__ */ (() => {
       ),
       /** Transaction hash. */
       hash: v.pipe(
-        v.pipe(Hex, v.length(66)),
+        Hex,
+        v.length(66),
         v.description("Transaction hash."),
       ),
     }),
@@ -41,44 +43,7 @@ export const TxDetailsResponse = /* @__PURE__ */ (() => {
       ),
       /** Transaction details. */
       tx: v.pipe(
-        v.object({
-          /** Action performed in transaction. */
-          action: v.pipe(
-            v.looseObject({
-              /** Action type. */
-              type: v.pipe(
-                v.string(),
-                v.description("Action type."),
-              ),
-            }),
-            v.description("Action performed in transaction."),
-          ),
-          /** Block number where transaction was included. */
-          block: v.pipe(
-            UnsignedInteger,
-            v.description("Block number where transaction was included."),
-          ),
-          /** Error message if transaction failed. */
-          error: v.pipe(
-            v.nullable(v.string()),
-            v.description("Error message if transaction failed."),
-          ),
-          /** Transaction hash. */
-          hash: v.pipe(
-            v.pipe(Hex, v.length(66)),
-            v.description("Transaction hash."),
-          ),
-          /** Transaction creation timestamp. */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Transaction creation timestamp."),
-          ),
-          /** Creator's address. */
-          user: v.pipe(
-            Address,
-            v.description("Creator's address."),
-          ),
-        }),
+        ExplorerTransactionSchema,
         v.description("Transaction details."),
       ),
     }),
@@ -91,8 +56,7 @@ export type TxDetailsResponse = v.InferOutput<typeof TxDetailsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
-import type { HttpTransport } from "../../../transport/http/mod.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode txDetails} function. */
 export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "type">;
@@ -102,7 +66,7 @@ export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "t
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Transaction details.
  *
@@ -122,7 +86,7 @@ export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "t
  * ```
  */
 export function txDetails(
-  config: InfoConfig<HttpTransport>,
+  config: InfoConfig,
   params: TxDetailsParameters,
   signal?: AbortSignal,
 ): Promise<TxDetailsResponse> {

package/src/src/api/info/_methods/userDetails.ts

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
+import { Address } from "../../_schemas.js";
+import { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request array of user transaction details.
@@ -41,49 +42,7 @@ export const UserDetailsResponse = /* @__PURE__ */ (() => {
       ),
       /** Array of user transaction details. */
       txs: v.pipe(
-        v.array(
-          v.pipe(
-            v.object({
-              /** Action performed in transaction. */
-              action: v.pipe(
-                v.looseObject({
-                  /** Action type. */
-                  type: v.pipe(
-                    v.string(),
-                    v.description("Action type."),
-                  ),
-                }),
-                v.description("Action performed in transaction."),
-              ),
-              /** Block number where transaction was included. */
-              block: v.pipe(
-                UnsignedInteger,
-                v.description("Block number where transaction was included."),
-              ),
-              /** Error message if transaction failed. */
-              error: v.pipe(
-                v.nullable(v.string()),
-                v.description("Error message if transaction failed."),
-              ),
-              /** Transaction hash. */
-              hash: v.pipe(
-                v.pipe(Hex, v.length(66)),
-                v.description("Transaction hash."),
-              ),
-              /** Transaction creation timestamp. */
-              time: v.pipe(
-                UnsignedInteger,
-                v.description("Transaction creation timestamp."),
-              ),
-              /** Creator's address. */
-              user: v.pipe(
-                Address,
-                v.description("Creator's address."),
-              ),
-            }),
-            v.description("Transaction details."),
-          ),
-        ),
+        v.array(ExplorerTransactionSchema),
         v.description("Array of user transaction details."),
       ),
     }),
@@ -96,8 +55,7 @@ export type UserDetailsResponse = v.InferOutput<typeof UserDetailsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
-import type { HttpTransport } from "../../../transport/http/mod.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userDetails} function. */
 export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>, "type">;
@@ -107,7 +65,7 @@ export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns Array of user transaction details.
  *
@@ -127,7 +85,7 @@ export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>
  * ```
  */
 export function userDetails(
-  config: InfoConfig<HttpTransport>,
+  config: InfoConfig,
   params: UserDetailsParameters,
   signal?: AbortSignal,
 ): Promise<UserDetailsResponse> {

package/src/src/api/info/_methods/userDexAbstraction.ts

@@ -24,7 +24,7 @@ export const UserDexAbstractionRequest = /* @__PURE__ */ (() => {
         v.description("User address."),
       ),
     }),
-    v.description("Request user referral."),
+    v.description("Request user HIP-3 DEX abstraction state."),
   );
 })();
 export type UserDexAbstractionRequest = v.InferOutput<typeof UserDexAbstractionRequest>;
@@ -45,7 +45,7 @@ export type UserDexAbstractionResponse = v.InferOutput<typeof UserDexAbstraction
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userDexAbstraction} function. */
 export type UserDexAbstractionParameters = Omit<v.InferInput<typeof UserDexAbstractionRequest>, "type">;
@@ -55,7 +55,7 @@ export type UserDexAbstractionParameters = Omit<v.InferInput<typeof UserDexAbstr
  *
  * @param config - General configuration for Info API requests.
  * @param params - Parameters specific to the API request.
- * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
  *
  * @returns User HIP-3 DEX abstraction state.
  *