@nktkas/hyperliquid 0.30.3 → 0.32.0

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

@@ -0,0 +1,97 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedInteger } from "../../_schemas.js";
+
+/**
+ * Request supply, rate, and pending payment information for an aligned quote token.
+ * @see null
+ */
+export const AlignedQuoteTokenInfoRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("alignedQuoteTokenInfo"),
+    /** Token index. */
+    token: UnsignedInteger,
+  });
+})();
+export type AlignedQuoteTokenInfoRequest = v.InferOutput<typeof AlignedQuoteTokenInfoRequest>;
+
+/**
+ * Supply, rate, and pending payment information for an aligned quote token.
+ * @see null
+ */
+export type AlignedQuoteTokenInfoResponse = {
+  /** Whether the token is aligned. */
+  isAligned: boolean;
+  /** Timestamp (in ms since epoch) when the token was first aligned. */
+  firstAlignedTime: number;
+  /**
+   * Total EVM minted supply.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  evmMintedSupply: string;
+  /** Daily amount owed as an array of [date, amount] tuples. */
+  dailyAmountOwed: [
+    /** Date in YYYY-MM-DD format. */
+    date: string,
+    /** @pattern ^[0-9]+(\.[0-9]+)?$ */
+    amount: string,
+  ][];
+  /**
+   * Predicted rate.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  predictedRate: string;
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode alignedQuoteTokenInfo} function. */
+export type AlignedQuoteTokenInfoParameters = Omit<v.InferInput<typeof AlignedQuoteTokenInfoRequest>, "type">;
+
+/**
+ * Request supply, rate, and pending payment information for an aligned quote token.
+ *
+ * @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 Supply, rate, and pending payment information for an aligned quote 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 { alignedQuoteTokenInfo } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await alignedQuoteTokenInfo(
+ *   { transport },
+ *   { token: 1328 },
+ * );
+ * ```
+ *
+ * @see null
+ */
+export function alignedQuoteTokenInfo(
+  config: InfoConfig,
+  params: AlignedQuoteTokenInfoParameters,
+  signal?: AbortSignal,
+): Promise<AlignedQuoteTokenInfoResponse> {
+  const request = parse(AlignedQuoteTokenInfoRequest, {
+    type: "alignedQuoteTokenInfo",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,64 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import type { BorrowLendReserveStateResponse } from "./borrowLendReserveState.js";
+
+/**
+ * Request all borrow/lend reserve states.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-all-borrow-lend-reserve-states
+ */
+export const AllBorrowLendReserveStatesRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("allBorrowLendReserveStates"),
+  });
+})();
+export type AllBorrowLendReserveStatesRequest = v.InferOutput<typeof AllBorrowLendReserveStatesRequest>;
+
+/**
+ * Array of tuples of reserve IDs and their borrow/lend reserve state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-all-borrow-lend-reserve-states
+ */
+export type AllBorrowLendReserveStatesResponse = [reserveId: number, state: BorrowLendReserveStateResponse][];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/**
+ * Request all borrow/lend reserve states.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Array of tuples of reserve IDs and their borrow/lend reserve 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 { allBorrowLendReserveStates } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await allBorrowLendReserveStates({ transport });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-all-borrow-lend-reserve-states
+ */
+export function allBorrowLendReserveStates(
+  config: InfoConfig,
+  signal?: AbortSignal,
+): Promise<AllBorrowLendReserveStatesResponse> {
+  const request = parse(AllBorrowLendReserveStatesRequest, {
+    type: "allBorrowLendReserveStates",
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,85 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+/**
+ * Request mid coin prices.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ */
+export const AllMidsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("allMids"),
+    /** DEX name (empty string for main dex). */
+    dex: v.optional(v.string()),
+  });
+})();
+export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
+
+/**
+ * Mapping of coin symbols to mid prices.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ */
+export type AllMidsResponse = {
+  /** @pattern ^[0-9]+(\.[0-9]+)?$ */
+  [x: string]: string;
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode allMids} function. */
+export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
+
+/**
+ * Request mid coin prices.
+ *
+ * @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 Mapping of coin symbols to mid prices.
+ *
+ * @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 { allMids } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await allMids({ transport });
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ */
+export function allMids(
+  config: InfoConfig,
+  params?: AllMidsParameters,
+  signal?: AbortSignal,
+): Promise<AllMidsResponse>;
+export function allMids(
+  config: InfoConfig,
+  signal?: AbortSignal,
+): Promise<AllMidsResponse>;
+export function allMids(
+  config: InfoConfig,
+  paramsOrSignal?: AllMidsParameters | AbortSignal,
+  maybeSignal?: AbortSignal,
+): Promise<AllMidsResponse> {
+  const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
+  const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
+
+  const request = parse(AllMidsRequest, {
+    type: "allMids",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,64 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import type { MetaResponse } from "./meta.js";
+
+/**
+ * Request trading metadata for all DEXes.
+ * @see null
+ */
+export const AllPerpMetasRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("allPerpMetas"),
+  });
+})();
+export type AllPerpMetasRequest = v.InferOutput<typeof AllPerpMetasRequest>;
+
+/**
+ * Metadata for perpetual assets across all DEXes.
+ * @see null
+ */
+export type AllPerpMetasResponse = MetaResponse[];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/**
+ * Request trading metadata for all DEXes.
+ *
+ * @param config General configuration for Info API requests.
+ * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
+ * @return Metadata for perpetual assets across all DEXes.
+ *
+ * @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 { allPerpMetas } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await allPerpMetas({ transport });
+ * ```
+ *
+ * @see null
+ */
+export function allPerpMetas(
+  config: InfoConfig,
+  signal?: AbortSignal,
+): Promise<AllPerpMetasResponse> {
+  const request = parse(AllPerpMetasRequest, {
+    type: "allPerpMetas",
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,75 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address } from "../../_schemas.js";
+
+/**
+ * Request approved builders for a user.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-approved-builders-for-user
+ */
+export const ApprovedBuildersRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("approvedBuilders"),
+    /** User address. */
+    user: Address,
+  });
+})();
+export type ApprovedBuildersRequest = v.InferOutput<typeof ApprovedBuildersRequest>;
+
+/**
+ * Array of approved builder addresses.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-approved-builders-for-user
+ */
+export type ApprovedBuildersResponse = `0x${string}`[];
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode approvedBuilders} function. */
+export type ApprovedBuildersParameters = Omit<v.InferInput<typeof ApprovedBuildersRequest>, "type">;
+
+/**
+ * Request approved builders 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.
+ * @return Array of approved builder addresses.
+ *
+ * @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 { approvedBuilders } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await approvedBuilders(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-approved-builders-for-user
+ */
+export function approvedBuilders(
+  config: InfoConfig,
+  params: ApprovedBuildersParameters,
+  signal?: AbortSignal,
+): Promise<ApprovedBuildersResponse> {
+  const request = parse(ApprovedBuildersRequest, {
+    type: "approvedBuilders",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,99 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedInteger } from "../../_schemas.js";
+import type { ExplorerTransactionSchema } from "./_base/commonSchemas.js";
+
+/**
+ * Request block details by block height.
+ * @see null
+ */
+export const BlockDetailsRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("blockDetails"),
+    /** Block height. */
+    height: UnsignedInteger,
+  });
+})();
+export type BlockDetailsRequest = v.InferOutput<typeof BlockDetailsRequest>;
+
+/**
+ * Response containing block information.
+ * @see null
+ */
+export type BlockDetailsResponse = {
+  /** Type of response. */
+  type: "blockDetails";
+  /** The details of a block. */
+  blockDetails: {
+    /** Block creation timestamp. */
+    blockTime: number;
+    /**
+     * Block hash.
+     * @pattern ^0x[a-fA-F0-9]{64}$
+     */
+    hash: `0x${string}`;
+    /** Block height in chain. */
+    height: number;
+    /** Total transactions in block. */
+    numTxs: number;
+    /**
+     * Block proposer address.
+     * @pattern ^0x[a-fA-F0-9]{40}$
+     */
+    proposer: `0x${string}`;
+    /** Array of transactions in the block. */
+    txs: ExplorerTransactionSchema[];
+  };
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode blockDetails} function. */
+export type BlockDetailsParameters = Omit<v.InferInput<typeof BlockDetailsRequest>, "type">;
+
+/**
+ * Request block details by block height.
+ *
+ * @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 Response containing block information.
+ *
+ * @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 { blockDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // only `HttpTransport` supports this API
+ * const data = await blockDetails(
+ *   { transport },
+ *   { height: 123 },
+ * );
+ * ```
+ *
+ * @see null
+ */
+export function blockDetails(
+  config: InfoConfig,
+  params: BlockDetailsParameters,
+  signal?: AbortSignal,
+): Promise<BlockDetailsResponse> {
+  const request = parse(BlockDetailsRequest, {
+    type: "blockDetails",
+    ...params,
+  });
+  return config.transport.request("explorer", request, signal);
+}

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

@@ -0,0 +1,116 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedInteger } from "../../_schemas.js";
+
+/**
+ * Request borrow/lend reserve states.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-reserve-state
+ */
+export const BorrowLendReserveStateRequest = /* @__PURE__ */ (() => {
+  return v.object({
+    /** Type of request. */
+    type: v.literal("borrowLendReserveState"),
+    /** Token index. */
+    token: UnsignedInteger,
+  });
+})();
+export type BorrowLendReserveStateRequest = v.InferOutput<typeof BorrowLendReserveStateRequest>;
+
+/**
+ * Borrow/lend reserve state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-reserve-state
+ */
+export type BorrowLendReserveStateResponse = {
+  /**
+   * Borrow interest rate (yearly).
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  borrowYearlyRate: string;
+  /**
+   * Supply interest rate (yearly).
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  supplyYearlyRate: string;
+  /**
+   * Reserve balance.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  balance: string;
+  /**
+   * Reserve utilization ratio.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  utilization: string;
+  /**
+   * Oracle price.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  oraclePx: string;
+  /**
+   * Loan-to-value (LTV) ratio.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  ltv: string;
+  /**
+   * Total supplied amount.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  totalSupplied: string;
+  /**
+   * Total borrowed amount.
+   * @pattern ^[0-9]+(\.[0-9]+)?$
+   */
+  totalBorrowed: string;
+};
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parse } from "../../../_base.js";
+import type { InfoConfig } from "./_base/types.js";
+
+/** Request parameters for the {@linkcode borrowLendReserveState} function. */
+export type BorrowLendReserveStateParameters = Omit<v.InferInput<typeof BorrowLendReserveStateRequest>, "type">;
+
+/**
+ * Request borrow/lend reserve 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 Borrow/lend reserve 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 { borrowLendReserveState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await borrowLendReserveState(
+ *   { transport },
+ *   { token: 0 },
+ * );
+ * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-borrow-lend-reserve-state
+ */
+export function borrowLendReserveState(
+  config: InfoConfig,
+  params: BorrowLendReserveStateParameters,
+  signal?: AbortSignal,
+): Promise<BorrowLendReserveStateResponse> {
+  const request = parse(BorrowLendReserveStateRequest, {
+    type: "borrowLendReserveState",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}