@nktkas/hyperliquid 0.30.2 → 0.31.0

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

@@ -11,21 +11,12 @@ import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
  */
 export const UserRateLimitRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userRateLimit"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user rate limits."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userRateLimit"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
 
@@ -34,31 +25,16 @@ export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
  */
 export const UserRateLimitResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Cumulative trading volume. */
-      cumVlm: v.pipe(
-        UnsignedDecimal,
-        v.description("Cumulative trading volume."),
-      ),
-      /** Number of API requests used. */
-      nRequestsUsed: v.pipe(
-        UnsignedInteger,
-        v.description("Number of API requests used."),
-      ),
-      /** Maximum allowed API requests. */
-      nRequestsCap: v.pipe(
-        UnsignedInteger,
-        v.description("Maximum allowed API requests."),
-      ),
-      /** Number of surplus API requests. */
-      nRequestsSurplus: v.pipe(
-        UnsignedInteger,
-        v.description("Number of surplus API requests."),
-      ),
-    }),
-    v.description("User rate limits."),
-  );
+  return v.object({
+    /** Cumulative trading volume. */
+    cumVlm: UnsignedDecimal,
+    /** Number of API requests used. */
+    nRequestsUsed: UnsignedInteger,
+    /** Maximum allowed API requests. */
+    nRequestsCap: UnsignedInteger,
+    /** Number of surplus API requests. */
+    nRequestsSurplus: UnsignedInteger,
+  });
 })();
 export type UserRateLimitResponse = v.InferOutput<typeof UserRateLimitResponse>;
 

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

@@ -11,21 +11,12 @@ import { Address } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
  */
 export const UserRoleRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userRole"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user role."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userRole"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
 
@@ -34,54 +25,30 @@ export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
  */
 export const UserRoleResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.variant("role", [
-      v.object({
-        /** Role identifier. */
-        role: v.pipe(
-          v.picklist(["missing", "user", "vault"]),
-          v.description("Role identifier."),
-        ),
-      }),
-      v.object({
-        /** Role identifier. */
-        role: v.pipe(
-          v.literal("agent"),
-          v.description("Role identifier."),
-        ),
-        /** Details for agent role. */
-        data: v.pipe(
-          v.object({
-            /** Master account address associated with the agent. */
-            user: v.pipe(
-              Address,
-              v.description("Master account address associated with the agent."),
-            ),
-          }),
-          v.description("Details for agent role."),
-        ),
+  return v.variant("role", [
+    v.object({
+      /** Role identifier. */
+      role: v.picklist(["missing", "user", "vault"]),
+    }),
+    v.object({
+      /** Role identifier. */
+      role: v.literal("agent"),
+      /** Details for agent role. */
+      data: v.object({
+        /** Master account address associated with the agent. */
+        user: Address,
       }),
-      v.object({
-        /** Role identifier. */
-        role: v.pipe(
-          v.literal("subAccount"),
-          v.description("Role identifier."),
-        ),
-        /** Details for sub-account role. */
-        data: v.pipe(
-          v.object({
-            /** Master account address associated with the sub-account. */
-            master: v.pipe(
-              Address,
-              v.description("Master account address associated with the sub-account."),
-            ),
-          }),
-          v.description("Details for sub-account role."),
-        ),
+    }),
+    v.object({
+      /** Role identifier. */
+      role: v.literal("subAccount"),
+      /** Details for sub-account role. */
+      data: v.object({
+        /** Master account address associated with the sub-account. */
+        master: Address,
       }),
-    ]),
-    v.description("User role."),
-  );
+    }),
+  ]);
 })();
 export type UserRoleResponse = v.InferOutput<typeof UserRoleResponse>;
 

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

@@ -10,21 +10,12 @@ import { Address, UnsignedInteger } from "../../_schemas.js";
  * Request multi-sig signers for a user.
  */
 export const UserToMultiSigSignersRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userToMultiSigSigners"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request multi-sig signers for a user."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userToMultiSigSigners"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserToMultiSigSignersRequest = v.InferOutput<typeof UserToMultiSigSignersRequest>;
 
@@ -32,24 +23,13 @@ export type UserToMultiSigSignersRequest = v.InferOutput<typeof UserToMultiSigSi
  * Multi-sig signers for a user or null if the user does not have any multi-sig signers.
  */
 export const UserToMultiSigSignersResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.nullable(
-      v.object({
-        /** Authorized users addresses. */
-        authorizedUsers: v.pipe(
-          v.array(Address),
-          v.nonEmpty(),
-          v.description("Authorized users addresses."),
-        ),
-        /** Threshold number of signatures required. */
-        threshold: v.pipe(
-          UnsignedInteger,
-          v.minValue(1),
-          v.description("Threshold number of signatures required."),
-        ),
-      }),
-    ),
-    v.description("Multi-sig signers for a user or null if the user does not have any multi-sig signers."),
+  return v.nullable(
+    v.object({
+      /** Authorized users addresses. */
+      authorizedUsers: v.pipe(v.array(Address), v.nonEmpty()),
+      /** Threshold number of signatures required. */
+      threshold: v.pipe(UnsignedInteger, v.minValue(1)),
+    }),
   );
 })();
 export type UserToMultiSigSignersResponse = v.InferOutput<typeof UserToMultiSigSignersResponse>;

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

