@hfunlabs/hyperliquid 0.27.1 → 0.30.0-hfunlabs.1

package/script/src/api/subscription/client.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionClient = void 0;
+// =============================================================
+// Methods Imports
+// =============================================================
+const activeAssetCtx_js_1 = require("./_methods/activeAssetCtx.js");
+const activeAssetData_js_1 = require("./_methods/activeAssetData.js");
+const activeSpotAssetCtx_js_1 = require("./_methods/activeSpotAssetCtx.js");
+const allDexsAssetCtxs_js_1 = require("./_methods/allDexsAssetCtxs.js");
+const allDexsClearinghouseState_js_1 = require("./_methods/allDexsClearinghouseState.js");
+const allMids_js_1 = require("./_methods/allMids.js");
+const assetCtxs_js_1 = require("./_methods/assetCtxs.js");
+const bbo_js_1 = require("./_methods/bbo.js");
+const candle_js_1 = require("./_methods/candle.js");
+const clearinghouseState_js_1 = require("./_methods/clearinghouseState.js");
+const explorerBlock_js_1 = require("./_methods/explorerBlock.js");
+const explorerTxs_js_1 = require("./_methods/explorerTxs.js");
+const l2Book_js_1 = require("./_methods/l2Book.js");
+const notification_js_1 = require("./_methods/notification.js");
+const openOrders_js_1 = require("./_methods/openOrders.js");
+const orderUpdates_js_1 = require("./_methods/orderUpdates.js");
+const spotAssetCtxs_js_1 = require("./_methods/spotAssetCtxs.js");
+const spotState_js_1 = require("./_methods/spotState.js");
+const trades_js_1 = require("./_methods/trades.js");
+const twapStates_js_1 = require("./_methods/twapStates.js");
+const userEvents_js_1 = require("./_methods/userEvents.js");
+const userFills_js_1 = require("./_methods/userFills.js");
+const userFundings_js_1 = require("./_methods/userFundings.js");
+const userHistoricalOrders_js_1 = require("./_methods/userHistoricalOrders.js");
+const userNonFundingLedgerUpdates_js_1 = require("./_methods/userNonFundingLedgerUpdates.js");
+const userTwapHistory_js_1 = require("./_methods/userTwapHistory.js");
+const userTwapSliceFills_js_1 = require("./_methods/userTwapSliceFills.js");
+const webData2_js_1 = require("./_methods/webData2.js");
+const webData3_js_1 = require("./_methods/webData3.js");
+// =============================================================
+// Client
+// =============================================================
+/**
+ * Real-time data via WebSocket subscriptions.
+ *
+ * Corresponds to {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | WebSocket subscriptions}.
+ */
+class SubscriptionClient {
+    config_;
+    /**
+     * Creates an instance of the SubscriptionClient.
+     *
+     * @param config - Configuration for Subscription API requests. See {@link SubscriptionConfig}.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport(); // only `WebSocketTransport`
+     *
+     * const subsClient = new hl.SubscriptionClient({ transport });
+     * ```
+     */
+    constructor(config) {
+        this.config_ = config;
+    }
+    /** @see {@link activeAssetCtx} */
+    activeAssetCtx(params, listener) {
+        return (0, activeAssetCtx_js_1.activeAssetCtx)(this.config_, params, listener);
+    }
+    /** @see {@link activeAssetData} */
+    activeAssetData(params, listener) {
+        return (0, activeAssetData_js_1.activeAssetData)(this.config_, params, listener);
+    }
+    /** @see {@link activeSpotAssetCtx} */
+    activeSpotAssetCtx(params, listener) {
+        return (0, activeSpotAssetCtx_js_1.activeSpotAssetCtx)(this.config_, params, listener);
+    }
+    /** @see {@link allDexsAssetCtxs} */
+    allDexsAssetCtxs(listener) {
+        return (0, allDexsAssetCtxs_js_1.allDexsAssetCtxs)(this.config_, listener);
+    }
+    /** @see {@link allDexsClearinghouseState} */
+    allDexsClearinghouseState(params, listener) {
+        return (0, allDexsClearinghouseState_js_1.allDexsClearinghouseState)(this.config_, params, listener);
+    }
+    allMids(paramsOrListener, maybeListener) {
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+        return (0, allMids_js_1.allMids)(this.config_, params, listener);
+    }
+    assetCtxs(paramsOrListener, maybeListener) {
+        const params = typeof paramsOrListener === "function" ? {} : paramsOrListener;
+        const listener = typeof paramsOrListener === "function" ? paramsOrListener : maybeListener;
+        return (0, assetCtxs_js_1.assetCtxs)(this.config_, params, listener);
+    }
+    /** @see {@link bbo} */
+    bbo(params, listener) {
+        return (0, bbo_js_1.bbo)(this.config_, params, listener);
+    }
+    /** @see {@link candle} */
+    candle(params, listener) {
+        return (0, candle_js_1.candle)(this.config_, params, listener);
+    }
+    /** @see {@link clearinghouseState} */
+    clearinghouseState(params, listener) {
+        return (0, clearinghouseState_js_1.clearinghouseState)(this.config_, params, listener);
+    }
+    /** @see {@link explorerBlock} */
+    explorerBlock(listener) {
+        return (0, explorerBlock_js_1.explorerBlock)(this.config_, listener);
+    }
+    /** @see {@link explorerTxs} */
+    explorerTxs(listener) {
+        return (0, explorerTxs_js_1.explorerTxs)(this.config_, listener);
+    }
+    /** @see {@link l2Book} */
+    l2Book(params, listener) {
+        return (0, l2Book_js_1.l2Book)(this.config_, params, listener);
+    }
+    /** @see {@link notification} */
+    notification(params, listener) {
+        return (0, notification_js_1.notification)(this.config_, params, listener);
+    }
+    /** @see {@link openOrders} */
+    openOrders(params, listener) {
+        return (0, openOrders_js_1.openOrders)(this.config_, params, listener);
+    }
+    /** @see {@link orderUpdates} */
+    orderUpdates(params, listener) {
+        return (0, orderUpdates_js_1.orderUpdates)(this.config_, params, listener);
+    }
+    /** @see {@link spotAssetCtxs} */
+    spotAssetCtxs(listener) {
+        return (0, spotAssetCtxs_js_1.spotAssetCtxs)(this.config_, listener);
+    }
+    /** @see {@link spotState} */
+    spotState(params, listener) {
+        return (0, spotState_js_1.spotState)(this.config_, params, listener);
+    }
+    /** @see {@link trades} */
+    trades(params, listener) {
+        return (0, trades_js_1.trades)(this.config_, params, listener);
+    }
+    /** @see {@link twapStates} */
+    twapStates(params, listener) {
+        return (0, twapStates_js_1.twapStates)(this.config_, params, listener);
+    }
+    /** @see {@link userEvents} */
+    userEvents(params, listener) {
+        return (0, userEvents_js_1.userEvents)(this.config_, params, listener);
+    }
+    /** @see {@link userFills} */
+    userFills(params, listener) {
+        return (0, userFills_js_1.userFills)(this.config_, params, listener);
+    }
+    /** @see {@link userFundings} */
+    userFundings(params, listener) {
+        return (0, userFundings_js_1.userFundings)(this.config_, params, listener);
+    }
+    /** @see {@link userHistoricalOrders} */
+    userHistoricalOrders(params, listener) {
+        return (0, userHistoricalOrders_js_1.userHistoricalOrders)(this.config_, params, listener);
+    }
+    /** @see {@link userNonFundingLedgerUpdates} */
+    userNonFundingLedgerUpdates(params, listener) {
+        return (0, userNonFundingLedgerUpdates_js_1.userNonFundingLedgerUpdates)(this.config_, params, listener);
+    }
+    /** @see {@link userTwapHistory} */
+    userTwapHistory(params, listener) {
+        return (0, userTwapHistory_js_1.userTwapHistory)(this.config_, params, listener);
+    }
+    /** @see {@link userTwapSliceFills} */
+    userTwapSliceFills(params, listener) {
+        return (0, userTwapSliceFills_js_1.userTwapSliceFills)(this.config_, params, listener);
+    }
+    /** @see {@link webData2} */
+    webData2(params, listener) {
+        return (0, webData2_js_1.webData2)(this.config_, params, listener);
+    }
+    /** @see {@link webData3} */
+    webData3(params, listener) {
+        return (0, webData3_js_1.webData3)(this.config_, params, listener);
+    }
+}
+exports.SubscriptionClient = SubscriptionClient;
+//# sourceMappingURL=client.js.map

