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

88.89

/src/api/subscription/allMids.ts

import * as v from "valibot";
import { type DeepImmutable, parser, UnsignedDecimal } from "../_common.ts";
import type { SubscriptionRequestConfig } from "./_common.ts";
import type { Subscription } from "../../transport/base.ts";

// -------------------- Schemas --------------------

/** Subscription to mid price events for all coins. */
export const AllMidsRequest = /* @__PURE__ */ (() => {
  return v.pipe(
    v.object({
      /** Type of subscription. */
      type: v.pipe(
        v.literal("allMids"),
        v.description("Type of subscription."),
      ),
      /** 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("Subscription to mid price events for all coins."),
  );
})();
export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;

/** Event of mid prices for all assets. */
export const AllMidsEvent = /* @__PURE__ */ (() => {
  return v.pipe(
    v.object({
      /** Mapping of coin symbols to mid prices. */
      mids: v.pipe(
        v.record(v.string(), UnsignedDecimal),
        v.description("Mapping of coin symbols to mid prices."),
      ),
    }),
    v.description("Event of mid prices for all assets."),
  );
})();
export type AllMidsEvent = v.InferOutput<typeof AllMidsEvent>;

// -------------------- Function --------------------

/** Request parameters for the {@linkcode allMids} function. */
export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;

/**
 * Subscribe to mid prices for all actively traded assets.
 * @param config - General configuration for Subscription API subscriptions.
 * @param params - Parameters specific to the API subscription.
 * @param listener - A callback function to be called when the event is received.
 * @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
 *
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 * @example
 * ```ts
 * import { WebSocketTransport } from "@nktkas/hyperliquid";
 * import { allMids } from "@nktkas/hyperliquid/api/subscription";
 *
 * const transport = new WebSocketTransport();
 *
 * const sub = await allMids(
 *   { transport },
 *   (data) => console.log(data),
 * );
 * ```
 */
export function allMids(
  config: SubscriptionRequestConfig,
  listener: (data: AllMidsEvent) => void,
): Promise<Subscription>;
export function allMids(
  config: SubscriptionRequestConfig,
  params: DeepImmutable<AllMidsParameters>,
  listener: (data: AllMidsEvent) => void,
): Promise<Subscription>;
export function allMids(
  config: SubscriptionRequestConfig,
  paramsOrListener: DeepImmutable<AllMidsParameters> | ((data: AllMidsEvent) => void),
  maybeListener?: (data: AllMidsEvent) => void,
): Promise<Subscription> {
  const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
  const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;

  const payload = parser(AllMidsRequest)({ type: "allMids", ...params });
  return config.transport.subscribe<AllMidsEvent>(payload.type, payload, (e) => {
    listener(e.detail);
  });
}

1	import * as v from "valibot";	328✔
2	import { type DeepImmutable, parser, UnsignedDecimal } from "../_common.ts";	328✔
3	import type { SubscriptionRequestConfig } from "./_common.ts";
4	import type { Subscription } from "../../transport/base.ts";
5
6	// -------------------- Schemas --------------------
7
8	/** Subscription to mid price events for all coins. */
9	export const AllMidsRequest = /* @__PURE__ */ (() => {	328✔
10	return v.pipe(	555✔
11	v.object({	555✔
12	/** Type of subscription. */
13	type: v.pipe(	555✔
14	v.literal("allMids"),	555✔
15	v.description("Type of subscription."),	555✔
16	),
17	/** DEX name (empty string for main dex). */
18	dex: v.pipe(	555✔
19	v.optional(v.string()),	555✔
20	v.description("DEX name (empty string for main dex)."),	555✔
21	),
22	}),	555✔
23	v.description("Subscription to mid price events for all coins."),	555✔
24	);
25	})();	328✔
26	export type AllMidsRequest = v.InferOutput<typeof AllMidsRequest>;
27
28	/** Event of mid prices for all assets. */
29	export const AllMidsEvent = /* @__PURE__ */ (() => {	328✔
30	return v.pipe(	555✔
31	v.object({	555✔
32	/** Mapping of coin symbols to mid prices. */
33	mids: v.pipe(	555✔
34	v.record(v.string(), UnsignedDecimal),	555✔
35	v.description("Mapping of coin symbols to mid prices."),	555✔
36	),
37	}),	555✔
38	v.description("Event of mid prices for all assets."),	555✔
39	);
40	})();	328✔
41	export type AllMidsEvent = v.InferOutput<typeof AllMidsEvent>;
42
43	// -------------------- Function --------------------
44
45	/** Request parameters for the {@linkcode allMids} function. */
46	export type AllMidsParameters = Omit<v.InferInput<typeof AllMidsRequest>, "type">;
47
48	/**
49	* Subscribe to mid prices for all actively traded assets.
50	* @param config - General configuration for Subscription API subscriptions.
51	* @param params - Parameters specific to the API subscription.
52	* @param listener - A callback function to be called when the event is received.
53	* @returns A request-promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
54	*
55	* @throws {TransportError} When the transport layer throws an error.
56	*
57	* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
58	* @example
59	* ```ts
60	* import { WebSocketTransport } from "@nktkas/hyperliquid";
61	* import { allMids } from "@nktkas/hyperliquid/api/subscription";
62	*
63	* const transport = new WebSocketTransport();
64	*
65	* const sub = await allMids(
66	* { transport },
67	* (data) => console.log(data),
68	* );
69	* ```
70	*/
71	export function allMids(
72	config: SubscriptionRequestConfig,
73	listener: (data: AllMidsEvent) => void,
74	): Promise<Subscription>;
75	export function allMids(
76	config: SubscriptionRequestConfig,
77	params: DeepImmutable<AllMidsParameters>,
78	listener: (data: AllMidsEvent) => void,
79	): Promise<Subscription>;
80	export function allMids(	328✔
81	config: SubscriptionRequestConfig,	328✔
82	paramsOrListener: DeepImmutable<AllMidsParameters> \| ((data: AllMidsEvent) => void),	328✔
83	maybeListener?: (data: AllMidsEvent) => void,	328✔
84	): Promise<Subscription> {
NEW 85	const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;	×
NEW 86	const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener!;	×
87
88	const payload = parser(AllMidsRequest)({ type: "allMids", ...params });	1,316✔
89	return config.transport.subscribe<AllMidsEvent>(payload.type, payload, (e) => {	329✔
90	listener(e.detail);	331✔
91	});	329✔
92	}	329✔

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