@@ -12,21 +12,12 @@ import { UserFillSchema } from "./_base/commonSchemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
  */
 export const UserTwapSliceFillsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userTwapSliceFills"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user TWAP slice fills."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userTwapSliceFills"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsRequest>;
 
@@ -35,22 +26,13 @@ export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsR
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
  */
 export const UserTwapSliceFillsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      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."),
+  return v.array(
+    v.object({
+      /** TWAP fill record. */
+      fill: UserFillSchema,
+      /** ID of the TWAP. */
+      twapId: UnsignedInteger,
+    }),
   );
 })();
 export type UserTwapSliceFillsResponse = v.InferOutput<typeof UserTwapSliceFillsResponse>;

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

@@ -11,36 +11,18 @@ import { UserTwapSliceFillsResponse } from "./userTwapSliceFills.js";
  * Request user TWAP slice fills by time.
  */
 export const UserTwapSliceFillsByTimeRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userTwapSliceFillsByTime"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-      /** Start time (in ms since epoch). */
-      startTime: v.pipe(
-        UnsignedInteger,
-        v.description("Start time (in ms since epoch)."),
-      ),
-      /** End time (in ms since epoch). */
-      endTime: v.pipe(
-        v.nullish(UnsignedInteger),
-        v.description("End time (in ms since epoch)."),
-      ),
-      /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
-      aggregateByTime: v.pipe(
-        v.optional(v.boolean()),
-        v.description("If true, partial fills are aggregated when a crossing order fills multiple resting orders."),
-      ),
-    }),
-    v.description("Request user TWAP slice fills by time."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userTwapSliceFillsByTime"),
+    /** User address. */
+    user: Address,
+    /** Start time (in ms since epoch). */
+    startTime: UnsignedInteger,
+    /** End time (in ms since epoch). */
+    endTime: v.nullish(UnsignedInteger),
+    /** If true, partial fills are aggregated when a crossing order fills multiple resting orders. */
+    aggregateByTime: v.optional(v.boolean()),
+  });
 })();
 export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSliceFillsByTimeRequest>;
 
@@ -49,10 +31,7 @@ export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSlice
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
  */
 export const UserTwapSliceFillsByTimeResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    UserTwapSliceFillsResponse,
-    v.description("Array of user's twap slice fill by time."),
-  );
+  return UserTwapSliceFillsResponse;
 })();
 export type UserTwapSliceFillsByTimeResponse = v.InferOutput<typeof UserTwapSliceFillsByTimeResponse>;
 

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

@@ -11,21 +11,12 @@ import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
  */
 export const UserVaultEquitiesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("userVaultEquities"),
-        v.description("Type of request."),
-      ),
-      /** User address. */
-      user: v.pipe(
-        Address,
-        v.description("User address."),
-      ),
-    }),
-    v.description("Request user vault deposits."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userVaultEquities"),
+    /** User address. */
+    user: Address,
+  });
 })();
 export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesRequest>;
 
@@ -34,27 +25,15 @@ export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesReq
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
  */
 export const UserVaultEquitiesResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      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."),
+  return v.array(
+    v.object({
+      /** Vault address. */
+      vaultAddress: Address,
+      /** User deposited equity. */
+      equity: UnsignedDecimal,
+      /** Timestamp when the user can withdraw their equity. */
+      lockedUntilTimestamp: UnsignedInteger,
+    }),
   );
 })();
 export type UserVaultEquitiesResponse = v.InferOutput<typeof UserVaultEquitiesResponse>;

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

