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

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

@@ -66,7 +66,7 @@ export type UserRateLimitResponse = v.InferOutput<typeof UserRateLimitResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userRateLimit} function. */
 export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequest>, "type">;
@@ -76,7 +76,7 @@ export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequ
  *
  * @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 rate limits.
  *

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

@@ -89,7 +89,7 @@ export type UserRoleResponse = v.InferOutput<typeof UserRoleResponse>;
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userRole} function. */
 export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "type">;
@@ -99,7 +99,7 @@ export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "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 User role.
  *

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

@@ -38,7 +38,7 @@ export const UserToMultiSigSignersResponse = /* @__PURE__ */ (() => {
         /** Authorized users addresses. */
         authorizedUsers: v.pipe(
           v.array(Address),
-          v.minLength(1),
+          v.nonEmpty(),
           v.description("Authorized users addresses."),
         ),
         /** Threshold number of signatures required. */
@@ -58,7 +58,7 @@ export type UserToMultiSigSignersResponse = v.InferOutput<typeof UserToMultiSigS
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userToMultiSigSigners} function. */
 export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMultiSigSignersRequest>, "type">;
@@ -68,7 +68,7 @@ export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMul
  *
  * @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 Multi-sig signers for a user or null if the user does not have any multi-sig signers.
  *

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

@@ -4,7 +4,8 @@ import * as v from "valibot";
 // API Schemas
 // ============================================================
 
-import { Address, Decimal, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
+import { Address, UnsignedInteger } from "../../_schemas.js";
+import { UserFillSchema } from "./_base/commonSchemas.js";
 
 /**
  * Request user TWAP slice fills.
@@ -36,98 +37,18 @@ export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsR
 export const UserTwapSliceFillsResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** User twap slice fill. */
-      v.pipe(
-        v.object({
-          /** TWAP fill record. */
-          fill: v.pipe(
-            v.object({
-              /** Asset symbol. */
-              coin: v.pipe(
-                v.string(),
-                v.description("Asset symbol."),
-              ),
-              /** Price. */
-              px: v.pipe(
-                UnsignedDecimal,
-                v.description("Price."),
-              ),
-              /** Size. */
-              sz: v.pipe(
-                UnsignedDecimal,
-                v.description("Size."),
-              ),
-              /** 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).'),
-              ),
-              /** Timestamp when the trade occurred (in ms since epoch). */
-              time: v.pipe(
-                UnsignedInteger,
-                v.description("Timestamp when the trade occurred (in ms since epoch)."),
-              ),
-              /** Start position size. */
-              startPosition: v.pipe(
-                Decimal,
-                v.description("Start position size."),
-              ),
-              /** Direction indicator for frontend display. */
-              dir: v.pipe(
-                v.string(),
-                v.description("Direction indicator for frontend display."),
-              ),
-              /** Realized PnL. */
-              closedPnl: v.pipe(
-                Decimal,
-                v.description("Realized PnL."),
-              ),
-              /** L1 transaction hash. */
-              hash: v.pipe(
-                v.pipe(Hex, v.length(66)),
-                v.description("L1 transaction hash."),
-              ),
-              /** Order ID. */
-              oid: v.pipe(
-                UnsignedInteger,
-                v.description("Order ID."),
-              ),
-              /** Indicates if the fill was a taker order. */
-              crossed: v.pipe(
-                v.boolean(),
-                v.description("Indicates if the fill was a taker order."),
-              ),
-              /** Fee charged or rebate received (negative indicates rebate). */
-              fee: v.pipe(
-                Decimal,
-                v.description("Fee charged or rebate received (negative indicates rebate)."),
-              ),
-              /** Unique transaction identifier for a partial fill of an order. */
-              tid: v.pipe(
-                UnsignedInteger,
-                v.description("Unique transaction identifier for a partial fill of an order."),
-              ),
-              /** Token in which the fee is denominated (e.g., "USDC"). */
-              feeToken: v.pipe(
-                v.string(),
-                v.description('Token in which the fee is denominated (e.g., "USDC").'),
-              ),
-              /** ID of the TWAP. */
-              twapId: v.pipe(
-                v.nullable(UnsignedInteger),
-                v.description("ID of the TWAP."),
-              ),
-            }),
-            v.description("TWAP fill record."),
-          ),
-          /** ID of the TWAP. */
-          twapId: v.pipe(
-            UnsignedInteger,
-            v.description("ID of the TWAP."),
-          ),
-        }),
-        v.description("User twap slice fill."),
-      ),
+      v.object({
+        /** TWAP fill record. */
+        fill: v.pipe(
+          UserFillSchema,
+          v.description("TWAP fill record."),
+        ),
+        /** ID of the TWAP. */
+        twapId: v.pipe(
+          UnsignedInteger,
+          v.description("ID of the TWAP."),
+        ),
+      }),
     ),
     v.description("Array of user's twap slice fills."),
   );
@@ -138,7 +59,7 @@ export type UserTwapSliceFillsResponse = v.InferOutput<typeof UserTwapSliceFills
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userTwapSliceFills} function. */
 export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSliceFillsRequest>, "type">;
@@ -148,7 +69,7 @@ export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSlic
  *
  * @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 slice fills.
  *

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

@@ -60,7 +60,7 @@ export type UserTwapSliceFillsByTimeResponse = v.InferOutput<typeof UserTwapSlic
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userTwapSliceFillsByTime} function. */
 export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTwapSliceFillsByTimeRequest>, "type">;
@@ -70,7 +70,7 @@ export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTw
  *
  * @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 slice fill by time.
  *

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

@@ -36,27 +36,23 @@ export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesReq
 export const UserVaultEquitiesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** User's vault deposit. */
-      v.pipe(
-        v.object({
-          /** Vault address. */
-          vaultAddress: v.pipe(
-            Address,
-            v.description("Vault address."),
-          ),
-          /** User deposited equity. */
-          equity: v.pipe(
-            UnsignedDecimal,
-            v.description("User deposited equity."),
-          ),
-          /** Timestamp when the user can withdraw their equity. */
-          lockedUntilTimestamp: v.pipe(
-            UnsignedInteger,
-            v.description("Timestamp when the user can withdraw their equity."),
-          ),
-        }),
-        v.description("User's vault deposit."),
-      ),
+      v.object({
+        /** Vault address. */
+        vaultAddress: v.pipe(
+          Address,
+          v.description("Vault address."),
+        ),
+        /** User deposited equity. */
+        equity: v.pipe(
+          UnsignedDecimal,
+          v.description("User deposited equity."),
+        ),
+        /** Timestamp when the user can withdraw their equity. */
+        lockedUntilTimestamp: v.pipe(
+          UnsignedInteger,
+          v.description("Timestamp when the user can withdraw their equity."),
+        ),
+      }),
     ),
     v.description("Array of user's vault deposits."),
   );
@@ -67,7 +63,7 @@ export type UserVaultEquitiesResponse = v.InferOutput<typeof UserVaultEquitiesRe
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /** Request parameters for the {@linkcode userVaultEquities} function. */
 export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEquitiesRequest>, "type">;
@@ -77,7 +73,7 @@ export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEqui
  *
  * @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 vault deposits.
  *

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

@@ -29,34 +29,32 @@ export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesReque
 export const ValidatorL1VotesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** L1 governance vote cast by validators. */
-      v.pipe(
-        v.object({
-          /** Timestamp when the vote expires (in ms since epoch). */
-          expireTime: v.pipe(
-            Integer,
-            v.description("Timestamp when the vote expires (in ms since epoch)."),
-          ),
-          /** Type of the vote. */
-          action: v.pipe(
-            v.union([
-              v.object({
-                D: v.string(),
-              }),
-              v.object({
-                C: v.array(v.string()),
-              }),
-            ]),
-            v.description("Type of the vote."),
-          ),
-          /** List of validator addresses that cast this vote. */
-          votes: v.pipe(
-            v.array(Address),
-            v.description("List of validator addresses that cast this vote."),
-          ),
-        }),
-        v.description("L1 governance vote cast by validators."),
-      ),
+      v.object({
+        /** Timestamp when the vote expires (in ms since epoch). */
+        expireTime: v.pipe(
+          Integer,
+          v.description("Timestamp when the vote expires (in ms since epoch)."),
+        ),
+        /** Type of the vote. */
+        action: v.pipe(
+          v.union([
+            v.object({
+              // deno-lint-ignore valibot-project/require-description valibot-project/require-jsdoc
+              D: v.string(),
+            }),
+            v.object({
+              // deno-lint-ignore valibot-project/require-description valibot-project/require-jsdoc
+              C: v.array(v.string()),
+            }),
+          ]),
+          v.description("Type of the vote."),
+        ),
+        /** List of validator addresses that cast this vote. */
+        votes: v.pipe(
+          v.array(Address),
+          v.description("List of validator addresses that cast this vote."),
+        ),
+      }),
     ),
     v.description("Array of L1 governance votes cast by validators."),
   );
@@ -67,13 +65,13 @@ export type ValidatorL1VotesResponse = v.InferOutput<typeof ValidatorL1VotesResp
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request validator L1 votes.
  *
  * @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 L1 governance votes cast by validators.
  *

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

