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

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

@@ -43,7 +43,7 @@ export type PerpsAtOpenInterestCapResponse = v.InferOutput<typeof PerpsAtOpenInt
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode perpsAtOpenInterestCap} function. */
 export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtOpenInterestCapRequest>, "type">;
@@ -53,7 +53,7 @@ export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtO
  *
  * @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 perpetuals at open interest caps.
  *

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

@@ -30,7 +30,7 @@ export const PortfolioRequest = /* @__PURE__ */ (() => {
 export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
 
 /** Portfolio metrics snapshot. */
-const Portfolio = /* @__PURE__ */ (() => {
+const PortfolioSchema = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** History entries for account value as [timestamp, value]. */
@@ -52,7 +52,7 @@ const Portfolio = /* @__PURE__ */ (() => {
     v.description("Portfolio metrics snapshot."),
   );
 })();
-type Portfolio = v.InferOutput<typeof Portfolio>;
+type PortfolioSchema = v.InferOutput<typeof PortfolioSchema>;
 
 /**
  * Portfolio metrics grouped by time periods.
@@ -61,14 +61,14 @@ type Portfolio = v.InferOutput<typeof Portfolio>;
 export const PortfolioResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.tuple([
-      v.tuple([v.literal("day"), Portfolio]),
-      v.tuple([v.literal("week"), Portfolio]),
-      v.tuple([v.literal("month"), Portfolio]),
-      v.tuple([v.literal("allTime"), Portfolio]),
-      v.tuple([v.literal("perpDay"), Portfolio]),
-      v.tuple([v.literal("perpWeek"), Portfolio]),
-      v.tuple([v.literal("perpMonth"), Portfolio]),
-      v.tuple([v.literal("perpAllTime"), Portfolio]),
+      v.tuple([v.literal("day"), PortfolioSchema]),
+      v.tuple([v.literal("week"), PortfolioSchema]),
+      v.tuple([v.literal("month"), PortfolioSchema]),
+      v.tuple([v.literal("allTime"), PortfolioSchema]),
+      v.tuple([v.literal("perpDay"), PortfolioSchema]),
+      v.tuple([v.literal("perpWeek"), PortfolioSchema]),
+      v.tuple([v.literal("perpMonth"), PortfolioSchema]),
+      v.tuple([v.literal("perpAllTime"), PortfolioSchema]),
     ]),
     v.description("Portfolio metrics grouped by time periods."),
   );
@@ -79,7 +79,7 @@ export type PortfolioResponse = v.InferOutput<typeof PortfolioResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode portfolio} function. */
 export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "type">;
@@ -89,7 +89,7 @@ export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "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 Portfolio metrics grouped by time periods.
  *

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

@@ -69,7 +69,7 @@ export type PreTransferCheckResponse = v.InferOutput<typeof PreTransferCheckResp
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode preTransferCheck} function. */
 export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferCheckRequest>, "type">;
@@ -79,7 +79,7 @@ export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferChe
  *
  * @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 Pre-transfer user existence check result.
  *

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

@@ -25,65 +25,45 @@ export const PredictedFundingsRequest = /* @__PURE__ */ (() => {
 export type PredictedFundingsRequest = v.InferOutput<typeof PredictedFundingsRequest>;
 
 /**
- * Array of predicted funding rates.
+ * Array of tuples of asset symbols and their predicted funding data.
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-predicted-funding-rates-for-different-venues
  */
 export const PredictedFundingsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Tuple of asset symbol and its predicted funding data. */
-      v.pipe(
-        v.tuple([
-          /** Asset symbol. */
-          v.pipe(
+      v.tuple([
+        // Asset symbol
+        v.string(),
+        // Array of predicted funding data for each exchange
+        v.array(
+          v.tuple([
+            // Exchange symbol
             v.string(),
-            v.description("Asset symbol."),
-          ),
-          /** Array of predicted funding data for each exchange. */
-          v.pipe(
-            v.array(
-              /** Tuple of exchange symbol and predicted funding data. */
-              v.pipe(
-                v.tuple([
-                  /** Exchange symbol. */
-                  v.pipe(
-                    v.string(),
-                    v.description("Exchange symbol."),
-                  ),
-                  /** Predicted funding data. */
-                  v.pipe(
-                    v.nullable(
-                      v.object({
-                        /** Predicted funding rate. */
-                        fundingRate: v.pipe(
-                          Decimal,
-                          v.description("Predicted funding rate."),
-                        ),
-                        /** Next funding time (ms since epoch). */
-                        nextFundingTime: v.pipe(
-                          UnsignedInteger,
-                          v.description("Next funding time (ms since epoch)."),
-                        ),
-                        /** Funding interval in hours. */
-                        fundingIntervalHours: v.pipe(
-                          v.optional(UnsignedInteger),
-                          v.description("Funding interval in hours."),
-                        ),
-                      }),
-                    ),
-                    v.description("Predicted funding data."),
-                  ),
-                ]),
-                v.description("Tuple of exchange symbol and predicted funding data."),
-              ),
+            // Predicted funding data (if available)
+            v.nullable(
+              v.object({
+                /** Predicted funding rate. */
+                fundingRate: v.pipe(
+                  Decimal,
+                  v.description("Predicted funding rate."),
+                ),
+                /** Next funding time (ms since epoch). */
+                nextFundingTime: v.pipe(
+                  UnsignedInteger,
+                  v.description("Next funding time (ms since epoch)."),
+                ),
+                /** Funding interval in hours. */
+                fundingIntervalHours: v.pipe(
+                  v.optional(UnsignedInteger),
+                  v.description("Funding interval in hours."),
+                ),
+              }),
             ),
-            v.description("Array of predicted funding data for each exchange."),
-          ),
-        ]),
-        v.description("Tuple of asset symbol and its predicted funding data."),
-      ),
+          ]),
+        ),
+      ]),
     ),
-    v.description("Array of predicted funding rates."),
+    v.description("Array of tuples of asset symbols and their predicted funding data."),
   );
 })();
 export type PredictedFundingsResponse = v.InferOutput<typeof PredictedFundingsResponse>;
@@ -92,13 +72,13 @@ export type PredictedFundingsResponse = v.InferOutput<typeof PredictedFundingsRe
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request predicted funding rates.
  *
  * @param config - General configuration for Info API requests.
- * @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 predicted funding rates.
  *

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

@@ -34,52 +34,49 @@ export type RecentTradesRequest = v.InferOutput<typeof RecentTradesRequest>;
 export const RecentTradesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Trade for a specific asset. */
-      v.pipe(
-        v.object({
-          /** Asset symbol (e.g., BTC). */
-          coin: v.pipe(
-            v.string(),
-            v.description("Asset symbol (e.g., BTC)."),
-          ),
-          /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
-          side: v.pipe(
-            v.picklist(["B", "A"]),
-            v.description('Trade side ("B" = Bid/Buy, "A" = Ask/Sell).'),
-          ),
-          /** Trade price. */
-          px: v.pipe(
-            UnsignedDecimal,
-            v.description("Trade price."),
-          ),
-          /** Trade size. */
-          sz: v.pipe(
-            UnsignedDecimal,
-            v.description("Trade size."),
-          ),
-          /** Trade timestamp (in ms since epoch). */
-          time: v.pipe(
-            UnsignedInteger,
-            v.description("Trade timestamp (in ms since epoch)."),
-          ),
-          /** Transaction hash. */
-          hash: v.pipe(
-            v.pipe(Hex, v.length(66)),
-            v.description("Transaction hash."),
-          ),
-          /** Trade ID. */
-          tid: v.pipe(
-            UnsignedInteger,
-            v.description("Trade ID."),
-          ),
-          /** Addresses of users involved in the trade [Maker, Taker]. */
-          users: v.pipe(
-            v.tuple([Address, Address]),
-            v.description("Addresses of users involved in the trade [Maker, Taker]."),
-          ),
-        }),
-        v.description("Trade for a specific asset."),
-      ),
+      v.object({
+        /** Asset symbol (e.g., BTC). */
+        coin: v.pipe(
+          v.string(),
+          v.description("Asset symbol (e.g., BTC)."),
+        ),
+        /** Trade side ("B" = Bid/Buy, "A" = Ask/Sell). */
+        side: v.pipe(
+          v.picklist(["B", "A"]),
+          v.description('Trade side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+        ),
+        /** Trade price. */
+        px: v.pipe(
+          UnsignedDecimal,
+          v.description("Trade price."),
+        ),
+        /** Trade size. */
+        sz: v.pipe(
+          UnsignedDecimal,
+          v.description("Trade size."),
+        ),
+        /** Trade timestamp (in ms since epoch). */
+        time: v.pipe(
+          UnsignedInteger,
+          v.description("Trade timestamp (in ms since epoch)."),
+        ),
+        /** Transaction hash. */
+        hash: v.pipe(
+          Hex,
+          v.length(66),
+          v.description("Transaction hash."),
+        ),
+        /** Trade ID. */
+        tid: v.pipe(
+          UnsignedInteger,
+          v.description("Trade ID."),
+        ),
+        /** Addresses of users involved in the trade [Maker, Taker]. */
+        users: v.pipe(
+          v.tuple([Address, Address]),
+          v.description("Addresses of users involved in the trade [Maker, Taker]."),
+        ),
+      }),
     ),
     v.description("Array of recent trades."),
   );
@@ -90,7 +87,7 @@ export type RecentTradesResponse = v.InferOutput<typeof RecentTradesResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode recentTrades} function. */
 export type RecentTradesParameters = Omit<v.InferInput<typeof RecentTradesRequest>, "type">;
