@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.1

package/script/src/clients/subscription.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionClient = void 0;
+const mod_js_1 = require("../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.
@@ -44,10 +45,10 @@ class SubscriptionClient {
      * ```
      */
     activeAssetCtx(params, listener) {
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -74,9 +75,9 @@ class SubscriptionClient {
      * ```
      */
     activeAssetData(params, listener) {
-        const payload = { type: "activeAssetData", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -84,11 +85,25 @@ 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 = (0, mod_js_1.parser)(mod_js_1.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 = (0, mod_js_1.parser)(mod_js_1.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.
@@ -111,9 +126,9 @@ class SubscriptionClient {
      * ```
      */
     bbo(params, listener) {
-        const payload = { type: "bbo", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -140,9 +155,42 @@ class SubscriptionClient {
      * ```
      */
     candle(params, listener) {
-        const payload = { type: "candle", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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 = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -169,7 +217,7 @@ class SubscriptionClient {
      * ```
      */
     explorerBlock(listener) {
-        const payload = { type: "explorerBlock" };
+        const payload = (0, mod_js_1.parser)(mod_js_1.WsExplorerBlockRequest)({ type: "explorerBlock" });
         return this.transport.subscribe("_explorerBlock", payload, (e) => {
             listener(e.detail);
         });
@@ -196,7 +244,7 @@ class SubscriptionClient {
      * ```
      */
     explorerTxs(listener) {
-        const payload = { type: "explorerTxs" };
+        const payload = (0, mod_js_1.parser)(mod_js_1.WsExplorerTxsRequest)({ type: "explorerTxs" });
         return this.transport.subscribe("_explorerTxs", payload, (e) => {
             listener(e.detail);
         });
@@ -223,14 +271,14 @@ class SubscriptionClient {
      * ```
      */
     l2Book(params, listener) {
-        const payload = {
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -257,11 +305,44 @@ class SubscriptionClient {
      * ```
      */
     notification(params, listener) {
-        const payload = { type: "notification", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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 = (0, mod_js_1.parser)(mod_js_1.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.
@@ -284,7 +365,7 @@ class SubscriptionClient {
      * ```
      */
     orderUpdates(params, listener) {
-        const payload = { type: "orderUpdates", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.WsOrderUpdatesRequest)({ type: "orderUpdates", ...params });
         return this.transport.subscribe(payload.type, payload, (e) => {
             listener(e.detail);
         });
@@ -311,9 +392,9 @@ class SubscriptionClient {
      * ```
      */
     trades(params, listener) {
-        const payload = { type: "trades", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -341,7 +422,7 @@ class SubscriptionClient {
      * ```
      */
     userEvents(params, listener) {
-        const payload = { type: "userEvents", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.WsUserEventsRequest)({ type: "userEvents", ...params });
         return this.transport.subscribe("user", payload, (e) => {
             listener(e.detail);
         });
@@ -368,13 +449,13 @@ class SubscriptionClient {
      * ```
      */
     userFills(params, listener) {
-        const payload = {
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -401,9 +482,9 @@ class SubscriptionClient {
      * ```
      */
     userFundings(params, listener) {
-        const payload = { type: "userFundings", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -430,12 +511,12 @@ class SubscriptionClient {
      * ```
      */
     userNonFundingLedgerUpdates(params, listener) {
-        const payload = {
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -462,9 +543,9 @@ class SubscriptionClient {
      * ```
      */
     userTwapHistory(params, listener) {
-        const payload = { type: "userTwapHistory", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -491,9 +572,9 @@ class SubscriptionClient {
      * ```
      */
     userTwapSliceFills(params, listener) {
-        const payload = { type: "userTwapSliceFills", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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);
             }
         });
@@ -520,9 +601,9 @@ class SubscriptionClient {
      * ```
      */
     webData2(params, listener) {
-        const payload = { type: "webData2", ...params };
+        const payload = (0, mod_js_1.parser)(mod_js_1.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/script/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/script/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/script/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/script/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/script/src/schemas/_base.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenId = exports.Hex = exports.SignedDecimal = exports.UnsignedDecimal = void 0;
+const v = __importStar(require("valibot"));
+exports.UnsignedDecimal = v.pipe(v.string(), v.regex(/^[0-9]+(\.[0-9]+)?$/), v.transform((value) => formatDecimal(value)));
+exports.SignedDecimal = v.pipe(v.string(), v.regex(/^-?[0-9]+(\.[0-9]+)?$/), v.transform((value) => formatDecimal(value)));
+exports.Hex = v.pipe(v.string(), v.regex(/^0[xX][0-9a-fA-F]+$/), v.transform((value) => value.toLowerCase()));
+exports.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
+}