@@ -10,16 +10,10 @@ import { Address, Integer } from "../../_schemas.js";
  * Request validator L1 votes.
  */
 export const ValidatorL1VotesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("validatorL1Votes"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request validator L1 votes."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("validatorL1Votes"),
+  });
 })();
 export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesRequest>;
 
@@ -27,36 +21,24 @@ export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesReque
  * Array of L1 governance votes cast by validators.
  */
 export const ValidatorL1VotesResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      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."),
+  return v.array(
+    v.object({
+      /** Timestamp when the vote expires (in ms since epoch). */
+      expireTime: Integer,
+      /** Type of the vote. */
+      action: v.union([
+        v.object({
+          // deno-lint-ignore valibot-project/require-jsdoc
+          D: v.string(),
+        }),
+        v.object({
+          // deno-lint-ignore valibot-project/require-jsdoc
+          C: v.array(v.string()),
+        }),
+      ]),
+      /** List of validator addresses that cast this vote. */
+      votes: v.array(Address),
+    }),
   );
 })();
 export type ValidatorL1VotesResponse = v.InferOutput<typeof ValidatorL1VotesResponse>;

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

@@ -10,113 +10,58 @@ import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
  * Request validator summaries.
  */
 export const ValidatorSummariesRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Type of request. */
-      type: v.pipe(
-        v.literal("validatorSummaries"),
-        v.description("Type of request."),
-      ),
-    }),
-    v.description("Request validator summaries."),
-  );
+  return v.object({
+    /** Type of request. */
+    type: v.literal("validatorSummaries"),
+  });
 })();
 export type ValidatorSummariesRequest = v.InferOutput<typeof ValidatorSummariesRequest>;
 
 /** Statistics for validator performance over a time period. */
 const ValidatorStatsSchema = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Fraction of time the validator was online. */
-      uptimeFraction: v.pipe(
-        v.string(),
-        v.description("Fraction of time the validator was online."),
-      ),
-      /** Predicted annual percentage rate of returns. */
-      predictedApr: v.pipe(
-        UnsignedDecimal,
-        v.description("Predicted annual percentage rate of returns."),
-      ),
-      /** Number of samples used for statistics calculation. */
-      nSamples: v.pipe(
-        UnsignedInteger,
-        v.description("Number of samples used for statistics calculation."),
-      ),
-    }),
-    v.description("Statistics for validator performance over a time period."),
-  );
+  return v.object({
+    /** Fraction of time the validator was online. */
+    uptimeFraction: v.string(),
+    /** Predicted annual percentage rate of returns. */
+    predictedApr: UnsignedDecimal,
+    /** Number of samples used for statistics calculation. */
+    nSamples: UnsignedInteger,
+  });
 })();
 
 /**
  * Array of validator performance statistics.
  */
 export const ValidatorSummariesResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.array(
-      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."),
+  return v.array(
+    v.object({
+      /** Address of the validator. */
+      validator: Address,
+      /** Address of the validator signer. */
+      signer: Address,
+      /** Name of the validator. */
+      name: v.string(),
+      /** Description of the validator. */
+      description: v.string(),
+      /** Number of blocks produced recently. */
+      nRecentBlocks: UnsignedInteger,
+      /** Total amount of tokens staked **(unsafe integer)**. */
+      stake: v.pipe(v.number(), v.integer()),
+      /** Whether the validator is currently jailed. */
+      isJailed: v.boolean(),
+      /** Timestamp when the validator can be unjailed (in ms since epoch). */
+      unjailableAfter: v.nullable(UnsignedInteger),
+      /** Whether the validator is currently active. */
+      isActive: v.boolean(),
+      /** Commission rate charged by the validator. */
+      commission: UnsignedDecimal,
+      /** Performance statistics over different time periods. */
+      stats: v.tuple([
+        v.tuple([v.literal("day"), ValidatorStatsSchema]),
+        v.tuple([v.literal("week"), ValidatorStatsSchema]),
+        v.tuple([v.literal("month"), ValidatorStatsSchema]),
+      ]),
+    }),
   );
 })();
 export type ValidatorSummariesResponse = v.InferOutput<typeof ValidatorSummariesResponse>;