@hfunlabs/hyperliquid 0.30.2-hfunlabs.2 → 0.32.2-hfunlabs.3

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

@@ -0,0 +1,164 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Hex } from "../../_schemas.js";
+
+/**
+ * Request token details.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export const TokenDetailsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("tokenDetails"),
+    /** Token ID. */
+    tokenId: v.pipe(Hex, v.length(34)),
+  });
+})();
+export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
+
+/**
+ * Details of a token.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export type TokenDetailsResponse = {
+  /** Name of the token. */
+  name: string;
+  /**
+   * Maximum supply of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  maxSupply: string;
+  /**
+   * Total supply of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  totalSupply: string;
+  /**
+   * Circulating supply of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  circulatingSupply: string;
+  /** Decimal places for the minimum tradable unit. */
+  szDecimals: number;
+  /** Decimal places for the token's smallest unit. */
+  weiDecimals: number;
+  /**
+   * Mid price of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  midPx: string;
+  /**
+   * Mark price of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  markPx: string;
+  /**
+   * Previous day's price of the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  prevDayPx: string;
+  /** Genesis data for the token. */
+  genesis: {
+    /** User balances. */
+    userBalances: [
+      /** @pattern ^0x[a-fA-F0-9]{40}$ */
+      address: `0x${string}`,
+      /** @pattern ^[0-9]+(\.[0-9]+)?$ */
+      balance: string,
+    ][];
+    /** Existing token balances. */
+    existingTokenBalances: [
+      token: number,
+      /** @pattern ^[0-9]+(\.[0-9]+)?$ */
+      balance: string,
+    ][];
+    /**
+     * Blacklisted users.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    blacklistUsers: `0x${string}`[];
+  } | null;
+  /**
+   * Deployer address.
+   * @pattern ^0x[a-fA-F0-9]{40}$
+   */
+  deployer: `0x${string}` | null;
+  /**
+   * Gas used during token deployment.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  deployGas: string | null;
+  /**
+   * Timestamp of token deployment.
+   * @pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}$
+   */
+  deployTime: string | null;
+  /**
+   * Seeded USDC amount for the token.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  seededUsdc: string;
+  /** Non-circulating user balances of the token. */
+  nonCirculatingUserBalances: [
+    /** @pattern ^0x[a-fA-F0-9]{40}$ */
+    address: `0x${string}`,
+    /** @pattern ^[0-9]+(\.[0-9]+)?$ */
+    balance: string,
+  ][];
+  /**
+   * Future emissions amount.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  futureEmissions: string;
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode tokenDetails} function. */
+export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsRequest>, "type">;
+
+/**
+ * Request token details.
+ *
+ * @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.
+ * @return Details of a token.
+ *
+ * @throws {ValidationError} 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 { tokenDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await tokenDetails({ transport }, {
+ *   tokenId: "0x...",
+ * });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export function tokenDetails(
+  config: InfoConfig,
+  params: TokenDetailsParameters,
+  signal?: AbortSignal,
+): Promise<TokenDetailsResponse> {
+  const request = parse(TokenDetailsRequest, {
+    type: "tokenDetails",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,98 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../../_schemas.js";
+import type { TwapStateSchema } from "./_base/commonSchemas.js";
+
+/**
+ * Request TWAP history of a user.
+ * @see null
+ */
+export const TwapHistoryRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("twapHistory"),
+    /** User address. */
+    user: Address,
+  });
+})();
+export type TwapHistoryRequest = v.InferOutput<typeof TwapHistoryRequest>;
+
+/**
+ * Array of user's TWAP history.
+ * @see null
+ */
+export type TwapHistoryResponse = {
+  /** Creation time of the history record (in seconds since epoch). */
+  time: number;
+  /** State of the TWAP order. */
+  state: TwapStateSchema;
+  /**
+   * Current status of the TWAP order.
+   * - `"finished"`: Fully executed.
+   * - `"activated"`: Active and executing.
+   * - `"terminated"`: Terminated.
+   * - `"error"`: An error occurred.
+   */
+  status: {
+    /** Status of the TWAP order. */
+    status: "finished" | "activated" | "terminated";
+  } | {
+    /** Status of the TWAP order. */
+    status: "error";
+    /** Error message. */
+    description: string;
+  };
+  /** ID of the TWAP. */
+  twapId?: number;
+}[];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode twapHistory} function. */
+export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>, "type">;
+
+/**
+ * Request TWAP history of 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.
+ * @return Array of user's TWAP history.
+ *
+ * @throws {ValidationError} 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 { twapHistory } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await twapHistory({ transport }, {
+ *   user: "0x...",
+ * });
+ * ```
+ *
+ * @see null
+ */
+export function twapHistory(
+  config: InfoConfig,
+  params: TwapHistoryParameters,
+  signal?: AbortSignal,
+): Promise<TwapHistoryResponse> {
+  const request = parse(TwapHistoryRequest, {
+    type: "twapHistory",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,80 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Hex } from "../../_schemas.js";
+import type { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
+
+/**
+ * Request transaction details by transaction hash.
+ * @see null
+ */
+export const TxDetailsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("txDetails"),
+    /** Transaction hash. */
+    hash: v.pipe(Hex, v.length(66)),
+  });
+})();
+export type TxDetailsRequest = v.InferOutput<typeof TxDetailsRequest>;
+
+/**
+ * Response with transaction details.
+ * @see null
+ */
+export type TxDetailsResponse = {
+  /** Response type. */
+  type: "txDetails";
+  /** Transaction details. */
+  tx: ExplorerTransactionSchema;
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode txDetails} function. */
+export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "type">;
+
+/**
+ * Request transaction details by transaction hash.
+ *
+ * @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.
+ * @return Transaction details.
+ *
+ * @throws {ValidationError} 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 { txDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // only `HttpTransport` supports this API
+ *
+ * const data = await txDetails({ transport }, {
+ *   hash: "0x...",
+ * });
+ * ```
+ *
+ * @see null
+ */
+export function txDetails(
+  config: InfoConfig,
+  params: TxDetailsParameters,
+  signal?: AbortSignal,
+): Promise<TxDetailsResponse> {
+  const request = parse(TxDetailsRequest, {
+    type: "txDetails",
+    ...params,
+  });
+  return config.transport.request("explorer", request, signal);
+}

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

