@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.1

package/esm/src/clients/subscription.js

@@ -1,3 +1,4 @@
+import { parser, WsActiveAssetCtxRequest, WsActiveAssetDataRequest, WsAllMidsRequest, WsAssetCtxsRequest, WsBboRequest, WsCandleRequest, WsClearinghouseStateRequest, WsExplorerBlockRequest, WsExplorerTxsRequest, WsL2BookRequest, WsNotificationRequest, WsOpenOrdersRequest, WsOrderUpdatesRequest, WsTradesRequest, WsUserEventsRequest, WsUserFillsRequest, WsUserFundingsRequest, WsUserNonFundingLedgerUpdatesRequest, WsUserTwapHistoryRequest, WsUserTwapSliceFillsRequest, WsWebData2Request, } from "../schemas/mod.js";
 /**
  * Subscription client for subscribing to various Hyperliquid events.
  * @typeParam T The type of transport used to connect to the Hyperliquid Websocket API.
@@ -41,10 +42,10 @@ export class SubscriptionClient {
      * ```
      */
     activeAssetCtx(params, listener) {
+        const payload = parser(WsActiveAssetCtxRequest)({ type: "activeAssetCtx", ...params });
         const channel = params.coin.startsWith("@") ? "activeSpotAssetCtx" : "activeAssetCtx";
-        const payload = { type: "activeAssetCtx", ...params };
         return this.transport.subscribe(channel, payload, (e) => {
-            if (e.detail.coin === params.coin) {
+            if (e.detail.coin === payload.coin) {
                 listener(e.detail);
             }
         });
@@ -71,9 +72,9 @@ export class SubscriptionClient {
      * ```
      */
     activeAssetData(params, listener) {
-        const payload = { type: "activeAssetData", ...params };
+        const payload = parser(WsActiveAssetDataRequest)({ type: "activeAssetData", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.coin === params.coin && e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.coin === payload.coin && e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -81,11 +82,25 @@ export class SubscriptionClient {
     allMids(params_or_listener, maybeListener) {
         const params = typeof params_or_listener === "function" ? {} : params_or_listener;
         const listener = typeof params_or_listener === "function" ? params_or_listener : maybeListener;
-        const payload = { type: "allMids", ...params };
+        const payload = parser(WsAllMidsRequest)({ type: "allMids", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
             listener(e.detail);
         });
     }
+    assetCtxs(params_or_listener, maybeListener) {
+        const params = typeof params_or_listener === "function" ? {} : params_or_listener;
+        const listener = typeof params_or_listener === "function" ? params_or_listener : maybeListener;
+        const payload = parser(WsAssetCtxsRequest)({
+            type: "assetCtxs",
+            ...params,
+            dex: params.dex ?? "",
+        });
+        return this.transport.subscribe(payload.type, payload, (e) => {
+            if (e.detail.dex === payload.dex) {
+                listener(e.detail);
+            }
+        });
+    }
     /**
      * Subscribe to best bid and offer updates for a specific asset.
      * @param params - Subscription-specific parameters.
@@ -108,9 +123,9 @@ export class SubscriptionClient {
      * ```
      */
     bbo(params, listener) {
-        const payload = { type: "bbo", ...params };
+        const payload = parser(WsBboRequest)({ type: "bbo", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.coin === params.coin) {
+            if (e.detail.coin === payload.coin) {
                 listener(e.detail);
             }
         });
@@ -137,9 +152,42 @@ export class SubscriptionClient {
      * ```
      */
     candle(params, listener) {
-        const payload = { type: "candle", ...params };
+        const payload = parser(WsCandleRequest)({ type: "candle", ...params });
+        return this.transport.subscribe(payload.type, payload, (e) => {
+            if (e.detail.s === payload.coin && e.detail.i === payload.interval) {
+                listener(e.detail);
+            }
+        });
+    }
+    /**
+     * Subscribe to clearinghouse state updates for a specific user.
+     * @param params - Subscription-specific parameters.
+     * @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 null
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const subsClient = new hl.SubscriptionClient({ transport });
+     *
+     * const sub = await subsClient.clearinghouseState({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    clearinghouseState(params, listener) {
+        const payload = parser(WsClearinghouseStateRequest)({
+            type: "clearinghouseState",
+            ...params,
+            dex: params.dex ?? "",
+        });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.s === params.coin && e.detail.i === params.interval) {
+            if (e.detail.user === payload.user.toLowerCase() && e.detail.dex === payload.dex) {
                 listener(e.detail);
             }
         });
@@ -166,7 +214,7 @@ export class SubscriptionClient {
      * ```
      */
     explorerBlock(listener) {
-        const payload = { type: "explorerBlock" };
+        const payload = parser(WsExplorerBlockRequest)({ type: "explorerBlock" });
         return this.transport.subscribe("_explorerBlock", payload, (e) => {
             listener(e.detail);
         });
@@ -193,7 +241,7 @@ export class SubscriptionClient {
      * ```
      */
     explorerTxs(listener) {
-        const payload = { type: "explorerTxs" };
+        const payload = parser(WsExplorerTxsRequest)({ type: "explorerTxs" });
         return this.transport.subscribe("_explorerTxs", payload, (e) => {
             listener(e.detail);
         });
@@ -220,14 +268,14 @@ export class SubscriptionClient {
      * ```
      */
     l2Book(params, listener) {
-        const payload = {
+        const payload = parser(WsL2BookRequest)({
             type: "l2Book",
             ...params,
             nSigFigs: params.nSigFigs ?? null,
             mantissa: params.mantissa ?? null,
-        };
+        });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.coin === params.coin) {
+            if (e.detail.coin === payload.coin) {
                 listener(e.detail);
             }
         });
@@ -254,11 +302,44 @@ export class SubscriptionClient {
      * ```
      */
     notification(params, listener) {
-        const payload = { type: "notification", ...params };
+        const payload = parser(WsNotificationRequest)({ type: "notification", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
             listener(e.detail);
         });
     }
+    /**
+     * Subscribe to open orders updates for a specific user.
+     * @param params - Subscription-specific parameters.
+     * @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 * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const subsClient = new hl.SubscriptionClient({ transport });
+     *
+     * const sub = await subsClient.openOrders({ user: "0x..." }, (data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    openOrders(params, listener) {
+        const payload = parser(WsOpenOrdersRequest)({
+            type: "openOrders",
+            ...params,
+            dex: params.dex ?? "",
+        });
+        return this.transport.subscribe(payload.type, payload, (e) => {
+            if (e.detail.user === payload.user.toLowerCase() && e.detail.dex === payload.dex) {
+                listener(e.detail);
+            }
+        });
+    }
     /**
      * Subscribe to order status updates for a specific user.
      * @param params - Subscription-specific parameters.
@@ -281,7 +362,7 @@ export class SubscriptionClient {
      * ```
      */
     orderUpdates(params, listener) {
-        const payload = { type: "orderUpdates", ...params };
+        const payload = parser(WsOrderUpdatesRequest)({ type: "orderUpdates", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
             listener(e.detail);
         });
@@ -308,9 +389,9 @@ export class SubscriptionClient {
      * ```
      */
     trades(params, listener) {
-        const payload = { type: "trades", ...params };
+        const payload = parser(WsTradesRequest)({ type: "trades", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail[0]?.coin === params.coin) {
+            if (e.detail[0]?.coin === payload.coin) {
                 listener(e.detail);
             }
         });
@@ -338,7 +419,7 @@ export class SubscriptionClient {
      * ```
      */
     userEvents(params, listener) {
-        const payload = { type: "userEvents", ...params };
+        const payload = parser(WsUserEventsRequest)({ type: "userEvents", ...params });
         return this.transport.subscribe("user", payload, (e) => {
             listener(e.detail);
         });
@@ -365,13 +446,13 @@ export class SubscriptionClient {
      * ```
      */
     userFills(params, listener) {
-        const payload = {
+        const payload = parser(WsUserFillsRequest)({
             type: "userFills",
             ...params,
             aggregateByTime: params.aggregateByTime ?? false,
-        };
+        });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -398,9 +479,9 @@ export class SubscriptionClient {
      * ```
      */
     userFundings(params, listener) {
-        const payload = { type: "userFundings", ...params };
+        const payload = parser(WsUserFundingsRequest)({ type: "userFundings", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -427,12 +508,12 @@ export class SubscriptionClient {
      * ```
      */
     userNonFundingLedgerUpdates(params, listener) {
-        const payload = {
+        const payload = parser(WsUserNonFundingLedgerUpdatesRequest)({
             type: "userNonFundingLedgerUpdates",
             ...params,
-        };
+        });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -459,9 +540,9 @@ export class SubscriptionClient {
      * ```
      */
     userTwapHistory(params, listener) {
-        const payload = { type: "userTwapHistory", ...params };
+        const payload = parser(WsUserTwapHistoryRequest)({ type: "userTwapHistory", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -488,9 +569,9 @@ export class SubscriptionClient {
      * ```
      */
     userTwapSliceFills(params, listener) {
-        const payload = { type: "userTwapSliceFills", ...params };
+        const payload = parser(WsUserTwapSliceFillsRequest)({ type: "userTwapSliceFills", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });
@@ -517,9 +598,9 @@ export class SubscriptionClient {
      * ```
      */
     webData2(params, listener) {
-        const payload = { type: "webData2", ...params };
+        const payload = parser(WsWebData2Request)({ type: "webData2", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
-            if (e.detail.user === params.user.toLowerCase()) {
+            if (e.detail.user === payload.user.toLowerCase()) {
                 listener(e.detail);
             }
         });

package/esm/src/{base.d.ts → errors.d.ts}

@@ -2,4 +2,4 @@
 export declare class HyperliquidError extends Error {
     constructor(message?: string, options?: ErrorOptions);
 }
-//# sourceMappingURL=base.d.ts.map
+//# sourceMappingURL=errors.d.ts.map

package/esm/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/src/errors.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,qBAAa,gBAAiB,SAAQ,KAAK;gBAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIvD"}

package/esm/src/schemas/_base.d.ts

@@ -0,0 +1,10 @@
+import * as v from "valibot";
+export declare const UnsignedDecimal: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>;
+export type UnsignedDecimal = v.InferOutput<typeof UnsignedDecimal>;
+export declare const SignedDecimal: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>;
+export type SignedDecimal = v.InferOutput<typeof SignedDecimal>;
+export declare const Hex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>;
+export type Hex = v.InferOutput<typeof Hex>;
+export declare const TokenId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `${string}:0x${string}`>]>;
+export type TokenId = v.InferOutput<typeof TokenId>;
+//# sourceMappingURL=_base.d.ts.map

package/esm/src/schemas/_base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_base.d.ts","sourceRoot":"","sources":["../../../src/src/schemas/_base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,eAAO,MAAM,eAAe,6HAI3B,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE,eAAO,MAAM,aAAa,6HAIzB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,eAAO,MAAM,GAAG,oIAIf,CAAC;AACF,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC;AAE5C,eAAO,MAAM,OAAO,8IAInB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,OAAO,CAAC,CAAC"}

package/esm/src/schemas/_base.js

@@ -0,0 +1,12 @@
+import * as v from "valibot";
+export const UnsignedDecimal = v.pipe(v.string(), v.regex(/^[0-9]+(\.[0-9]+)?$/), v.transform((value) => formatDecimal(value)));
+export const SignedDecimal = v.pipe(v.string(), v.regex(/^-?[0-9]+(\.[0-9]+)?$/), v.transform((value) => formatDecimal(value)));
+export const Hex = v.pipe(v.string(), v.regex(/^0[xX][0-9a-fA-F]+$/), v.transform((value) => value.toLowerCase()));
+export const TokenId = v.pipe(v.string(), v.regex(/^[^:]+:0x[0-9a-fA-F]+$/), v.transform((value) => value));
+/** Removes leading/trailing zeros from decimal string without precision loss. */
+function formatDecimal(numStr) {
+    return numStr
+        .replace(/^(-?)0+(?=\d)/, "$1") // Remove leading zeros, keep sign
+        .replace(/(\.\d*?)0+$/, "$1") // Remove trailing zeros after decimal
+        .replace(/\.$/, ""); // Remove lone decimal point
+}