@@ -100,7 +97,7 @@ export type RecentTradesParameters = Omit<v.InferInput<typeof RecentTradesReques
  *
  * @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 recent trades.
  *

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

@@ -48,7 +48,7 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
             /** Referral code used. */
             code: v.pipe(
               v.string(),
-              v.minLength(1),
+              v.nonEmpty(),
               v.description("Referral code used."),
             ),
           }),
@@ -90,7 +90,7 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
                 /** Assigned referral code. */
                 code: v.pipe(
                   v.string(),
-                  v.minLength(1),
+                  v.nonEmpty(),
                   v.description("Assigned referral code."),
                 ),
                 /** Total number of referrals. */
@@ -101,73 +101,65 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
                 /** Summary of each referral state. */
                 referralStates: v.pipe(
                   v.array(
-                    /** Referral state for a referred user. */
-                    v.pipe(
-                      v.object({
-                        /** Cumulative traded volume. */
-                        cumVlm: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Cumulative traded volume."),
+                    v.object({
+                      /** Cumulative traded volume. */
+                      cumVlm: v.pipe(
+                        UnsignedDecimal,
+                        v.description("Cumulative traded volume."),
+                      ),
+                      /** Total fees rewarded to the referred user since referral. */
+                      cumRewardedFeesSinceReferred: v.pipe(
+                        UnsignedDecimal,
+                        v.description("Total fees rewarded to the referred user since referral."),
+                      ),
+                      /** Total fees rewarded to the referrer from referred trades. */
+                      cumFeesRewardedToReferrer: v.pipe(
+                        UnsignedDecimal,
+                        v.description("Total fees rewarded to the referrer from referred trades."),
+                      ),
+                      /** Timestamp when the referred user joined (in ms since epoch). */
+                      timeJoined: v.pipe(
+                        UnsignedInteger,
+                        v.description(
+                          "Timestamp when the referred user joined (in ms since epoch).",
                         ),
-                        /** Total fees rewarded to the referred user since referral. */
-                        cumRewardedFeesSinceReferred: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Total fees rewarded to the referred user since referral."),
+                      ),
+                      /** Address of the referred user. */
+                      user: v.pipe(
+                        Address,
+                        v.description("Address of the referred user."),
+                      ),
+                      /** Mapping of token IDs to referral reward states. */
+                      tokenToState: v.pipe(
+                        v.array(
+                          v.tuple([
+                            UnsignedInteger,
+                            v.object({
+                              /** Cumulative traded volume. */
+                              cumVlm: v.pipe(
+                                UnsignedDecimal,
+                                v.description("Cumulative traded volume."),
+                              ),
+                              /** Total fees rewarded to the referred user since referral. */
+                              cumRewardedFeesSinceReferred: v.pipe(
+                                UnsignedDecimal,
+                                v.description(
+                                  "Total fees rewarded to the referred user since referral.",
+                                ),
+                              ),
+                              /** Total fees rewarded to the referrer from referred trades. */
+                              cumFeesRewardedToReferrer: v.pipe(
+                                UnsignedDecimal,
+                                v.description(
+                                  "Total fees rewarded to the referrer from referred trades.",
+                                ),
+                              ),
+                            }),
+                          ]),
                         ),
-                        /** Total fees rewarded to the referrer from referred trades. */
-                        cumFeesRewardedToReferrer: v.pipe(
-                          UnsignedDecimal,
-                          v.description("Total fees rewarded to the referrer from referred trades."),
-                        ),
-                        /** Timestamp when the referred user joined (in ms since epoch). */
-                        timeJoined: v.pipe(
-                          UnsignedInteger,
-                          v.description(
-                            "Timestamp when the referred user joined (in ms since epoch).",
-                          ),
-                        ),
-                        /** Address of the referred user. */
-                        user: v.pipe(
-                          Address,
-                          v.description("Address of the referred user."),
-                        ),
-                        /** Mapping of token IDs to referral reward states. */
-                        tokenToState: v.pipe(
-                          v.array(
-                            /** Tuple of token ID and its referral reward state. */
-                            v.pipe(
-                              v.tuple([
-                                UnsignedInteger,
-                                v.object({
-                                  /** Cumulative traded volume. */
-                                  cumVlm: v.pipe(
-                                    UnsignedDecimal,
-                                    v.description("Cumulative traded volume."),
-                                  ),
-                                  /** Total fees rewarded to the referred user since referral. */
-                                  cumRewardedFeesSinceReferred: v.pipe(
-                                    UnsignedDecimal,
-                                    v.description(
-                                      "Total fees rewarded to the referred user since referral.",
-                                    ),
-                                  ),
-                                  /** Total fees rewarded to the referrer from referred trades. */
-                                  cumFeesRewardedToReferrer: v.pipe(
-                                    UnsignedDecimal,
-                                    v.description(
-                                      "Total fees rewarded to the referrer from referred trades.",
-                                    ),
-                                  ),
-                                }),
-                              ]),
-                              v.description("Tuple of token ID and its referral reward state."),
-                            ),
-                          ),
-                          v.description("Mapping of token IDs to referral reward states."),
-                        ),
-                      }),
-                      v.description("Referral state for a referred user."),
-                    ),
+                        v.description("Mapping of token IDs to referral reward states."),
+                      ),
+                    }),
                   ),
                   v.description("Summary of each referral state."),
                 ),