package/script/src/api/subscription/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/client.ts"],"names":[],"mappings":";;;AAGA,gEAAgE;AAChE,kBAAkB;AAClB,gEAAgE;AAEhE,oEAAuH;AACvH,sEAIuC;AACvC,4EAI0C;AAC1C,wEAA8F;AAC9F,0FAIiD;AACjD,sDAA2F;AAC3F,0DAAmG;AACnG,8CAA2E;AAC3E,oDAAuF;AACvF,4EAI0C;AAC1C,kEAAqF;AACrF,8DAA+E;AAC/E,oDAAuF;AACvF,gEAA+G;AAC/G,4DAAuG;AACvG,gEAA+G;AAC/G,kEAAqF;AACrF,0DAAmG;AACnG,oDAAuF;AACvF,4DAAuG;AACvG,4DAAuG;AACvG,0DAAmG;AACnG,gEAA+G;AAC/G,gFAI4C;AAC5C,8FAImD;AACnD,sEAIuC;AACvC,4EAI0C;AAC1C,wDAA+F;AAC/F,wDAA+F;AAE/F,gEAAgE;AAChE,SAAS;AACT,gEAAgE;AAEhE;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B,OAAO,CAAI;IAEX;;;;;;;;;;;;;OAaG;IACH,YAAY,MAAS;QACnB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,kCAAkC;IAClC,cAAc,CACZ,MAAgC,EAChC,QAA6C;QAE7C,OAAO,IAAA,kCAAc,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED,mCAAmC;IACnC,eAAe,CACb,MAAiC,EACjC,QAA8C;QAE9C,OAAO,IAAA,oCAAe,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,sCAAsC;IACtC,kBAAkB,CAChB,MAAoC,EACpC,QAAiD;QAEjD,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,oCAAoC;IACpC,gBAAgB,CACd,QAA+C;QAE/C,OAAO,IAAA,sCAAgB,EAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,6CAA6C;IAC7C,yBAAyB,CACvB,MAA2C,EAC3C,QAAwD;QAExD,OAAO,IAAA,wDAAyB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAUD,OAAO,CACL,gBAAoE,EACpE,aAA4C;QAE5C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;QAC5F,OAAO,IAAA,oBAAO,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAUD,SAAS,CACP,gBAAwE,EACxE,aAA8C;QAE9C,MAAM,MAAM,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAC9E,MAAM,QAAQ,GAAG,OAAO,gBAAgB,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAc,CAAC;QAC5F,OAAO,IAAA,wBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,uBAAuB;IACvB,GAAG,CACD,MAAqB,EACrB,QAAkC;QAElC,OAAO,IAAA,YAAG,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,0BAA0B;IAC1B,MAAM,CACJ,MAAwB,EACxB,QAAqC;QAErC,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,sCAAsC;IACtC,kBAAkB,CAChB,MAAoC,EACpC,QAAiD;QAEjD,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,iCAAiC;IACjC,aAAa,CACX,QAA4C;QAE5C,OAAO,IAAA,gCAAa,EAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,+BAA+B;IAC/B,WAAW,CACT,QAA0C;QAE1C,OAAO,IAAA,4BAAW,EAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,0BAA0B;IAC1B,MAAM,CACJ,MAAwB,EACxB,QAAqC;QAErC,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,gCAAgC;IAChC,YAAY,CACV,MAA8B,EAC9B,QAA2C;QAE3C,OAAO,IAAA,8BAAY,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,8BAA8B;IAC9B,UAAU,CACR,MAA4B,EAC5B,QAAyC;QAEzC,OAAO,IAAA,0BAAU,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,gCAAgC;IAChC,YAAY,CACV,MAA8B,EAC9B,QAA2C;QAE3C,OAAO,IAAA,8BAAY,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,iCAAiC;IACjC,aAAa,CACX,QAA4C;QAE5C,OAAO,IAAA,gCAAa,EAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,6BAA6B;IAC7B,SAAS,CACP,MAA2B,EAC3B,QAAwC;QAExC,OAAO,IAAA,wBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,0BAA0B;IAC1B,MAAM,CACJ,MAAwB,EACxB,QAAqC;QAErC,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,8BAA8B;IAC9B,UAAU,CACR,MAA4B,EAC5B,QAAyC;QAEzC,OAAO,IAAA,0BAAU,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,8BAA8B;IAC9B,UAAU,CACR,MAA4B,EAC5B,QAAyC;QAEzC,OAAO,IAAA,0BAAU,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,6BAA6B;IAC7B,SAAS,CACP,MAA2B,EAC3B,QAAwC;QAExC,OAAO,IAAA,wBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,gCAAgC;IAChC,YAAY,CACV,MAA8B,EAC9B,QAA2C;QAE3C,OAAO,IAAA,8BAAY,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,wCAAwC;IACxC,oBAAoB,CAClB,MAAsC,EACtC,QAAmD;QAEnD,OAAO,IAAA,8CAAoB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,+CAA+C;IAC/C,2BAA2B,CACzB,MAA6C,EAC7C,QAA0D;QAE1D,OAAO,IAAA,4DAA2B,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,mCAAmC;IACnC,eAAe,CACb,MAAiC,EACjC,QAA8C;QAE9C,OAAO,IAAA,oCAAe,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,sCAAsC;IACtC,kBAAkB,CAChB,MAAoC,EACpC,QAAiD;QAEjD,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,4BAA4B;IAC5B,QAAQ,CACN,MAA0B,EAC1B,QAAuC;QAEvC,OAAO,IAAA,sBAAQ,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,4BAA4B;IAC5B,QAAQ,CACN,MAA0B,EAC1B,QAAuC;QAEvC,OAAO,IAAA,sBAAQ,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;CACF;AA1QD,gDA0QC"}

