17932585565

Committed 23 Sep 2025 12:11AM UTC coverage: 96.069% (+5.5%) from 90.582%

Build # 17932585565

Build Type

push

github

Committed by

nktkas

Commit Message

feat!: tree shaking support (~50% less size)

all API methods were moved to separate files and a new import point `/api` was added

breaking changes:
- import point `/schemas` replaced with `/api/[info,exchange,subscription]`
- standardization of typescript types to single pattern: [api name] + [Request,Response,Event,Parameters,Options,Types]
- private key directly supported only when creating a client instance

Coverage Stats

365 of 553 branches covered (66.0%)

Branch coverage included in aggregate %.

13134 of 13495 new or added lines in 148 files covered. (97.32%)

13173 of 13539 relevant lines covered (97.3%)

613.66 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.88

/src/api/info/perpsAtOpenInterestCap.ts

import * as v from "valibot";
import { type DeepImmutable, parser } from "../_common.ts";
import type { InfoRequestConfig } from "./_common.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);
}

1	import * as v from "valibot";	328✔
2	import { type DeepImmutable, parser } from "../_common.ts";	328✔
3	import type { InfoRequestConfig } from "./_common.ts";
4
5	// -------------------- Schemas --------------------
6
7	/**
8	* Request perpetuals at open interest cap.
9	* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
10	*/
11	export const PerpsAtOpenInterestCapRequest = /* @__PURE__ */ (() => {	328✔
12	return v.pipe(	555✔
13	v.object({	555✔
14	/** Type of request. */
15	type: v.pipe(	555✔
16	v.literal("perpsAtOpenInterestCap"),	555✔
17	v.description("Type of request."),	555✔
18	),
19	/** DEX name (empty string for main dex). */
20	dex: v.pipe(	555✔
21	v.optional(v.string()),	555✔
22	v.description("DEX name (empty string for main dex)."),	555✔
23	),
24	}),	555✔
25	v.description("Request perpetuals at open interest cap."),	555✔
26	);
27	})();	328✔
28	export type PerpsAtOpenInterestCapRequest = v.InferOutput<typeof PerpsAtOpenInterestCapRequest>;
29
30	/**
31	* Array of perpetuals at open interest caps.
32	* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
33	*/
34	export const PerpsAtOpenInterestCapResponse = /* @__PURE__ */ (() => {	328✔
35	return v.pipe(	555✔
36	v.array(v.string()),	555✔
37	v.description("Array of perpetuals at open interest caps."),	555✔
38	);
39	})();	328✔
40	export type PerpsAtOpenInterestCapResponse = v.InferOutput<typeof PerpsAtOpenInterestCapResponse>;
41
42	// -------------------- Function --------------------
43
44	/** Request parameters for the {@linkcode perpsAtOpenInterestCap} function. */
45	export type PerpsAtOpenInterestCapParameters = Omit<v.InferInput<typeof PerpsAtOpenInterestCapRequest>, "type">;
46
47	/**
48	* Request perpetuals at open interest cap.
49	* @param config - General configuration for Info API requests.
50	* @param params - Parameters specific to the API request.
51	* @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).
52	* @returns Array of perpetuals at open interest caps.
53	*
54	* @throws {TransportError} When the transport layer throws an error.
55	*
56	* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#query-perps-at-open-interest-caps
57	* @example
58	* ```ts
59	* import { HttpTransport } from "@nktkas/hyperliquid";
60	* import { perpsAtOpenInterestCap } from "@nktkas/hyperliquid/api/info";
61	*
62	* const transport = new HttpTransport(); // or `WebSocketTransport`
63	* const data = await perpsAtOpenInterestCap({ transport });
64	* ```
65	*/
66	export function perpsAtOpenInterestCap(
67	config: InfoRequestConfig,
68	params?: DeepImmutable<PerpsAtOpenInterestCapParameters>,
69	signal?: AbortSignal,
70	): Promise<PerpsAtOpenInterestCapResponse>;
71	export function perpsAtOpenInterestCap(
72	config: InfoRequestConfig,
73	signal?: AbortSignal,
74	): Promise<PerpsAtOpenInterestCapResponse>;
75	export function perpsAtOpenInterestCap(	328✔
76	config: InfoRequestConfig,	328✔
77	paramsOrSignal?: DeepImmutable<PerpsAtOpenInterestCapParameters> \| AbortSignal,	328✔
78	maybeSignal?: AbortSignal,	328✔
79	): Promise<PerpsAtOpenInterestCapResponse> {
NEW 80	const params = paramsOrSignal instanceof AbortSignal ? {} : paramsOrSignal;	×
NEW 81	const signal = paramsOrSignal instanceof AbortSignal ? paramsOrSignal : maybeSignal;	×
82
83	const request = parser(PerpsAtOpenInterestCapRequest)({	330✔
84	type: "perpsAtOpenInterestCap",	330✔
85	...params,	330✔
86	});	330✔
87	return config.transport.request("info", request, signal);	330✔
88	}	330✔

nktkas / hyperliquid / 17932585565

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous