@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/src/src/api/exchange/~mod.ts

@@ -0,0 +1,88 @@
+/**
+ * This module re-exports all exchange-related API request functions and types.
+ *
+ * You can use raw functions to maximize tree-shaking in your app,
+ * or to access [valibot](https://github.com/fabian-hiller/valibot) schemas Request/Response.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ * import { order } from "@nktkas/hyperliquid/api/exchange";
+ * //       ^^^^^
+ * //       same name as in `ExchangeClient`
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const data = await order(
+ *   { transport, wallet }, // same params as in `ExchangeClient` or `MultiSignClient`
+ *   {
+ *     orders: [
+ *       {
+ *         a: 0,
+ *         b: true,
+ *         p: "30000",
+ *         s: "0.1",
+ *         r: false,
+ *         t: { limit: { tif: "Gtc" } },
+ *         c: "0x...",
+ *       },
+ *     ],
+ *     grouping: "na",
+ *   },
+ * );
+ * ```
+ *
+ * @module
+ */
+
+export { parser, SchemaError } from "../_base.js";
+export { ApiRequestError, type ExchangeRequestConfig, type MultiSignRequestConfig } from "./_base/mod.js";
+
+export * from "./agentEnableDexAbstraction.js";
+export * from "./approveAgent.js";
+export * from "./approveBuilderFee.js";
+export * from "./batchModify.js";
+export * from "./cancel.js";
+export * from "./cancelByCloid.js";
+export * from "./cDeposit.js";
+export * from "./claimRewards.js";
+export * from "./convertToMultiSigUser.js";
+export * from "./createSubAccount.js";
+export * from "./createVault.js";
+export * from "./cSignerAction.js";
+export * from "./cValidatorAction.js";
+export * from "./cWithdraw.js";
+export * from "./evmUserModify.js";
+export * from "./linkStakingUser.js";
+export * from "./modify.js";
+export * from "./multiSig.js";
+export * from "./order.js";
+export * from "./noop.js";
+export * from "./perpDeploy.js";
+export * from "./registerReferrer.js";
+export * from "./reserveRequestWeight.js";
+export * from "./scheduleCancel.js";
+export * from "./sendAsset.js";
+export * from "./setDisplayName.js";
+export * from "./setReferrer.js";
+export * from "./spotDeploy.js";
+export * from "./spotSend.js";
+export * from "./spotUser.js";
+export * from "./subAccountModify.js";
+export * from "./subAccountSpotTransfer.js";
+export * from "./subAccountTransfer.js";
+export * from "./tokenDelegate.js";
+export * from "./twapCancel.js";
+export * from "./twapOrder.js";
+export * from "./updateIsolatedMargin.js";
+export * from "./updateLeverage.js";
+export * from "./usdClassTransfer.js";
+export * from "./usdSend.js";
+export * from "./userDexAbstraction.js";
+export * from "./validatorL1Stream.js";
+export * from "./vaultDistribute.js";
+export * from "./vaultModify.js";
+export * from "./vaultTransfer.js";
+export * from "./withdraw3.js";

package/src/src/api/info/_types.ts

@@ -0,0 +1,7 @@
+import type { IRequestTransport } from "../../transport/base.js";
+
+/** Configuration for Info API requests. */
+export interface InfoRequestConfig<T extends IRequestTransport = IRequestTransport> {
+  /** The transport used to connect to the Hyperliquid API. */
+  transport: T;
+}

package/src/src/api/info/activeAssetData.ts