@@ -0,0 +1,79 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../../_schemas.js";
+
+/**
+ * Request user abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-abstraction-state
+ */
+export const UserAbstractionRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userAbstraction"),
+    /** User address. */
+    user: Address,
+  });
+})();
+export type UserAbstractionRequest = v.InferOutput<typeof UserAbstractionRequest>;
+
+/**
+ * User abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-abstraction-state
+ */
+export type UserAbstractionResponse =
+  | "unifiedAccount"
+  | "portfolioMargin"
+  | "disabled"
+  | "default"
+  | "dexAbstraction";
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode userAbstraction} function. */
+export type UserAbstractionParameters = Omit<v.InferInput<typeof UserAbstractionRequest>, "type">;
+
+/**
+ * Request user abstraction 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.
+ * @return User abstraction state.
+ *
+ * @throws {ValidationError} 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 { userAbstraction } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-abstraction-state
+ */
+export function userAbstraction(
+  config: InfoConfig,
+  params: UserAbstractionParameters,
+  signal?: AbortSignal,
+): Promise<UserAbstractionResponse> {
+  const request = parse(UserAbstractionRequest, {
+    type: "userAbstraction",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,94 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedInteger } from "../../_schemas.js";
+
+/**
+ * Request user borrow/lend interest.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state
+ */
+export const UserBorrowLendInterestRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userBorrowLendInterest"),
+    /** User address. */
+    user: Address,
+    /** Start time (in ms since epoch). */
+    startTime: UnsignedInteger,
+    /** End time (in ms since epoch). */
+    endTime: v.nullish(UnsignedInteger),
+  });
+})();
+export type UserBorrowLendInterestRequest = v.InferOutput<typeof UserBorrowLendInterestRequest>;
+
+/**
+ * User's borrow/lend interest.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state
+ */
+export type UserBorrowLendInterestResponse = {
+  /** Timestamp of the update (in ms since epoch). */
+  time: number;
+  /** Token symbol. */
+  token: string;
+  /**
+   * Borrow interest amount.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  borrow: string;
+  /**
+   * Supply interest amount.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  supply: string;
+}[];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode userBorrowLendInterest} function. */
+export type UserBorrowLendInterestParameters = Omit<v.InferInput<typeof UserBorrowLendInterestRequest>, "type">;
+
+/**
+ * Request borrow/lend user interest.
+ *
+ * @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.
+ * @return User's borrow/lend interest.
+ *
+ * @throws {ValidationError} 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 { userBorrowLendInterest } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userBorrowLendInterest({ transport }, {
+ *   user: "0x...",
+ *   startTime: Date.now() - 1000 * 60 * 60 * 24,
+ * });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-user-state
+ */
+export function userBorrowLendInterest(
+  config: InfoConfig,
+  params: UserBorrowLendInterestParameters,
+  signal?: AbortSignal,
+): Promise<UserBorrowLendInterestResponse> {
+  const request = parse(UserBorrowLendInterestRequest, {
+    type: "userBorrowLendInterest",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,80 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../../_schemas.js";
+import type { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
+
+/**
+ * Request array of user transaction details.
+ * @see null
+ */
+export const UserDetailsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userDetails"),
+    /** User address. */
+    user: Address,
+  });
+})();
+export type UserDetailsRequest = v.InferOutput<typeof UserDetailsRequest>;
+
+/**
+ * Response array of user transaction details.
+ * @see null
+ */
+export type UserDetailsResponse = {
+  /** Type of response. */
+  type: "userDetails";
+  /** Array of user transaction details. */
+  txs: ExplorerTransactionSchema[];
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode userDetails} function. */
+export type UserDetailsParameters = Omit<v.InferInput<typeof UserDetailsRequest>, "type">;
+
+/**
+ * Request array of user transaction details.
+ *
+ * @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.
+ * @return Array of user transaction details.
+ *
+ * @throws {ValidationError} 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 { userDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // only `HttpTransport` supports this API
+ *
+ * const data = await userDetails({ transport }, {
+ *   user: "0x...",
+ * });
+ * ```
+ *
+ * @see null
+ */
+export function userDetails(
+  config: InfoConfig,
+  params: UserDetailsParameters,
+  signal?: AbortSignal,
+): Promise<UserDetailsResponse> {
+  const request = parse(UserDetailsRequest, {
+    type: "userDetails",
+    ...params,
+  });
+  return config.transport.request("explorer", request, signal);
+}

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

@@ -0,0 +1,74 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../../_schemas.js";
+
+/**
+ * Request user HIP-3 DEX abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ */
+export const UserDexAbstractionRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("userDexAbstraction"),
+    /** User address. */
+    user: Address,
+  });
+})();
+export type UserDexAbstractionRequest = v.InferOutput<typeof UserDexAbstractionRequest>;
+
+/**
+ * User HIP-3 DEX abstraction state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ */
+export type UserDexAbstractionResponse = boolean | null;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode userDexAbstraction} function. */
+export type UserDexAbstractionParameters = Omit<v.InferInput<typeof UserDexAbstractionRequest>, "type">;
+
+/**
+ * Request user HIP-3 DEX abstraction 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.
+ * @return User HIP-3 DEX abstraction state.
+ *
+ * @throws {ValidationError} 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 { userDexAbstraction } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await userDexAbstraction({ transport }, {
+ *   user: "0x...",
+ * });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-hip-3-dex-abstraction-state
+ */
+export function userDexAbstraction(
+  config: InfoConfig,
+  params: UserDexAbstractionParameters,
+  signal?: AbortSignal,
+): Promise<UserDexAbstractionResponse> {
+  const request = parse(UserDexAbstractionRequest, {
+    type: "userDexAbstraction",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}