@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.2-hfunlabs.2

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

@@ -52,21 +52,10 @@ export const AlignedQuoteTokenInfoResponse = /* @__PURE__ */ (() => {
       /** Daily amount owed as an array of [date, amount] tuples. */
       dailyAmountOwed: v.pipe(
         v.array(
-          v.pipe(
-            v.tuple([
-              /** Date in YYYY-MM-DD format. */
-              v.pipe(
-                v.string(),
-                v.description("Date in YYYY-MM-DD format."),
-              ),
-              /** Amount owed. */
-              v.pipe(
-                UnsignedDecimal,
-                v.description("Amount owed."),
-              ),
-            ]),
-            v.description("[date, amount] tuple."),
-          ),
+          v.tuple([
+            v.pipe(v.string(), v.isoDate()),
+            UnsignedDecimal,
+          ]),
         ),
         v.description("Daily amount owed as an array of [date, amount] tuples."),
       ),
@@ -85,7 +74,7 @@ export type AlignedQuoteTokenInfoResponse = v.InferOutput<typeof AlignedQuoteTok
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode alignedQuoteTokenInfo} function. */
 export type AlignedQuoteTokenInfoParameters = Omit<v.InferInput<typeof AlignedQuoteTokenInfoRequest>, "type">;
@@ -95,7 +84,7 @@ export type AlignedQuoteTokenInfoParameters = Omit<v.InferInput<typeof AlignedQu
  *
  * @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 Supply, rate, and pending payment information for an aligned quote token.
  *

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

@@ -0,0 +1,131 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+
+/** Borrow/lend reserve state for a token. */
+const BorrowLendReserveStateSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Yearly borrow rate. */
+      borrowYearlyRate: v.pipe(
+        UnsignedDecimal,
+        v.description("Yearly borrow rate."),
+      ),
+      /** Yearly supply rate. */
+      supplyYearlyRate: v.pipe(
+        UnsignedDecimal,
+        v.description("Yearly supply rate."),
+      ),
+      /** Balance. */
+      balance: v.pipe(
+        UnsignedDecimal,
+        v.description("Balance."),
+      ),
+      /** Utilization rate. */
+      utilization: v.pipe(
+        UnsignedDecimal,
+        v.description("Utilization rate."),
+      ),
+      /** Oracle price. */
+      oraclePx: v.pipe(
+        UnsignedDecimal,
+        v.description("Oracle price."),
+      ),
+      /** Loan-to-value ratio. */
+      ltv: v.pipe(
+        UnsignedDecimal,
+        v.description("Loan-to-value ratio."),
+      ),
+      /** Total supplied amount. */
+      totalSupplied: v.pipe(
+        UnsignedDecimal,
+        v.description("Total supplied amount."),
+      ),
+      /** Total borrowed amount. */
+      totalBorrowed: v.pipe(
+        UnsignedDecimal,
+        v.description("Total borrowed amount."),
+      ),
+    }),
+    v.description("Borrow/lend reserve state for a token."),
+  );
+})();
+type BorrowLendReserveStateSchema = v.InferOutput<typeof BorrowLendReserveStateSchema>;
+
+/** Token and its reserve state as a tuple [token, state]. */
+const BorrowLendReserveTokenStateSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.tuple([UnsignedInteger, BorrowLendReserveStateSchema]),
+    v.description("Token and its reserve state as a tuple [token, state]."),
+  );
+})();
+type BorrowLendReserveTokenStateSchema = v.InferOutput<typeof BorrowLendReserveTokenStateSchema>;
+
+/**
+ * Request all borrow/lend reserve states.
+ */
+export const AllBorrowLendReserveStatesRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("allBorrowLendReserveStates"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request all borrow/lend reserve states."),
+  );
+})();
+export type AllBorrowLendReserveStatesRequest = v.InferOutput<typeof AllBorrowLendReserveStatesRequest>;
+
+/**
+ * All borrow/lend reserve states response.
+ */
+export const AllBorrowLendReserveStatesResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(BorrowLendReserveTokenStateSchema),
+    v.description("All borrow/lend reserve states response."),
+  );
+})();
+export type AllBorrowLendReserveStatesResponse = v.InferOutput<typeof AllBorrowLendReserveStatesResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import type { InfoConfig } from "./_base/types.js";
+
+/**
+ * Request all borrow/lend reserve states.
+ *
+ * @param config - General configuration for Info API requests.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ *
+ * @returns Array of all borrow/lend reserve states as [token, state] tuples.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { allBorrowLendReserveStates } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await allBorrowLendReserveStates({ transport });
+ * ```
+ */
+export function allBorrowLendReserveStates(
+  config: InfoConfig,
+  signal?: AbortSignal,
+): Promise<AllBorrowLendReserveStatesResponse> {
+  const request = v.parse(AllBorrowLendReserveStatesRequest, {
+    type: "allBorrowLendReserveStates",
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -45,7 +45,7 @@ export type AllMidsResponse = v.InferOutput<typeof AllMidsResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode allMids} function. */
 export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
@@ -55,7 +55,7 @@ export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type"
  *
  * @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 Mapping of coin symbols to mid prices.
  *

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

@@ -38,13 +38,13 @@ export type AllPerpMetasResponse = v.InferOutput<typeof AllPerpMetasResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request trading metadata for all DEXes.
  *
  * @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 Metadata for perpetual assets across all DEXes.
  *

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

@@ -5,6 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { Address, Hex, UnsignedInteger } from "../../_schemas.js";
+import { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request block details by block height.
@@ -49,7 +50,8 @@ export const BlockDetailsResponse = /* @__PURE__ */ (() => {
           ),
           /** Block hash. */
           hash: v.pipe(
-            v.pipe(Hex, v.length(66)),
+            Hex,
+            v.length(66),
             v.description("Block hash."),
           ),
           /** Block height in chain. */
@@ -69,50 +71,7 @@ export const BlockDetailsResponse = /* @__PURE__ */ (() => {
           ),
           /** Array of transactions in the block. */
           txs: v.pipe(
-            v.array(
-              /** Transaction details. */
-              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 transactions in the block."),
           ),
         }),
@@ -128,8 +87,7 @@ export type BlockDetailsResponse = v.InferOutput<typeof BlockDetailsResponse>;
 // 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 blockDetails} function. */
 export type BlockDetailsParameters = Omit<v.InferInput<typeof BlockDetailsRequest>, "type">;
@@ -139,7 +97,7 @@ export type BlockDetailsParameters = Omit<v.InferInput<typeof BlockDetailsReques
  *
  * @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 Response containing block information.
  *
@@ -159,7 +117,7 @@ export type BlockDetailsParameters = Omit<v.InferInput<typeof BlockDetailsReques
  * ```
  */
 export function blockDetails(
-  config: InfoConfig<HttpTransport>,
+  config: InfoConfig,
   params: BlockDetailsParameters,
   signal?: AbortSignal,
 ): Promise<BlockDetailsResponse> {

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

@@ -0,0 +1,151 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+
+/** Borrow/lend value with basis and current value. */
+const BorrowLendValueSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Basis value. */
+      basis: v.pipe(
+        UnsignedDecimal,
+        v.description("Basis value."),
+      ),
+      /** Current value. */
+      value: v.pipe(
+        UnsignedDecimal,
+        v.description("Current value."),
+      ),
+    }),
+    v.description("Borrow/lend value with basis and current value."),
+  );
+})();
+type BorrowLendValueSchema = v.InferOutput<typeof BorrowLendValueSchema>;
+
+/** User's borrow and supply state for a token. */
+const BorrowLendUserStateSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Borrow state. */
+      borrow: v.pipe(
+        BorrowLendValueSchema,
+        v.description("Borrow state."),
+      ),
+      /** Supply state. */
+      supply: v.pipe(
+        BorrowLendValueSchema,
+        v.description("Supply state."),
+      ),
+    }),
+    v.description("User's borrow and supply state for a token."),
+  );
+})();
+type BorrowLendUserStateSchema = v.InferOutput<typeof BorrowLendUserStateSchema>;
+
+/** Token and its borrow/lend state as a tuple [token, state]. */
+const BorrowLendUserTokenStateSchema = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.tuple([UnsignedInteger, BorrowLendUserStateSchema]),
+    v.description("Token and its borrow/lend state as a tuple [token, state]."),
+  );
+})();
+type BorrowLendUserTokenStateSchema = v.InferOutput<typeof BorrowLendUserTokenStateSchema>;
+
+/**
+ * Request user's borrow/lend state.
+ */
+export const BorrowLendUserStateRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("borrowLendUserState"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user's borrow/lend state."),
+  );
+})();
+export type BorrowLendUserStateRequest = v.InferOutput<typeof BorrowLendUserStateRequest>;
+
+/**
+ * User's borrow/lend state response.
+ */
+export const BorrowLendUserStateResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Array of token states as [token, state] tuples. */
+      tokenToState: v.pipe(
+        v.array(BorrowLendUserTokenStateSchema),
+        v.description("Array of token states as [token, state] tuples."),
+      ),
+      /** Health status string. */
+      health: v.pipe(
+        v.string(),
+        v.description("Health status string."),
+      ),
+      /** Health factor (nullable). */
+      healthFactor: v.pipe(
+        v.nullable(UnsignedDecimal),
+        v.description("Health factor (nullable)."),
+      ),
+    }),
+    v.description("User's borrow/lend state response."),
+  );
+})();
+export type BorrowLendUserStateResponse = v.InferOutput<typeof BorrowLendUserStateResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode borrowLendUserState} function. */
+export type BorrowLendUserStateParameters = Omit<v.InferInput<typeof BorrowLendUserStateRequest>, "type">;
+
+/**
+ * Request user's borrow/lend state.
+ *
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ *
+ * @returns User's borrow/lend state including token states, health, and health factor.
+ *
+ * @throws {ValiError} When the request parameters fail validation (before sending).
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { borrowLendUserState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await borrowLendUserState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function borrowLendUserState(
+  config: InfoConfig,
+  params: BorrowLendUserStateParameters,
+  signal?: AbortSignal,
+): Promise<BorrowLendUserStateResponse> {
+  const request = v.parse(BorrowLendUserStateRequest, {
+    type: "borrowLendUserState",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -57,62 +57,58 @@ export type CandleSnapshotRequest = v.InferOutput<typeof CandleSnapshotRequest>;
 export const CandleSnapshotResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Candlestick data point. */
-      v.pipe(
-        v.object({
-          /** Opening timestamp (ms since epoch). */
-          t: v.pipe(
-            UnsignedInteger,
-            v.description("Opening timestamp (ms since epoch)."),
-          ),
-          /** Closing timestamp (ms since epoch). */
-          T: v.pipe(
-            UnsignedInteger,
-            v.description("Closing timestamp (ms since epoch)."),
-          ),
-          /** Asset symbol. */
-          s: v.pipe(
-            v.string(),
-            v.description("Asset symbol."),
-          ),
-          /** Time interval. */
-          i: v.pipe(
-            v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
-            v.description("Time interval."),
-          ),
-          /** Opening price. */
-          o: v.pipe(
-            UnsignedDecimal,
-            v.description("Opening price."),
-          ),
-          /** Closing price. */
-          c: v.pipe(
-            UnsignedDecimal,
-            v.description("Closing price."),
-          ),
-          /** Highest price. */
-          h: v.pipe(
-            UnsignedDecimal,
-            v.description("Highest price."),
-          ),
-          /** Lowest price. */
-          l: v.pipe(
-            UnsignedDecimal,
-            v.description("Lowest price."),
-          ),
-          /** Total volume traded in base currency. */
-          v: v.pipe(
-            UnsignedDecimal,
-            v.description("Total volume traded in base currency."),
-          ),
-          /** Number of trades executed. */
-          n: v.pipe(
-            UnsignedInteger,
-            v.description("Number of trades executed."),
-          ),
-        }),
-        v.description("Candlestick data point."),
-      ),
+      v.object({
+        /** Opening timestamp (ms since epoch). */
+        t: v.pipe(
+          UnsignedInteger,
+          v.description("Opening timestamp (ms since epoch)."),
+        ),
+        /** Closing timestamp (ms since epoch). */
+        T: v.pipe(
+          UnsignedInteger,
+          v.description("Closing timestamp (ms since epoch)."),
+        ),
+        /** Asset symbol. */
+        s: v.pipe(
+          v.string(),
+          v.description("Asset symbol."),
+        ),
+        /** Time interval. */
+        i: v.pipe(
+          v.picklist(["1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M"]),
+          v.description("Time interval."),
+        ),
+        /** Opening price. */
+        o: v.pipe(
+          UnsignedDecimal,
+          v.description("Opening price."),
+        ),
+        /** Closing price. */
+        c: v.pipe(
+          UnsignedDecimal,
+          v.description("Closing price."),
+        ),
+        /** Highest price. */
+        h: v.pipe(
+          UnsignedDecimal,
+          v.description("Highest price."),
+        ),
+        /** Lowest price. */
+        l: v.pipe(
+          UnsignedDecimal,
+          v.description("Lowest price."),
+        ),
+        /** Total volume traded in base currency. */
+        v: v.pipe(
+          UnsignedDecimal,
+          v.description("Total volume traded in base currency."),
+        ),
+        /** Number of trades executed. */
+        n: v.pipe(
+          UnsignedInteger,
+          v.description("Number of trades executed."),
+        ),
+      }),
     ),
     v.description("Array of candlestick data points."),
   );
@@ -123,7 +119,7 @@ export type CandleSnapshotResponse = v.InferOutput<typeof CandleSnapshotResponse
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode candleSnapshot} function. */
 export type CandleSnapshotParameters = v.InferInput<typeof CandleSnapshotRequest>["req"];
@@ -133,7 +129,7 @@ export type CandleSnapshotParameters = v.InferInput<typeof CandleSnapshotRequest
  *
  * @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 candlestick data points.
  *