package/script/src/api/subscription/mod.d.ts

@@ -0,0 +1,55 @@
+/**
+ * This module re-exports all subscription-related API request functions and types.
+ *
+ * You can use raw functions to maximize tree-shaking in your app,
+ * or to access {@link https://github.com/fabian-hiller/valibot | valibot} schemas Request/Response.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { candle } from "@nktkas/hyperliquid/api/subscription";
+ * //       ^^^^^^
+ * //       same name as in `SubscriptionClient`
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await candle(
+ *   { transport }, // same params as in `SubscriptionClient`
+ *   { coin: "ETH", interval: "1h" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @module
+ */
+export type { SubscriptionConfig } from "./_methods/_types.js";
+export * from "./_methods/activeAssetCtx.js";
+export * from "./_methods/activeAssetData.js";
+export * from "./_methods/activeSpotAssetCtx.js";
+export * from "./_methods/allDexsAssetCtxs.js";
+export * from "./_methods/allDexsClearinghouseState.js";
+export * from "./_methods/allMids.js";
+export * from "./_methods/assetCtxs.js";
+export * from "./_methods/bbo.js";
+export * from "./_methods/candle.js";
+export * from "./_methods/clearinghouseState.js";
+export * from "./_methods/explorerBlock.js";
+export * from "./_methods/explorerTxs.js";
+export * from "./_methods/l2Book.js";
+export * from "./_methods/notification.js";
+export * from "./_methods/openOrders.js";
+export * from "./_methods/orderUpdates.js";
+export * from "./_methods/spotAssetCtxs.js";
+export * from "./_methods/spotState.js";
+export * from "./_methods/trades.js";
+export * from "./_methods/twapStates.js";
+export * from "./_methods/userEvents.js";
+export * from "./_methods/userFills.js";
+export * from "./_methods/userFundings.js";
+export * from "./_methods/userHistoricalOrders.js";
+export * from "./_methods/userNonFundingLedgerUpdates.js";
+export * from "./_methods/userTwapHistory.js";
+export * from "./_methods/userTwapSliceFills.js";
+export * from "./_methods/webData2.js";
+export * from "./_methods/webData3.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/src/api/subscription/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC"}