@@ -0,0 +1,154 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { Address, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request user active asset data.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+ */
+export const ActiveAssetDataRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("activeAssetData"),
+        v.description("Type of request."),
+      ),
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user active asset data."),
+  );
+})();
+export type ActiveAssetDataRequest = v.InferOutput<typeof ActiveAssetDataRequest>;
+
+/**
+ * User active asset data.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+ */
+export const ActiveAssetDataResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Leverage configuration. */
+      leverage: v.pipe(
+        v.variant("type", [
+          v.object({
+            /** Leverage type. */
+            type: v.pipe(
+              v.literal("isolated"),
+              v.description("Leverage type."),
+            ),
+            /** Leverage value used. */
+            value: v.pipe(
+              UnsignedInteger,
+              v.minValue(1),
+              v.description("Leverage value used."),
+            ),
+            /** Amount of USD used (1 = $1). */
+            rawUsd: v.pipe(
+              UnsignedDecimal,
+              v.description("Amount of USD used (1 = $1)."),
+            ),
+          }),
+          v.object({
+            /** Leverage type. */
+            type: v.pipe(
+              v.literal("cross"),
+              v.description("Leverage type."),
+            ),
+            /** Leverage value used. */
+            value: v.pipe(
+              UnsignedInteger,
+              v.minValue(1),
+              v.description("Leverage value used."),
+            ),
+          }),
+        ]),
+        v.description("Leverage configuration."),
+      ),
+      /** Maximum trade size range [min, max]. */
+      maxTradeSzs: v.pipe(
+        v.tuple([UnsignedDecimal, UnsignedDecimal]),
+        v.description("Maximum trade size range [min, max]."),
+      ),
+      /** Available to trade range [min, max]. */
+      availableToTrade: v.pipe(
+        v.tuple([UnsignedDecimal, UnsignedDecimal]),
+        v.description("Available to trade range [min, max]."),
+      ),
+      /** Mark price. */
+      markPx: v.pipe(
+        UnsignedDecimal,
+        v.description("Mark price."),
+      ),
+    }),
+    v.description("User active asset data."),
+  );
+})();
+export type ActiveAssetDataResponse = v.InferOutput<typeof ActiveAssetDataResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode activeAssetData} function. */
+export type ActiveAssetDataParameters = Omit<v.InferInput<typeof ActiveAssetDataRequest>, "type">;
+
+/**
+ * Request user active asset data.
+ * @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 active asset data.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-users-active-asset-data
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { activeAssetData } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await activeAssetData(
+ *   { transport },
+ *   { user: "0x...", coin: "ETH" },
+ * );
+ * ```
+ */
+export function activeAssetData(
+  config: InfoRequestConfig,
+  params: DeepImmutable<ActiveAssetDataParameters>,
+  signal?: AbortSignal,
+): Promise<ActiveAssetDataResponse> {
+  const request = parser(ActiveAssetDataRequest)({
+    type: "activeAssetData",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,128 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedDecimal, UnsignedInteger } from "../_base.js";
+
+/**
+ * Request supply, rate, and pending payment information for an aligned quote token.
+ * @see null
+ */
+export const AlignedQuoteTokenInfoRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("alignedQuoteTokenInfo"),
+        v.description("Type of request."),
+      ),
+      /** Token index. */
+      token: v.pipe(
+        UnsignedInteger,
+        v.description("Token index."),
+      ),
+    }),
+    v.description("Request supply, rate, and pending payment information for an aligned quote token."),
+  );
+})();
+export type AlignedQuoteTokenInfoRequest = v.InferOutput<typeof AlignedQuoteTokenInfoRequest>;
+
+/**
+ * Supply, rate, and pending payment information for an aligned quote token.
+ * @see null
+ */
+export const AlignedQuoteTokenInfoResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Whether the token is aligned. */
+      isAligned: v.pipe(
+        v.boolean(),
+        v.description("Whether the token is aligned."),
+      ),
+      /** Timestamp (in ms since epoch) when the token was first aligned. */
+      firstAlignedTime: v.pipe(
+        UnsignedInteger,
+        v.description("Timestamp (in ms since epoch) when the token was first aligned."),
+      ),
+      /** Total EVM minted supply. */
+      evmMintedSupply: v.pipe(
+        UnsignedDecimal,
+        v.description("Total EVM minted supply."),
+      ),
+      /** Daily amount owed as an array of [date, amount] tuples. */
+      dailyAmountOwed: v.pipe(
+        v.array(
+          v.pipe(
+            v.tuple([
+              /** Date in YYYY-MM-DD format. */
+              v.pipe(
+                v.string(),
+                v.description("Date in YYYY-MM-DD format."),
+              ),
+              /** Amount owed. */
+              v.pipe(
+                UnsignedDecimal,
+                v.description("Amount owed."),
+              ),
+            ]),
+            v.description("[date, amount] tuple."),
+          ),
+        ),
+        v.description("Daily amount owed as an array of [date, amount] tuples."),
+      ),
+      /** Predicted rate. */
+      predictedRate: v.pipe(
+        UnsignedDecimal,
+        v.description("Predicted rate."),
+      ),
+    }),
+    v.description("Supply, rate, and pending payment information for an aligned quote token."),
+  );
+})();
+export type AlignedQuoteTokenInfoResponse = v.InferOutput<typeof AlignedQuoteTokenInfoResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_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 - 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 Supply, rate, and pending payment information for an aligned quote token.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @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 },
+ * );
+ * ```
+ */
+export function alignedQuoteTokenInfo(
+  config: InfoRequestConfig,
+  params: DeepImmutable<AlignedQuoteTokenInfoParameters>,
+  signal?: AbortSignal,
+): Promise<AlignedQuoteTokenInfoResponse> {
+  const request = parser(AlignedQuoteTokenInfoRequest)({
+    type: "alignedQuoteTokenInfo",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,95 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { UnsignedDecimal } from "../_base.js";
+
+/**
+ * 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.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("allMids"),
+        v.description("Type of request."),
+      ),
+      /** DEX name (empty string for main dex). */
+      dex: v.pipe(
+        v.optional(v.string()),
+        v.description("DEX name (empty string for main dex)."),
+      ),
+    }),
+    v.description("Request mid coin prices."),
+  );
+})();
+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 const AllMidsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.record(v.string(), UnsignedDecimal),
+    v.description("Mapping of coin symbols to mid prices."),
+  );
+})();
+export type AllMidsResponse = v.InferOutput<typeof AllMidsResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { type DeepImmutable, parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_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 - 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 Mapping of coin symbols to mid prices.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins
+ * @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 });
+ * ```
+ */
+export function allMids(
+  config: InfoRequestConfig,
+  params?: DeepImmutable<AllMidsParameters>,
+  signal?: AbortSignal,
+): Promise<AllMidsResponse>;
+export function allMids(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<AllMidsResponse>;
+export function allMids(
+  config: InfoRequestConfig,
+  paramsOrSignal?: DeepImmutable<AllMidsParameters> | AbortSignal,
+  maybeSignal?: AbortSignal,
+): Promise<AllMidsResponse> {
+  const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
+  const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
+
+  const request = parser(AllMidsRequest)({
+    type: "allMids",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

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

@@ -0,0 +1,75 @@
+import * as v from "valibot";
+
+// ============================================================
+// API Schemas
+// ============================================================
+
+import { MetaResponse } from "./meta.js";
+
+/**
+ * Request trading metadata for all DEXes.
+ * @see null
+ */
+export const AllPerpMetasRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("allPerpMetas"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request trading metadata for all DEXes."),
+  );
+})();
+export type AllPerpMetasRequest = v.InferOutput<typeof AllPerpMetasRequest>;
+
+/**
+ * Metadata for perpetual assets across all DEXes.
+ * @see null
+ */
+export const AllPerpMetasResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(MetaResponse),
+    v.description("Metadata for perpetual assets across all DEXes."),
+  );
+})();
+export type AllPerpMetasResponse = v.InferOutput<typeof AllPerpMetasResponse>;
+
+// ============================================================
+// Execution Logic
+// ============================================================
+
+import { parser } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+
+/** Request parameters for the {@linkcode allPerpMetas} function. */
+export type AllPerpMetasParameters = Omit<v.InferInput<typeof AllPerpMetasRequest>, "type">;
+
+/**
+ * Request trading metadata for all DEXes.
+ * @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 Metadata for perpetual assets across all DEXes.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @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 });
+ * ```
+ */
+export function allPerpMetas(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<AllPerpMetasResponse> {
+  const request = parser(AllPerpMetasRequest)({
+    type: "allPerpMetas",
+  });
+  return config.transport.request("info", request, signal);
+}