@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,130 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../_base.js";
+
+/**
+ * Request user role.
+ * @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."),
+  );
+})();
+export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
+
+/**
+ * User role.
+ * @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.union([v.literal("missing"), v.literal("user"), v.literal("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."),
+        ),
+      }),
+      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.description("User role."),
+  );
+})();
+export type UserRoleResponse = v.InferOutput<typeof UserRoleResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userRole} function. */
+export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "type">;
+
+/**
+ * Request user role.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns User role.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userRole } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userRole(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userRole(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserRoleParameters>,
+  signal?: AbortSignal,
+): Promise<UserRoleResponse> {
+  const request = parser(UserRoleRequest)({
+    type: "userRole",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,101 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request multi-sig signers for a user.
+ * @see null
+ */
+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."),
+  );
+})();
+export type UserToMultiSigSignersRequest = v.InferOutput<typeof UserToMultiSigSignersRequest>;
+
+/**
+ * Multi-sig signers for a user or null if the user does not have any multi-sig signers.
+ * @see null
+ */
+export const UserToMultiSigSignersResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.nullable(
+      v.object({
+        /** Authorized users addresses. */
+        authorizedUsers: v.pipe(
+          v.array(Address),
+          v.minLength(1),
+          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."),
+  );
+})();
+export type UserToMultiSigSignersResponse = v.InferOutput<typeof UserToMultiSigSignersResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userToMultiSigSigners} function. */
+export type UserToMultiSigSignersParameters = Omit<v.InferInput<typeof UserToMultiSigSignersRequest>, "type">;
+
+/**
+ * Request multi-sig signers for a user.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Multi-sig signers for a user or null if the user does not have any multi-sig signers.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userToMultiSigSigners } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userToMultiSigSigners(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userToMultiSigSigners(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserToMultiSigSignersParameters>,
+  signal?: AbortSignal,
+): Promise<UserToMultiSigSignersResponse | null> {
+  const request = parser(UserToMultiSigSignersRequest)({
+    type: "userToMultiSigSigners",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,101 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedInteger } from "../_base.js";
+import { TwapFillSchema } from "../_common_schemas.js";
+
+/**
+ * Request user TWAP slice fills.
+ * @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."),
+  );
+})();
+export type UserTwapSliceFillsRequest = v.InferOutput<typeof UserTwapSliceFillsRequest>;
+
+/**
+ * Array of user's twap slice fill.
+ * @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(
+      /** User twap slice fill. */
+      v.pipe(
+        v.object({
+          /** Fill details for the TWAP slice. */
+          fill: TwapFillSchema,
+          /** ID of the TWAP. */
+          twapId: v.pipe(
+            UnsignedInteger,
+            v.description("ID of the TWAP."),
+          ),
+        }),
+        v.description("User twap slice fill."),
+      ),
+    ),
+    v.description("Array of user's twap slice fill."),
+  );
+})();
+export type UserTwapSliceFillsResponse = v.InferOutput<typeof UserTwapSliceFillsResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userTwapSliceFills} function. */
+export type UserTwapSliceFillsParameters = Omit<v.InferInput<typeof UserTwapSliceFillsRequest>, "type">;
+
+/**
+ * Request user TWAP slice fills.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user's twap slice fill.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userTwapSliceFills } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userTwapSliceFills(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userTwapSliceFills(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserTwapSliceFillsParameters>,
+  signal?: AbortSignal,
+): Promise<UserTwapSliceFillsResponse> {
+  const request = parser(UserTwapSliceFillsRequest)({
+    type: "userTwapSliceFills",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,116 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedInteger } from "../_base.js";
+import { TwapFillSchema } from "../_common_schemas.js";
+
+/**
+ * Request user TWAP slice fills by time.
+ * @see null
+ */
+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."),
+  );
+})();
+export type UserTwapSliceFillsByTimeRequest = v.InferOutput<typeof UserTwapSliceFillsByTimeRequest>;
+
+/**
+ * Array of user's twap slice fill by time.
+ * @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(
+    v.array(
+      /** User twap slice fill. */
+      v.pipe(
+        v.object({
+          /** Fill details for the TWAP slice. */
+          fill: TwapFillSchema,
+          /** ID of the TWAP. */
+          twapId: v.pipe(
+            UnsignedInteger,
+            v.description("ID of the TWAP."),
+          ),
+        }),
+        v.description("User twap slice fill."),
+      ),
+    ),
+    v.description("Array of user's twap slice fill by time."),
+  );
+})();
+export type UserTwapSliceFillsByTimeResponse = v.InferOutput<typeof UserTwapSliceFillsByTimeResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userTwapSliceFillsByTime} function. */
+export type UserTwapSliceFillsByTimeParameters = Omit<v.InferInput<typeof UserTwapSliceFillsByTimeRequest>, "type">;
+
+/**
+ * Request user TWAP slice fills by time.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user's twap slice fill by time.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userTwapSliceFillsByTime } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userTwapSliceFillsByTime(
+ *   { transport },
+ *   { user: "0x...", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function userTwapSliceFillsByTime(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserTwapSliceFillsByTimeParameters>,
+  signal?: AbortSignal,
+): Promise<UserTwapSliceFillsByTimeResponse> {
+  const request = parser(UserTwapSliceFillsByTimeRequest)({
+    type: "userTwapSliceFillsByTime",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,108 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request user vault deposits.
+ * @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."),
+  );
+})();
+export type UserVaultEquitiesRequest = v.InferOutput<typeof UserVaultEquitiesRequest>;
+
+/**
+ * Array of user's vault deposits.
+ * @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(
+      /** 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.description("Array of user's vault deposits."),
+  );
+})();
+export type UserVaultEquitiesResponse = v.InferOutput<typeof UserVaultEquitiesResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode userVaultEquities} function. */
+export type UserVaultEquitiesParameters = Omit<v.InferInput<typeof UserVaultEquitiesRequest>, "type">;
+
+/**
+ * Request user vault deposits.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of user's vault deposits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { userVaultEquities } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await userVaultEquities(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function userVaultEquities(
+  config: InfoRequestConfig,
+  params: DeepImmutable<UserVaultEquitiesParameters>,
+  signal?: AbortSignal,
+): Promise<UserVaultEquitiesResponse> {
+  const request = parser(UserVaultEquitiesRequest)({
+    type: "userVaultEquities",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,101 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, Integer } from "../_base.js";
+
+/**
+ * Request validator L1 votes.
+ * @see null
+ */
+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."),
+  );
+})();
+export type ValidatorL1VotesRequest = v.InferOutput<typeof ValidatorL1VotesRequest>;
+
+/**
+ * Array of L1 governance votes cast by validators.
+ * @see null
+ */
+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.description("Array of L1 governance votes cast by validators."),
+  );
+})();
+export type ValidatorL1VotesResponse = v.InferOutput<typeof ValidatorL1VotesResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/**
+ * Request validator L1 votes.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of L1 governance votes cast by validators.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { validatorL1Votes } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await validatorL1Votes({ transport });
+ * ```
+ */
+export function validatorL1Votes(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<ValidatorL1VotesResponse> {
+  const request = parser(ValidatorL1VotesRequest)({
+    type: "validatorL1Votes",
+  });
+  return config.transport.request("info", request, signal);
+}