package/script/src/api/subscription/mod.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * This module re-exports all subscription-related API request functions and types.
+ *
+ * You can use raw functions to maximize tree-shaking in your app,
+ * or to access {@link https://github.com/fabian-hiller/valibot | valibot} schemas Request/Response.
+ *
+ * @example
+ * ```ts
+ * import { WebSocketTransport } from "@nktkas/hyperliquid";
+ * import { candle } from "@nktkas/hyperliquid/api/subscription";
+ * //       ^^^^^^
+ * //       same name as in `SubscriptionClient`
+ *
+ * const transport = new WebSocketTransport();
+ *
+ * const sub = await candle(
+ *   { transport }, // same params as in `SubscriptionClient`
+ *   { coin: "ETH", interval: "1h" },
+ *   (data) => console.log(data),
+ * );
+ * ```
+ *
+ * @module
+ */
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./_methods/activeAssetCtx.js"), exports);
+__exportStar(require("./_methods/activeAssetData.js"), exports);
+__exportStar(require("./_methods/activeSpotAssetCtx.js"), exports);
+__exportStar(require("./_methods/allDexsAssetCtxs.js"), exports);
+__exportStar(require("./_methods/allDexsClearinghouseState.js"), exports);
+__exportStar(require("./_methods/allMids.js"), exports);
+__exportStar(require("./_methods/assetCtxs.js"), exports);
+__exportStar(require("./_methods/bbo.js"), exports);
+__exportStar(require("./_methods/candle.js"), exports);
+__exportStar(require("./_methods/clearinghouseState.js"), exports);
+__exportStar(require("./_methods/explorerBlock.js"), exports);
+__exportStar(require("./_methods/explorerTxs.js"), exports);
+__exportStar(require("./_methods/l2Book.js"), exports);
+__exportStar(require("./_methods/notification.js"), exports);
+__exportStar(require("./_methods/openOrders.js"), exports);
+__exportStar(require("./_methods/orderUpdates.js"), exports);
+__exportStar(require("./_methods/spotAssetCtxs.js"), exports);
+__exportStar(require("./_methods/spotState.js"), exports);
+__exportStar(require("./_methods/trades.js"), exports);
+__exportStar(require("./_methods/twapStates.js"), exports);
+__exportStar(require("./_methods/userEvents.js"), exports);
+__exportStar(require("./_methods/userFills.js"), exports);
+__exportStar(require("./_methods/userFundings.js"), exports);
+__exportStar(require("./_methods/userHistoricalOrders.js"), exports);
+__exportStar(require("./_methods/userNonFundingLedgerUpdates.js"), exports);
+__exportStar(require("./_methods/userTwapHistory.js"), exports);
+__exportStar(require("./_methods/userTwapSliceFills.js"), exports);
+__exportStar(require("./_methods/webData2.js"), exports);
+__exportStar(require("./_methods/webData3.js"), exports);
+//# sourceMappingURL=mod.js.map

package/script/src/api/subscription/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/mod.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;;;;;;;;;;;AAIH,+DAA6C;AAC7C,gEAA8C;AAC9C,mEAAiD;AACjD,iEAA+C;AAC/C,0EAAwD;AACxD,wDAAsC;AACtC,0DAAwC;AACxC,oDAAkC;AAClC,uDAAqC;AACrC,mEAAiD;AACjD,8DAA4C;AAC5C,4DAA0C;AAC1C,uDAAqC;AACrC,6DAA2C;AAC3C,2DAAyC;AACzC,6DAA2C;AAC3C,8DAA4C;AAC5C,0DAAwC;AACxC,uDAAqC;AACrC,2DAAyC;AACzC,2DAAyC;AACzC,0DAAwC;AACxC,6DAA2C;AAC3C,qEAAmD;AACnD,4EAA0D;AAC1D,gEAA8C;AAC9C,mEAAiD;AACjD,yDAAuC;AACvC,yDAAuC"}

package/script/src/mod.d.ts

@@ -1,9 +1,35 @@
-export { HyperliquidError } from "./_base.js";
-export { SchemaError } from "./api/_base.js";
-export * from "./transport/base.js";
-export * from "./transport/http/mod.js";
-export * from "./transport/websocket/mod.js";
-export * from "./api/exchange/~client.js";
-export * from "./api/info/~client.js";
-export * from "./api/subscription/~client.js";
+/**
+ * Hyperliquid API TypeScript SDK.
+ *
+ * The main entrypoint exports:
+ * - Transports: {@link HttpTransport}, {@link WebSocketTransport}
+ * - Clients: {@link InfoClient}, {@link ExchangeClient}, {@link SubscriptionClient}
+ *
+ * For tree-shakeable, low-level access you can import request methods directly from:
+ * - `@nktkas/hyperliquid/api/info`
+ * - `@nktkas/hyperliquid/api/exchange`
+ * - `@nktkas/hyperliquid/api/subscription`
+ *
+ * Extra utilities are available in:
+ * - `@nktkas/hyperliquid/utils` (formatting, symbol conversion)
+ * - `@nktkas/hyperliquid/signing` (low-level signing helpers)
+ *
+ * @example Quick start
+ * ```ts
+ * import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";
+ *
+ * const transport = new HttpTransport();
+ * const info = new InfoClient({ transport });
+ *
+ * const mids = await info.allMids();
+ * console.log(mids);
+ * ```
+ *
+ * @module
+ */
+export * from "./_base.js";
+export * from "./transport/mod.js";
+export * from "./api/exchange/client.js";
+export * from "./api/info/client.js";
+export * from "./api/subscription/client.js";
 //# sourceMappingURL=mod.d.ts.map

package/script/src/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AAEpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC"}

package/script/src/mod.js

@@ -1,4 +1,33 @@
 "use strict";
+/**
+ * Hyperliquid API TypeScript SDK.
+ *
+ * The main entrypoint exports:
+ * - Transports: {@link HttpTransport}, {@link WebSocketTransport}
+ * - Clients: {@link InfoClient}, {@link ExchangeClient}, {@link SubscriptionClient}
+ *
+ * For tree-shakeable, low-level access you can import request methods directly from:
+ * - `@nktkas/hyperliquid/api/info`
+ * - `@nktkas/hyperliquid/api/exchange`
+ * - `@nktkas/hyperliquid/api/subscription`
+ *
+ * Extra utilities are available in:
+ * - `@nktkas/hyperliquid/utils` (formatting, symbol conversion)
+ * - `@nktkas/hyperliquid/signing` (low-level signing helpers)
+ *
+ * @example Quick start
+ * ```ts
+ * import { HttpTransport, InfoClient } from "@nktkas/hyperliquid";
+ *
+ * const transport = new HttpTransport();
+ * const info = new InfoClient({ transport });
+ *
+ * const mids = await info.allMids();
+ * console.log(mids);
+ * ```
+ *
+ * @module
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,15 +43,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaError = exports.HyperliquidError = void 0;
-var _base_js_1 = require("./_base.js");
-Object.defineProperty(exports, "HyperliquidError", { enumerable: true, get: function () { return _base_js_1.HyperliquidError; } });
-var _base_js_2 = require("./api/_base.js");
-Object.defineProperty(exports, "SchemaError", { enumerable: true, get: function () { return _base_js_2.SchemaError; } });
-__exportStar(require("./transport/base.js"), exports);
-__exportStar(require("./transport/http/mod.js"), exports);
-__exportStar(require("./transport/websocket/mod.js"), exports);
-__exportStar(require("./api/exchange/~client.js"), exports);
-__exportStar(require("./api/info/~client.js"), exports);
-__exportStar(require("./api/subscription/~client.js"), exports);
+__exportStar(require("./_base.js"), exports);
+__exportStar(require("./transport/mod.js"), exports);
+__exportStar(require("./api/exchange/client.js"), exports);
+__exportStar(require("./api/info/client.js"), exports);
+__exportStar(require("./api/subscription/client.js"), exports);
 //# sourceMappingURL=mod.js.map

package/script/src/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uCAA8C;AAArC,4GAAA,gBAAgB,OAAA;AACzB,2CAA6C;AAApC,uGAAA,WAAW,OAAA;AACpB,sDAAoC;AAEpC,0DAAwC;AACxC,+DAA6C;AAE7C,4DAA0C;AAC1C,wDAAsC;AACtC,gEAA8C"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../src/src/mod.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;;;;;;;;;;;;;;AAEH,6CAA2B;AAC3B,qDAAmC;AACnC,2DAAyC;AACzC,uDAAqC;AACrC,+DAA6C"}

package/script/src/signing/_abstractWallet.d.ts

@@ -0,0 +1,119 @@
+import { HyperliquidError } from "../_base.js";
+/** Abstract interface for an {@link https://docs.ethers.org/v6/api/providers/#Signer | ethers.js v6} */
+export interface AbstractEthersV6Signer {
+    signTypedData(domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    }, types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    }, value: Record<string, unknown>): Promise<string>;
+    getAddress(): Promise<string>;
+    provider?: {
+        getNetwork(): Promise<{
+            chainId: number | bigint;
+        }>;
+    } | null;
+}
+/** Abstract interface for an {@link https://docs.ethers.org/v5/api/signer/ | ethers.js v5} */
+export interface AbstractEthersV5Signer {
+    _signTypedData(domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    }, types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    }, value: Record<string, unknown>): Promise<string>;
+    getAddress(): Promise<string>;
+    provider?: {
+        getNetwork(): Promise<{
+            chainId: number | bigint;
+        }>;
+    } | null;
+}
+/** Abstract interface for a {@link https://viem.sh/docs/accounts/jsonRpc#json-rpc-account | viem JSON-RPC Account}. */
+export interface AbstractViemJsonRpcAccount {
+    signTypedData(params: {
+        domain: {
+            name: string;
+            version: string;
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            [key: string]: {
+                name: string;
+                type: string;
+            }[];
+        };
+        primaryType: string;
+        message: Record<string, unknown>;
+    }, options?: unknown): Promise<`0x${string}`>;
+    getAddresses(): Promise<`0x${string}`[]>;
+    getChainId(): Promise<number>;
+}
+/** Abstract interface for a {@link https://viem.sh/docs/accounts/local | viem Local Account}. */
+export interface AbstractViemLocalAccount {
+    signTypedData(params: {
+        domain: {
+            name: string;
+            version: string;
+            chainId: number;
+            verifyingContract: `0x${string}`;
+        };
+        types: {
+            [key: string]: {
+                name: string;
+                type: string;
+            }[];
+        };
+        primaryType: string;
+        message: Record<string, unknown>;
+    }, options?: unknown): Promise<`0x${string}`>;
+    address: `0x${string}`;
+}
+/** Abstract interface for a wallet that can sign typed data. */
+export type AbstractWallet = AbstractViemJsonRpcAccount | AbstractViemLocalAccount | AbstractEthersV6Signer | AbstractEthersV5Signer;
+/** ECDSA signature components. */
+export interface Signature {
+    /** First 32-byte component of ECDSA signature */
+    r: `0x${string}`;
+    /** Second 32-byte component of ECDSA signature */
+    s: `0x${string}`;
+    /** Recovery identifier */
+    v: 27 | 28;
+}
+/** Thrown when an error occurs in AbstractWallet operations (e.g., signing, getting address). */
+export declare class AbstractWalletError extends HyperliquidError {
+    constructor(message: string, options?: ErrorOptions);
+}
+export declare function signTypedData(args: {
+    wallet: AbstractWallet;
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: `0x${string}`;
+    };
+    types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    };
+    primaryType: string;
+    message: Record<string, unknown>;
+}): Promise<Signature>;
+/** Get the chain ID of the wallet. */
+export declare function getWalletChainId(wallet: AbstractWallet): Promise<`0x${string}`>;
+/** Get the lowercase wallet address from various wallet types. */
+export declare function getWalletAddress(wallet: AbstractWallet): Promise<`0x${string}`>;
+//# sourceMappingURL=_abstractWallet.d.ts.map

