@nktkas/hyperliquid 0.25.9 → 0.26.0

package/src/api/info/perpDeployAuctionStatus.ts

@@ -0,0 +1,91 @@
+import * as v from "valibot";
+import { parser, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export const PerpDeployAuctionStatusRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("perpDeployAuctionStatus"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request for the status of the perpetual deploy auction."),
+  );
+})();
+export type PerpDeployAuctionStatusRequest = v.InferOutput<typeof PerpDeployAuctionStatusRequest>;
+
+/**
+ * Status of the perpetual deploy auction.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ */
+export const PerpDeployAuctionStatusResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Current gas. */
+      currentGas: v.pipe(
+        v.nullable(UnsignedDecimal),
+        v.description("Current gas."),
+      ),
+      /** Duration in seconds. */
+      durationSeconds: v.pipe(
+        UnsignedInteger,
+        v.description("Duration in seconds."),
+      ),
+      /** Ending gas. */
+      endGas: v.pipe(
+        v.nullable(UnsignedDecimal),
+        v.description("Ending gas."),
+      ),
+      /** Starting gas. */
+      startGas: v.pipe(
+        UnsignedDecimal,
+        v.description("Starting gas."),
+      ),
+      /** Auction start time (seconds since epoch). */
+      startTimeSeconds: v.pipe(
+        UnsignedInteger,
+        v.description("Auction start time (seconds since epoch)."),
+      ),
+    }),
+    v.description("Status of the perpetual deploy auction."),
+  );
+})();
+export type PerpDeployAuctionStatusResponse = v.InferOutput<typeof PerpDeployAuctionStatusResponse>;
+
+// -------------------- Function --------------------
+
+/**
+ * Request for the status of the perpetual deploy auction.
+ * @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 Status of the perpetual deploy auction.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDeployAuctionStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDeployAuctionStatus({ transport });
+ * ```
+ */
+export function perpDeployAuctionStatus(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<PerpDeployAuctionStatusResponse> {
+  const request = parser(PerpDeployAuctionStatusRequest)({
+    type: "perpDeployAuctionStatus",
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/api/info/perpDexLimits.ts

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+import { type DeepImmutable, parser, UnsignedDecimal } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export const PerpDexLimitsRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("perpDexLimits"),
+        v.description("Type of request."),
+      ),
+      /** DEX name (empty string for main dex). */
+      dex: v.pipe(
+        v.string(),
+        v.description("DEX name (empty string for main dex)."),
+      ),
+    }),
+    v.description("Request builder deployed perpetual market limits."),
+  );
+})();
+export type PerpDexLimitsRequest = v.InferOutput<typeof PerpDexLimitsRequest>;
+
+/**
+ * Builder deployed perpetual market limits.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ */
+export const PerpDexLimitsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.nullable(
+      v.object({
+        /** Total open interest cap. */
+        totalOiCap: v.pipe(
+          UnsignedDecimal,
+          v.description("Total open interest cap."),
+        ),
+        /** Open interest size cap per perpetual. */
+        oiSzCapPerPerp: v.pipe(
+          UnsignedDecimal,
+          v.description("Open interest size cap per perpetual."),
+        ),
+        /** Maximum transfer notional amount. */
+        maxTransferNtl: v.pipe(
+          UnsignedDecimal,
+          v.description("Maximum transfer notional amount."),
+        ),
+        /** Coin to open interest cap mapping. */
+        coinToOiCap: v.pipe(
+          v.array(v.tuple([v.string(), UnsignedDecimal])),
+          v.description("Coin to open interest cap mapping."),
+        ),
+      }),
+    ),
+    v.description("Builder deployed perpetual market limits."),
+  );
+})();
+export type PerpDexLimitsResponse = v.InferOutput<typeof PerpDexLimitsResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode perpDexLimits} function. */
+export type PerpDexLimitsParameters = Omit<v.InferInput<typeof PerpDexLimitsRequest>, "type">;
+
+/**
+ * Request builder deployed perpetual market limits.
+ * @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 Builder deployed perpetual market limits.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-builder-deployed-perp-market-limits
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexLimits } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexLimits(
+ *   { transport },
+ *   { dex: "test" },
+ * );
+ * ```
+ */
+export function perpDexLimits(
+  config: InfoRequestConfig,
+  params: DeepImmutable<PerpDexLimitsParameters>,
+  signal?: AbortSignal,
+): Promise<PerpDexLimitsResponse> {
+  const request = parser(PerpDexLimitsRequest)({
+    type: "perpDexLimits",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/api/info/perpDexs.ts

@@ -0,0 +1,124 @@
+import * as v from "valibot";
+import { Address, ISO8601WithoutTimezone, parser, UnsignedDecimal } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request all perpetual dexs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export const PerpDexsRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("perpDexs"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request all perpetual dexs."),
+  );
+})();
+export type PerpDexsRequest = v.InferOutput<typeof PerpDexsRequest>;
+
+/**
+ * Array of perpetual dexes (null is main dex).
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ */
+export const PerpDexsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      v.nullable(
+        /** Perpetual dex metadata. */
+        v.pipe(
+          v.object({
+            /** Short name of the perpetual dex. */
+            name: v.pipe(
+              v.string(),
+              v.description("Short name of the perpetual dex."),
+            ),
+            /** Complete name of the perpetual dex. */
+            fullName: v.pipe(
+              v.string(),
+              v.description("Complete name of the perpetual dex."),
+            ),
+            /** Hex address of the dex deployer. */
+            deployer: v.pipe(
+              Address,
+              v.description("Hex address of the dex deployer."),
+            ),
+            /** Hex address of the oracle updater, or null if not available. */
+            oracleUpdater: v.pipe(
+              v.nullable(Address),
+              v.description("Hex address of the oracle updater, or null if not available."),
+            ),
+            /** Hex address of the fee recipient, or null if not available. */
+            feeRecipient: v.pipe(
+              v.nullable(Address),
+              v.description("Hex address of the fee recipient, or null if not available."),
+            ),
+            /** Mapping of asset names to their streaming open interest caps. */
+            assetToStreamingOiCap: v.pipe(
+              v.array(v.tuple([v.string(), v.string()])),
+              v.description("Mapping of asset names to their streaming open interest caps."),
+            ),
+            /** List of delegated function names and their authorized executor addresses. */
+            subDeployers: v.pipe(
+              v.array(
+                v.tuple([
+                  v.string(),
+                  v.array(Address),
+                ]),
+              ),
+              v.description("List of delegated function names and their authorized executor addresses."),
+            ),
+            /** Fee scale applied to deployer fees. */
+            deployerFeeScale: v.pipe(
+              UnsignedDecimal,
+              v.description("Fee scale applied to deployer fees."),
+            ),
+            /** ISO 8601 timestamp (without timezone) of the last deployer fee scale change. */
+            lastDeployerFeeScaleChangeTime: v.pipe(
+              ISO8601WithoutTimezone,
+              v.description("ISO 8601 timestamp (without timezone) of the last deployer fee scale change."),
+            ),
+          }),
+          v.description(" Perpetual dex metadata."),
+        ),
+      ),
+    ),
+    v.description("Array of perpetual dexes (null is main dex)."),
+  );
+})();
+export type PerpDexsResponse = v.InferOutput<typeof PerpDexsResponse>;
+
+// -------------------- Function --------------------
+
+/**
+ * Request all perpetual dexs.
+ * @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 perpetual dexes (null is main dex).
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpDexs } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpDexs({ transport });
+ * ```
+ */
+export function perpDexs(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<PerpDexsResponse> {
+  const request = parser(PerpDexsRequest)({
+    type: "perpDexs",
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/api/info/perpsAtOpenInterestCap.ts

@@ -0,0 +1,88 @@
+import * as v from "valibot";
+import { type DeepImmutable, parser } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request perpetuals at open interest cap.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ */
+export const PerpsAtOpenInterestCapRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("perpsAtOpenInterestCap"),
+        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 perpetuals at open interest cap."),
+  );
+})();
+export type PerpsAtOpenInterestCapRequest = v.InferOutput<typeof PerpsAtOpenInterestCapRequest>;
+
+/**
+ * Array of perpetuals at open interest caps.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ */
+export const PerpsAtOpenInterestCapResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(v.string()),
+    v.description("Array of perpetuals at open interest caps."),
+  );
+})();
+export type PerpsAtOpenInterestCapResponse = v.InferOutput<typeof PerpsAtOpenInterestCapResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode perpsAtOpenInterestCap} function. */
+export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtOpenInterestCapRequest>, "type">;
+
+/**
+ * Request perpetuals at open interest cap.
+ * @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 perpetuals at open interest caps.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { perpsAtOpenInterestCap } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await perpsAtOpenInterestCap({ transport });
+ * ```
+ */
+export function perpsAtOpenInterestCap(
+  config: InfoRequestConfig,
+  params?: DeepImmutable<PerpsAtOpenInterestCapParameters>,
+  signal?: AbortSignal,
+): Promise<PerpsAtOpenInterestCapResponse>;
+export function perpsAtOpenInterestCap(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<PerpsAtOpenInterestCapResponse>;
+export function perpsAtOpenInterestCap(
+  config: InfoRequestConfig,
+  paramsOrSignal?: DeepImmutable<PerpsAtOpenInterestCapParameters> | AbortSignal,
+  maybeSignal?: AbortSignal,
+): Promise<PerpsAtOpenInterestCapResponse> {
+  const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;
+  const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;
+
+  const request = parser(PerpsAtOpenInterestCapRequest)({
+    type: "perpsAtOpenInterestCap",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/api/info/portfolio.ts

@@ -0,0 +1,113 @@
+import * as v from "valibot";
+import { Address, Decimal, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user portfolio.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export const PortfolioRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("portfolio"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user portfolio."),
+  );
+})();
+export type PortfolioRequest = v.InferOutput<typeof PortfolioRequest>;
+
+/** Portfolio metrics snapshot. */
+const Portfolio = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** History entries for account value as [timestamp, value]. */
+      accountValueHistory: v.pipe(
+        v.array(v.tuple([UnsignedInteger, UnsignedDecimal])),
+        v.description("History entries for account value as [timestamp, value]."),
+      ),
+      /** History entries for profit and loss as [timestamp, value]. */
+      pnlHistory: v.pipe(
+        v.array(v.tuple([UnsignedInteger, Decimal])),
+        v.description("History entries for profit and loss as [timestamp, value]."),
+      ),
+      /** Volume metric for the portfolio. */
+      vlm: v.pipe(
+        UnsignedDecimal,
+        v.description("Volume metric for the portfolio."),
+      ),
+    }),
+    v.description("Portfolio metrics snapshot."),
+  );
+})();
+type Portfolio = v.InferOutput<typeof Portfolio>;
+
+/**
+ * Portfolio metrics grouped by time periods.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ */
+export const PortfolioResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.tuple([
+      v.tuple([v.literal("day"), Portfolio]),
+      v.tuple([v.literal("week"), Portfolio]),
+      v.tuple([v.literal("month"), Portfolio]),
+      v.tuple([v.literal("allTime"), Portfolio]),
+      v.tuple([v.literal("perpDay"), Portfolio]),
+      v.tuple([v.literal("perpWeek"), Portfolio]),
+      v.tuple([v.literal("perpMonth"), Portfolio]),
+      v.tuple([v.literal("perpAllTime"), Portfolio]),
+    ]),
+    v.description("Portfolio metrics grouped by time periods."),
+  );
+})();
+export type PortfolioResponse = v.InferOutput<typeof PortfolioResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode portfolio} function. */
+export type PortfolioParameters = Omit<v.InferInput<typeof PortfolioRequest>, "type">;
+
+/**
+ * Request user portfolio.
+ * @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 Portfolio metrics grouped by time periods.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-portfolio
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { portfolio } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await portfolio(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function portfolio(
+  config: InfoRequestConfig,
+  params: DeepImmutable<PortfolioParameters>,
+  signal?: AbortSignal,
+): Promise<PortfolioResponse> {
+  const request = parser(PortfolioRequest)({
+    type: "portfolio",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/api/info/preTransferCheck.ts

@@ -0,0 +1,105 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser, UnsignedDecimal } from "../_base.ts";
+import type { InfoRequestConfig } from "./_types.ts";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user existence check before transfer.
+ * @see null
+ */
+export const PreTransferCheckRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("preTransferCheck"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** Source address. */
+      source: v.pipe(
+        Address,
+        v.description("Source address."),
+      ),
+    }),
+    v.description("Request user existence check before transfer."),
+  );
+})();
+export type PreTransferCheckRequest = v.InferOutput<typeof PreTransferCheckRequest>;
+
+/**
+ * Pre-transfer user existence check result.
+ * @see null
+ */
+export const PreTransferCheckResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Activation fee. */
+      fee: v.pipe(
+        UnsignedDecimal,
+        v.description("Activation fee."),
+      ),
+      /** Whether the user is sanctioned. */
+      isSanctioned: v.pipe(
+        v.boolean(),
+        v.description("Whether the user is sanctioned."),
+      ),
+      /** Whether the user exists. */
+      userExists: v.pipe(
+        v.boolean(),
+        v.description("Whether the user exists."),
+      ),
+      /** Whether the user has sent a transaction. */
+      userHasSentTx: v.pipe(
+        v.boolean(),
+        v.description("Whether the user has sent a transaction."),
+      ),
+    }),
+    v.description("Pre-transfer user existence check result."),
+  );
+})();
+export type PreTransferCheckResponse = v.InferOutput<typeof PreTransferCheckResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode preTransferCheck} function. */
+export type PreTransferCheckParameters = Omit<v.InferInput<typeof PreTransferCheckRequest>, "type">;
+
+/**
+ * Request user existence check before transfer.
+ * @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 Pre-transfer user existence check result.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { preTransferCheck } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await preTransferCheck(
+ *   { transport },
+ *   { user: "0x...", source: "0x..." },
+ * );
+ * ```
+ */
+export function preTransferCheck(
+  config: InfoRequestConfig,
+  params: DeepImmutable<PreTransferCheckParameters>,
+  signal?: AbortSignal,
+): Promise<PreTransferCheckResponse> {
+  const request = parser(PreTransferCheckRequest)({
+    type: "preTransferCheck",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}