@@ -206,67 +198,59 @@ export const ReferralResponse = /* @__PURE__ */ (() => {
       /** History of referral rewards. */
       rewardHistory: v.pipe(
         v.array(
-          /** Referral reward entry. */
-          v.pipe(
+          v.object({
+            /** Amount of earned rewards. */
+            earned: v.pipe(
+              UnsignedDecimal,
+              v.description("Amount of earned rewards."),
+            ),
+            /** Traded volume at the time of reward. */
+            vlm: v.pipe(
+              UnsignedDecimal,
+              v.description("Traded volume at the time of reward."),
+            ),
+            /** Traded volume via referrals. */
+            referralVlm: v.pipe(
+              UnsignedDecimal,
+              v.description("Traded volume via referrals."),
+            ),
+            /** Timestamp when the reward was earned (in ms since epoch). */
+            time: v.pipe(
+              UnsignedInteger,
+              v.description("Timestamp when the reward was earned (in ms since epoch)."),
+            ),
+          }),
+        ),
+        v.description("History of referral rewards."),
+      ),
+      /** Mapping of token IDs to referral reward states. */
+      tokenToState: v.pipe(
+        v.array(
+          v.tuple([
+            UnsignedInteger,
             v.object({
-              /** Amount of earned rewards. */
-              earned: v.pipe(
+              /** Cumulative traded volume. */
+              cumVlm: v.pipe(
                 UnsignedDecimal,
-                v.description("Amount of earned rewards."),
+                v.description("Cumulative traded volume."),
               ),
-              /** Traded volume at the time of reward. */
-              vlm: v.pipe(
+              /** Rewards earned but not yet claimed. */
+              unclaimedRewards: v.pipe(
                 UnsignedDecimal,
-                v.description("Traded volume at the time of reward."),
+                v.description("Rewards earned but not yet claimed."),
               ),
-              /** Traded volume via referrals. */
-              referralVlm: v.pipe(
+              /** Rewards that have been claimed. */
+              claimedRewards: v.pipe(
                 UnsignedDecimal,
-                v.description("Traded volume via referrals."),
+                v.description("Rewards that have been claimed."),
               ),
-              /** Timestamp when the reward was earned (in ms since epoch). */
-              time: v.pipe(
-                UnsignedInteger,
-                v.description("Timestamp when the reward was earned (in ms since epoch)."),
+              /** Builder reward amount. */
+              builderRewards: v.pipe(
+                UnsignedDecimal,
+                v.description("Builder reward amount."),
               ),
             }),
-            v.description("Referral reward entry."),
-          ),
-        ),
-        v.description("History of referral rewards."),
-      ),
-      /** Mapping of token IDs to referral reward states. */
-      tokenToState: v.pipe(
-        v.array(
-          /** Tuple of token ID and its referral reward state. */
-          v.pipe(
-            v.tuple([
-              UnsignedInteger,
-              v.object({
-                /** Cumulative traded volume. */
-                cumVlm: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Cumulative traded volume."),
-                ),
-                /** Rewards earned but not yet claimed. */
-                unclaimedRewards: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Rewards earned but not yet claimed."),
-                ),
-                /** Rewards that have been claimed. */
-                claimedRewards: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Rewards that have been claimed."),
-                ),
-                /** Builder reward amount. */
-                builderRewards: v.pipe(
-                  UnsignedDecimal,
-                  v.description("Builder reward amount."),
-                ),
-              }),
-            ]),
-            v.description("Tuple of token ID and its referral reward state."),
-          ),
+          ]),
         ),
         v.description("Mapping of token IDs to referral reward states."),
       ),
@@ -280,7 +264,7 @@ export type ReferralResponse = v.InferOutput<typeof ReferralResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode referral} function. */
 export type ReferralParameters = Omit<v.InferInput<typeof ReferralRequest>, "type">;
@@ -290,7 +274,7 @@ export type ReferralParameters = Omit<v.InferInput<typeof ReferralRequest>, "typ
  *
  * @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 Referral details for a user.
  *