package/script/src/signing/_abstractWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_abstractWallet.d.ts","sourceRoot":"","sources":["../../../src/src/signing/_abstractWallet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAM/C,wGAAwG;AACxG,MAAM,WAAW,sBAAsB;IACrC,aAAa,CACX,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,EACD,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SACd,EAAE,CAAC;KACL,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,QAAQ,CAAC,EACL;QAAE,UAAU,IAAI,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,GACvD,IAAI,CAAC;CACV;AAqBD,8FAA8F;AAC9F,MAAM,WAAW,sBAAsB;IACrC,cAAc,CACZ,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,EACD,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SACd,EAAE,CAAC;KACL,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,QAAQ,CAAC,EACL;QAAE,UAAU,IAAI,OAAO,CAAC;YAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,GACvD,IAAI,CAAC;CACV;AAqBD,uHAAuH;AACvH,MAAM,WAAW,0BAA0B;IACzC,aAAa,CACX,MAAM,EAAE;QACN,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAC;SAClC,CAAC;QACF,KAAK,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG;gBACb,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aACd,EAAE,CAAC;SACL,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,EACD,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC;IAC1B,YAAY,IAAI,OAAO,CAAC,KAAK,MAAM,EAAE,EAAE,CAAC,CAAC;IACzC,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;AAaD,iGAAiG;AACjG,MAAM,WAAW,wBAAwB;IACvC,aAAa,CACX,MAAM,EAAE;QACN,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAC;SAClC,CAAC;QACF,KAAK,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG;gBACb,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aACd,EAAE,CAAC;SACL,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,EACD,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC;IAC1B,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;CACxB;AAgBD,gEAAgE;AAChE,MAAM,MAAM,cAAc,GACtB,0BAA0B,GAC1B,wBAAwB,GACxB,sBAAsB,GACtB,sBAAsB,CAAC;AAE3B,kCAAkC;AAClC,MAAM,WAAW,SAAS;IACxB,iDAAiD;IACjD,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IACjB,kDAAkD;IAClD,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IACjB,0BAA0B;IAC1B,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC;CACZ;AAED,iGAAiG;AACjG,qBAAa,mBAAoB,SAAQ,gBAAgB;gBAC3C,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD;AAED,wBAAsB,aAAa,CAAC,IAAI,EAAE;IACxC,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAC;KAClC,CAAC;IACF,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SACd,EAAE,CAAC;KACL,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,GAAG,OAAO,CAAC,SAAS,CAAC,CAwCrB;AAaD,sCAAsC;AACtC,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CA8BrF;AAED,kEAAkE;AAClE,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAqBrF"}