@@ -24,7 +24,7 @@ export const ValidatorSummariesRequest = /* @__PURE__ */ (() => {
 export type ValidatorSummariesRequest = v.InferOutput<typeof ValidatorSummariesRequest>;
 
 /** Statistics for validator performance over a time period. */
-const ValidatorStats = /* @__PURE__ */ (() => {
+const ValidatorStatsSchema = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** Fraction of time the validator was online. */
@@ -53,71 +53,68 @@ const ValidatorStats = /* @__PURE__ */ (() => {
 export const ValidatorSummariesResponse = /* @__PURE__ */ (() => {
   return v.pipe(
     v.array(
-      /** Validator performance statistics. */
-      v.pipe(
-        v.object({
-          /** Address of the validator. */
-          validator: v.pipe(
-            Address,
-            v.description("Address of the validator."),
-          ),
-          /** Address of the validator signer. */
-          signer: v.pipe(
-            Address,
-            v.description("Address of the validator signer."),
-          ),
-          /** Name of the validator. */
-          name: v.pipe(
-            v.string(),
-            v.description("Name of the validator."),
-          ),
-          /** Description of the validator. */
-          description: v.pipe(
-            v.string(),
-            v.description("Description of the validator."),
-          ),
-          /** Number of blocks produced recently. */
-          nRecentBlocks: v.pipe(
-            UnsignedInteger,
-            v.description("Number of blocks produced recently."),
-          ),
-          /** Total amount of tokens staked **(unsafe integer)**. */
-          stake: v.pipe(
-            v.pipe(v.number(), v.integer()),
-            v.description("Total amount of tokens staked **(unsafe integer)**."),
-          ),
-          /** Whether the validator is currently jailed. */
-          isJailed: v.pipe(
-            v.boolean(),
-            v.description("Whether the validator is currently jailed."),
-          ),
-          /** Timestamp when the validator can be unjailed (in ms since epoch). */
-          unjailableAfter: v.pipe(
-            v.nullable(UnsignedInteger),
-            v.description("Timestamp when the validator can be unjailed (in ms since epoch)."),
-          ),
-          /** Whether the validator is currently active. */
-          isActive: v.pipe(
-            v.boolean(),
-            v.description("Whether the validator is currently active."),
-          ),
-          /** Commission rate charged by the validator. */
-          commission: v.pipe(
-            UnsignedDecimal,
-            v.description("Commission rate charged by the validator."),
-          ),
-          /** Performance statistics over different time periods. */
-          stats: v.pipe(
-            v.tuple([
-              v.tuple([v.literal("day"), ValidatorStats]),
-              v.tuple([v.literal("week"), ValidatorStats]),
-              v.tuple([v.literal("month"), ValidatorStats]),
-            ]),
-            v.description("Performance statistics over different time periods."),
-          ),
-        }),
-        v.description("Validator performance statistics."),
-      ),
+      v.object({
+        /** Address of the validator. */
+        validator: v.pipe(
+          Address,
+          v.description("Address of the validator."),
+        ),
+        /** Address of the validator signer. */
+        signer: v.pipe(
+          Address,
+          v.description("Address of the validator signer."),
+        ),
+        /** Name of the validator. */
+        name: v.pipe(
+          v.string(),
+          v.description("Name of the validator."),
+        ),
+        /** Description of the validator. */
+        description: v.pipe(
+          v.string(),
+          v.description("Description of the validator."),
+        ),
+        /** Number of blocks produced recently. */
+        nRecentBlocks: v.pipe(
+          UnsignedInteger,
+          v.description("Number of blocks produced recently."),
+        ),
+        /** Total amount of tokens staked **(unsafe integer)**. */
+        stake: v.pipe(
+          v.number(),
+          v.integer(),
+          v.description("Total amount of tokens staked **(unsafe integer)**."),
+        ),
+        /** Whether the validator is currently jailed. */
+        isJailed: v.pipe(
+          v.boolean(),
+          v.description("Whether the validator is currently jailed."),
+        ),
+        /** Timestamp when the validator can be unjailed (in ms since epoch). */
+        unjailableAfter: v.pipe(
+          v.nullable(UnsignedInteger),
+          v.description("Timestamp when the validator can be unjailed (in ms since epoch)."),
+        ),
+        /** Whether the validator is currently active. */
+        isActive: v.pipe(
+          v.boolean(),
+          v.description("Whether the validator is currently active."),
+        ),
+        /** Commission rate charged by the validator. */
+        commission: v.pipe(
+          UnsignedDecimal,
+          v.description("Commission rate charged by the validator."),
+        ),
+        /** Performance statistics over different time periods. */
+        stats: v.pipe(
+          v.tuple([
+            v.tuple([v.literal("day"), ValidatorStatsSchema]),
+            v.tuple([v.literal("week"), ValidatorStatsSchema]),
+            v.tuple([v.literal("month"), ValidatorStatsSchema]),
+          ]),
+          v.description("Performance statistics over different time periods."),
+        ),
+      }),
     ),
     v.description("Array of validator performance statistics."),
   );
@@ -128,13 +125,13 @@ export type ValidatorSummariesResponse = v.InferOutput<typeof ValidatorSummaries
 // Execution Logic
 // ============================================================
 
-import type { InfoConfig } from "./_types.js";
+import type { InfoConfig } from "./_base/types.js";
 
 /**
  * Request validator summaries.
  *
  * @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 validator performance statistics.
  *