@nktkas/hyperliquid 0.30.3 → 0.32.0

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

@@ -1,111 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
-
-/**
- * Request user rate limits.
- * @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."),
-  );
-})();
-export type UserRateLimitRequest = v.InferOutput<typeof UserRateLimitRequest>;
-
-/**
- * User rate limits.
- * @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."),
-  );
-})();
-export type UserRateLimitResponse = v.InferOutput<typeof UserRateLimitResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/types.js";
-
-/** Request parameters for the {@linkcode userRateLimit} function. */
-export type UserRateLimitParameters = Omit<v.InferInput<typeof UserRateLimitRequest>, "type">;
-
-/**
- * Request user rate limits.
- *
- * @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 rate limits.
- *
- * @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 { userRateLimit } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await userRateLimit(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits
- */
-export function userRateLimit(
-  config: InfoConfig,
-  params: UserRateLimitParameters,
-  signal?: AbortSignal,
-): Promise<UserRateLimitResponse> {
-  const request = v.parse(UserRateLimitRequest, {
-    type: "userRateLimit",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,134 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address } from "../../_schemas.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.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."),
-        ),
-      }),
-      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 { InfoConfig } from "./_base/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 - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns User role.
- *
- * @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 { userRole } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await userRole(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
- */
-export function userRole(
-  config: InfoConfig,
-  params: UserRoleParameters,
-  signal?: AbortSignal,
-): Promise<UserRoleResponse> {
-  const request = v.parse(UserRoleRequest, {
-    type: "userRole",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,101 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-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."),
-  );
-})();
-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.
- */
-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."),
-  );
-})();
-export type UserToMultiSigSignersResponse = v.InferOutput<typeof UserToMultiSigSignersResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/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 - {@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.
- *
- * @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 { userToMultiSigSigners } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await userToMultiSigSigners(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- */
-export function userToMultiSigSigners(
-  config: InfoConfig,
-  params: UserToMultiSigSignersParameters,
-  signal?: AbortSignal,
-): Promise<UserToMultiSigSignersResponse> {
-  const request = v.parse(UserToMultiSigSignersRequest, {
-    type: "userToMultiSigSigners",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,104 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedInteger } from "../../_schemas.js";
-import { UserFillSchema } from "./_base/commonSchemas.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 fills.
- * @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."),
-  );
-})();
-export type UserTwapSliceFillsResponse = v.InferOutput<typeof UserTwapSliceFillsResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/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 - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Array of user's twap slice fills.
- *
- * @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 { userTwapSliceFills } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await userTwapSliceFills(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-twap-slice-fills
- */
-export function userTwapSliceFills(
-  config: InfoConfig,
-  params: UserTwapSliceFillsParameters,
-  signal?: AbortSignal,
-): Promise<UserTwapSliceFillsResponse> {
-  const request = v.parse(UserTwapSliceFillsRequest, {
-    type: "userTwapSliceFills",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,103 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedInteger } from "../../_schemas.js";
-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."),
-  );
-})();
-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(
-    UserTwapSliceFillsResponse,
-    v.description("Array of user's twap slice fill by time."),
-  );
-})();
-export type UserTwapSliceFillsByTimeResponse = v.InferOutput<typeof UserTwapSliceFillsByTimeResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/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 - {@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.
- *
- * @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 { 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: InfoConfig,
-  params: UserTwapSliceFillsByTimeParameters,
-  signal?: AbortSignal,
-): Promise<UserTwapSliceFillsByTimeResponse> {
-  const request = v.parse(UserTwapSliceFillsByTimeRequest, {
-    type: "userTwapSliceFillsByTime",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}

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

@@ -1,108 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.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(
-      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."),
-  );
-})();
-export type UserVaultEquitiesResponse = v.InferOutput<typeof UserVaultEquitiesResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import type { InfoConfig } from "./_base/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 - {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
- *
- * @returns Array of user's vault deposits.
- *
- * @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 { userVaultEquities } from "@nktkas/hyperliquid/api/info";
- *
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await userVaultEquities(
- *   { transport },
- *   { user: "0x..." },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-vault-deposits
- */
-export function userVaultEquities(
-  config: InfoConfig,
-  params: UserVaultEquitiesParameters,
-  signal?: AbortSignal,
-): Promise<UserVaultEquitiesResponse> {
-  const request = v.parse(UserVaultEquitiesRequest, {
-    type: "userVaultEquities",
-    ...params,
-  });
-  return config.transport.request("info", request, signal);
-}