@hfunlabs/hyperliquid 0.29.1-hfunlabs.1 → 0.30.0-hfunlabs.1

package/script/src/utils/{symbolConverter.js → _symbolConverter.js}

@@ -31,14 +31,20 @@ const mod_js_1 = require("../api/info/mod.js");
  * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
  */
 class SymbolConverter {
-    transport;
-    dexOption;
-    nameToAssetId = new Map();
-    nameToSzDecimals = new Map();
-    nameToSpotPairId = new Map();
+    #transport;
+    #dexOption;
+    #nameToAssetId = new Map();
+    #nameToSzDecimals = new Map();
+    #nameToSpotPairId = new Map();
+    /**
+     * Creates a new SymbolConverter instance, but does not initialize it.
+     * Run {@link reload} to load asset data or use {@link create} to create and initialize in one step.
+     *
+     * @param options - Configuration options including transport and optional dex support.
+     */
     constructor(options) {
-        this.transport = options.transport;
-        this.dexOption = options.dexs ?? false;
+        this.#transport = options.transport;
+        this.#dexOption = options.dexs ?? false;
     }
     /**
      * Create and initialize a SymbolConverter instance.
@@ -63,11 +69,12 @@ class SymbolConverter {
     }
     /**
      * Reload asset mappings from the API.
+     *
      * Useful for refreshing data when new assets are added.
      */
     async reload() {
-        const config = { transport: this.transport };
-        const needDexs = this.dexOption === true || (Array.isArray(this.dexOption) && this.dexOption.length > 0);
+        const config = { transport: this.#transport };
+        const needDexs = this.#dexOption === true || (Array.isArray(this.#dexOption) && this.#dexOption.length > 0);
         const [perpMetaData, spotMetaData, perpDexsData] = await Promise.all([
             (0, mod_js_1.meta)(config),
             (0, mod_js_1.spotMeta)(config),
@@ -79,23 +86,23 @@ class SymbolConverter {
         if (!spotMetaData?.universe?.length || !spotMetaData?.tokens?.length) {
             throw new Error("Invalid spot metadata response");
         }
-        this.nameToAssetId.clear();
-        this.nameToSzDecimals.clear();
-        this.nameToSpotPairId.clear();
-        this.processDefaultPerps(perpMetaData);
-        this.processSpotAssets(spotMetaData);
+        this.#nameToAssetId.clear();
+        this.#nameToSzDecimals.clear();
+        this.#nameToSpotPairId.clear();
+        this.#processDefaultPerps(perpMetaData);
+        this.#processSpotAssets(spotMetaData);
         // Only process builder dexs if dex support is enabled
         if (perpDexsData) {
-            await this.processBuilderDexs(perpDexsData);
+            await this.#processBuilderDexs(perpDexsData);
         }
     }
-    processDefaultPerps(perpMetaData) {
+    #processDefaultPerps(perpMetaData) {
         perpMetaData.universe.forEach((asset, index) => {
-            this.nameToAssetId.set(asset.name, index);
-            this.nameToSzDecimals.set(asset.name, asset.szDecimals);
+            this.#nameToAssetId.set(asset.name, index);
+            this.#nameToSzDecimals.set(asset.name, asset.szDecimals);
         });
     }
-    async processBuilderDexs(perpDexsData) {
+    async #processBuilderDexs(perpDexsData) {
         if (!perpDexsData || perpDexsData.length <= 1)
             return;
         const builderDexs = perpDexsData
@@ -106,28 +113,28 @@ class SymbolConverter {
         if (builderDexs.length === 0)
             return;
         // Filter dexs based on the dexOption
-        const dexsToProcess = Array.isArray(this.dexOption)
-            ? builderDexs.filter((item) => this.dexOption.includes(item.dex.name))
+        const dexsToProcess = Array.isArray(this.#dexOption)
+            ? builderDexs.filter((item) => this.#dexOption.includes(item.dex.name))
             : builderDexs; // true means process all
         if (dexsToProcess.length === 0)
             return;
-        const config = { transport: this.transport };
+        const config = { transport: this.#transport };
         const results = await Promise.allSettled(dexsToProcess.map((item) => (0, mod_js_1.meta)(config, { dex: item.dex.name })));
         results.forEach((result, idx) => {
             if (result.status !== "fulfilled")
                 return;
-            this.processBuilderDexResult(result.value, dexsToProcess[idx].index);
+            this.#processBuilderDexResult(result.value, dexsToProcess[idx].index);
         });
     }
-    processBuilderDexResult(dexMeta, perpDexIndex) {
+    #processBuilderDexResult(dexMeta, perpDexIndex) {
         const offset = 100000 + perpDexIndex * 10000;
         dexMeta.universe.forEach((asset, index) => {
             const assetId = offset + index;
-            this.nameToAssetId.set(asset.name, assetId);
-            this.nameToSzDecimals.set(asset.name, asset.szDecimals);
+            this.#nameToAssetId.set(asset.name, assetId);
+            this.#nameToSzDecimals.set(asset.name, asset.szDecimals);
         });
     }
-    processSpotAssets(spotMetaData) {
+    #processSpotAssets(spotMetaData) {
         const tokenMap = new Map();
         spotMetaData.tokens.forEach((token) => {
             tokenMap.set(token.index, { name: token.name, szDecimals: token.szDecimals });
@@ -141,9 +148,9 @@ class SymbolConverter {
                 return;
             const assetId = 10000 + market.index;
             const baseQuoteKey = `${baseToken.name}/${quoteToken.name}`;
-            this.nameToAssetId.set(baseQuoteKey, assetId);
-            this.nameToSzDecimals.set(baseQuoteKey, baseToken.szDecimals);
-            this.nameToSpotPairId.set(baseQuoteKey, market.name);
+            this.#nameToAssetId.set(baseQuoteKey, assetId);
+            this.#nameToSzDecimals.set(baseQuoteKey, baseToken.szDecimals);
+            this.#nameToSpotPairId.set(baseQuoteKey, market.name);
         });
     }
     /**
@@ -155,7 +162,7 @@ class SymbolConverter {
      * @example "BTC" → 0, "HYPE/USDC" → 10107, "test:ABC" → 110000
      */
     getAssetId(name) {
-        return this.nameToAssetId.get(name);
+        return this.#nameToAssetId.get(name);
     }
     /**
      * Get size decimals for a coin.
@@ -166,7 +173,7 @@ class SymbolConverter {
      * @example "BTC" → 5, "HYPE/USDC" → 2, "test:ABC" → 0
      */
     getSzDecimals(name) {
-        return this.nameToSzDecimals.get(name);
+        return this.#nameToSzDecimals.get(name);
     }
     /**
      * Get spot pair ID for info endpoints and subscriptions (e.g., l2book, trades).
@@ -176,8 +183,8 @@ class SymbolConverter {
      * @example "HFUN/USDC" → "@2", "PURR/USDC" → "PURR/USDC"
      */
     getSpotPairId(name) {
-        return this.nameToSpotPairId.get(name);
+        return this.#nameToSpotPairId.get(name);
     }
 }
 exports.SymbolConverter = SymbolConverter;
-//# sourceMappingURL=symbolConverter.js.map
+//# sourceMappingURL=_symbolConverter.js.map

package/script/src/utils/_symbolConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_symbolConverter.js","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":";;;AACA,+CAO4B;AAU5B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,eAAe;IAC1B,UAAU,CAAoB;IAC9B,UAAU,CAAqB;IAC/B,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC9C,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C;;;;;OAKG;IACH,YAAY,OAA+B;QACzC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAA+B;QACjD,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE5G,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnE,IAAA,aAAI,EAAC,MAAM,CAAC;YACZ,IAAA,iBAAQ,EAAC,MAAM,CAAC;YAChB,QAAQ,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACxC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAE/B,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAEtC,sDAAsD;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,oBAAoB,CAAC,YAA0B;QAC7C,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC3C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,YAA8B;QACtD,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,IAAI,CAAC;YAAE,OAAO;QAEtD,MAAM,WAAW,GAAG,YAAY;aAC7B,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;aACrC,MAAM,CAAC,CAAC,IAAI,EAAyE,EAAE;YACtF,OAAO,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEL,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAErC,qCAAqC;QACrC,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;YAClD,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAE,IAAI,CAAC,UAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACrF,CAAC,CAAC,WAAW,CAAC,CAAC,yBAAyB;QAE1C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEvC,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,aAAI,EAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAClE,CAAC;QAEF,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YAC9B,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;gBAAE,OAAO;YAC1C,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB,CAAC,OAAqB,EAAE,YAAoB;QAClE,MAAM,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC;QAE7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,CAAC,YAA8B;QAC/C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgD,CAAC;QACzE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACpC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO;YACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU;gBAAE,OAAO;YAEtC,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YACrC,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC/C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;YAC/D,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF;AAhLD,0CAgLC"}

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

@@ -1,3 +1,27 @@
-export * from "./symbolConverter.js";
-export * from "./format.js";
+/**
+ * Utility helpers for working with Hyperliquid.
+ *
+ * This module re-exports utilities for:
+ * - Formatting prices and sizes according to Hyperliquid's {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | tick and lot size rules} ({@link formatPrice}, {@link formatSize}).
+ * - Converting human-readable asset symbols to Hyperliquid asset IDs ({@link SymbolConverter}).
+ *
+ * @example Formatting values for an order
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { formatPrice, formatSize, SymbolConverter } from "@nktkas/hyperliquid/utils";
+ *
+ * const transport = new HttpTransport();
+ * const converter = await SymbolConverter.create({ transport });
+ *
+ * const symbol = "BTC";
+ * const szDecimals = converter.getSzDecimals(symbol) ?? 0;
+ *
+ * const price = formatPrice("97123.456789", szDecimals); // → "97123"
+ * const size = formatSize("0.00123456789", szDecimals); // → "0.00123"
+ * ```
+ *
+ * @module
+ */
+export * from "./_symbolConverter.js";
+export * from "./_format.js";
 //# sourceMappingURL=mod.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC"}

package/script/src/utils/mod.js

@@ -1,4 +1,28 @@
 "use strict";
+/**
+ * Utility helpers for working with Hyperliquid.
+ *
+ * This module re-exports utilities for:
+ * - Formatting prices and sizes according to Hyperliquid's {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | tick and lot size rules} ({@link formatPrice}, {@link formatSize}).
+ * - Converting human-readable asset symbols to Hyperliquid asset IDs ({@link SymbolConverter}).
+ *
+ * @example Formatting values for an order
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { formatPrice, formatSize, SymbolConverter } from "@nktkas/hyperliquid/utils";
+ *
+ * const transport = new HttpTransport();
+ * const converter = await SymbolConverter.create({ transport });
+ *
+ * const symbol = "BTC";
+ * const szDecimals = converter.getSzDecimals(symbol) ?? 0;
+ *
+ * const price = formatPrice("97123.456789", szDecimals); // → "97123"
+ * const size = formatSize("0.00123456789", szDecimals); // → "0.00123"
+ * ```
+ *
+ * @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,6 +38,6 @@ 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("./symbolConverter.js"), exports);
-__exportStar(require("./format.js"), exports);
+__exportStar(require("./_symbolConverter.js"), exports);
+__exportStar(require("./_format.js"), exports);
 //# sourceMappingURL=mod.js.map

package/script/src/utils/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,8CAA4B"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;;;;;;;;;;;AAEH,wDAAsC;AACtC,+CAA6B"}

package/src/bin/_utils.ts

@@ -1,3 +1,22 @@
+/**
+ * Utility functions for command-line argument parsing and transformation.
+ * More useful for working with proxy arguments.
+ *
+ * @example
+ * ```ts
+ * import { extractArgs, transformArgs } from "./_utils.ts";
+ *
+ * const args = ["info", "meta", "--user", "0x1234", "--limit", "10", "--verbose"];
+ * const rawArgs = extractArgs(args, { flags: ["verbose"] });
+ * // { _: ["info", "meta"], user: "0x1234", limit: "10", verbose: "true" }
+ *
+ * const typedArgs = transformArgs(rawArgs);
+ * // { _: ["info", "meta"], user: "0x1234", limit: 10, verbose: true }
+ * ```
+ *
+ * @module
+ */
+
 // ============================================================
 // Extract Args
 // ============================================================

package/src/bin/cli.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+// deno-lint-ignore-file no-console
 
 /**
  * Command-line interface for interacting with Hyperliquid API.
@@ -7,6 +8,16 @@
  * ```sh
  * npx @nktkas/hyperliquid <endpoint> <method> [options]
  * ```
+ *
+ * @example Info Endpoint
+ * ```sh
+ * npx @nktkas/hyperliquid info clearinghouseState --user 0x...
+ * ```
+ *
+ * @example Exchange Endpoint
+ * ```sh
+ * npx @nktkas/hyperliquid exchange withdraw3 --private-key 0x... --destination 0x... --amount 100.5
+ * ```
  */
 
 // @ts-ignore: Ignore missing TS types when building npm
@@ -19,7 +30,7 @@ import { PrivateKeySigner } from "../src/signing/mod.js";
 // Execute
 // ============================================================
 
-function transformParams(method: string, params: Args<false>) {
+function transformParams(method: string, params: Args<false>): Record<string, unknown> {
   switch (method) {
     case "spotUser": {
       return { toggleSpotDusting: { ...params } };
@@ -85,7 +96,7 @@ async function executeEndpointMethod(endpoint: string, method: string, args: Arg
 // CLI
 // ============================================================
 
-function printHelp() {
+function printHelp(): void {
   console.log(`Hyperliquid CLI
 
 Usage:

package/src/src/_base.ts

@@ -0,0 +1,7 @@
+/** Base error class for all SDK errors. */
+export class HyperliquidError extends Error {
+  constructor(message?: string, options?: ErrorOptions) {
+    super(message, options);
+    this.name = "HyperliquidError";
+  }
+}

package/src/src/api/_schemas.ts

@@ -1,10 +1,16 @@
+// deno-lint-ignore-file valibot-project/require-name-suffix valibot-project/require-jsdoc valibot-project/require-description
+
 import * as v from "valibot";
 
+// ============================================================
+// Number
+// ============================================================
+
 export const UnsignedDecimal = /* @__PURE__ */ (() => {
   return v.pipe(
     v.union([v.string(), v.number()]),
-    v.transform(String),
-    v.string(),
+    v.toString(),
+    v.string(), // HACK: for correct JSONSchema generation
     v.transform((value) => formatDecimalString(value)),
     v.regex(/^[0-9]+(\.[0-9]+)?$/),
   );
@@ -14,8 +20,8 @@ export type UnsignedDecimal = v.InferOutput<typeof UnsignedDecimal>;
 export const Decimal = /* @__PURE__ */ (() => {
   return v.pipe(
     v.union([v.string(), v.number()]),
-    v.transform(String),
-    v.string(),
+    v.toString(),
+    v.string(), // HACK: for correct JSONSchema generation
     v.transform((value) => formatDecimalString(value)),
     v.regex(/^-?[0-9]+(\.[0-9]+)?$/),
   );
@@ -25,9 +31,8 @@ export type Decimal = v.InferOutput<typeof Decimal>;
 export const Integer = /* @__PURE__ */ (() => {
   return v.pipe(
     v.union([v.string(), v.number()]),
-    v.transform(Number),
-    v.number(),
-    v.integer(),
+    v.toNumber(),
+    v.number(), // HACK: for correct JSONSchema generation
     v.safeInteger(),
   );
 })();
@@ -36,15 +41,34 @@ export type Integer = v.InferOutput<typeof Integer>;
 export const UnsignedInteger = /* @__PURE__ */ (() => {
   return v.pipe(
     v.union([v.string(), v.number()]),
-    v.transform(Number),
-    v.number(),
-    v.integer(),
+    v.toNumber(),
+    v.number(), // HACK: for correct JSONSchema generation
     v.safeInteger(),
     v.minValue(0),
   );
 })();
 export type UnsignedInteger = v.InferOutput<typeof UnsignedInteger>;
 
+function formatDecimalString(value: string): string {
+  return value
+    // remove leading/trailing whitespace
+    .trim() // "  123.45  " → "123.45"
+    // remove leading zeros
+    .replace(/^(-?)0+(?=\d)/, "$1") // "00123" → "123", "-00.5" → "-0.5"
+    // remove trailing zeros
+    .replace(/\.0*$|(\.\d+?)0+$/, "$1") // "1.2000" → "1.2", "5.0" → "5"
+    // add leading zero if starts with decimal point
+    .replace(/^(-?)\./, "$10.") // ".5" → "0.5", "-.5" → "-0.5"
+    // add "0" if string is empty after trimming
+    .replace(/^-?$/, "0") // "" → "0", "-" → "0"
+    // normalize negative zero
+    .replace(/^-0$/, "0"); // "-0" → "0"
+}
+
+// ============================================================
+// Hex
+// ============================================================
+
 export const Hex = /* @__PURE__ */ (() => {
   return v.pipe(
     v.string(),
@@ -59,14 +83,14 @@ export const Address = /* @__PURE__ */ (() => {
 })();
 export type Address = v.InferOutput<typeof Address>;
 
-export const TokenId = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.string(),
-    v.regex(/^[^:]+:0x[0-9a-fA-F]+$/),
-    v.transform((value) => value as `${string}:${Hex}`),
-  );
+export const Cloid = /* @__PURE__ */ (() => {
+  return v.pipe(Hex, v.length(34));
 })();
-export type TokenId = v.InferOutput<typeof TokenId>;
+export type Cloid = v.InferOutput<typeof Cloid>;
+
+// ============================================================
+// Other
+// ============================================================
 
 export const Percent = /* @__PURE__ */ (() => {
   return v.pipe(
@@ -84,19 +108,3 @@ export const ISO8601WithoutTimezone = /* @__PURE__ */ (() => {
   );
 })();
 export type ISO8601WithoutTimezone = v.InferOutput<typeof ISO8601WithoutTimezone>;
-
-function formatDecimalString(value: string): string {
-  return value
-    // remove leading/trailing whitespace
-    .trim() // "  123.45  " → "123.45"
-    // remove leading zeros
-    .replace(/^(-?)0+(?=\d)/, "$1") // "00123" → "123", "-00.5" → "-0.5"
-    // remove trailing zeros
-    .replace(/\.0*$|(\.\d+?)0+$/, "$1") // "1.2000" → "1.2", "5.0" → "5"
-    // add leading zero if starts with decimal point
-    .replace(/^(-?)\./, "$10.") // ".5" → "0.5", "-.5" → "-0.5"
-    // add "0" if string is empty after trimming
-    .replace(/^-?$/, "0") // "" → "0", "-" → "0"
-    // normalize negative zero
-    .replace(/^-0$/, "0"); // "-0" → "0"
-}

package/src/src/api/exchange/_methods/_base/_nonce.ts

@@ -3,22 +3,22 @@
  * Uses lazy cleanup: removes entries when Date.now() > lastNonce.
  */
 class NonceManager {
-  private readonly map = new Map<string, number>();
+  #map = new Map<string, number>();
 
   getNonce(key: string): number {
     const now = Date.now();
-    this.cleanup(now);
+    this.#cleanup(now);
 
-    const lastNonce = this.map.get(key) ?? 0;
+    const lastNonce = this.#map.get(key) ?? 0;
     const nonce = now > lastNonce ? now : lastNonce + 1;
-    this.map.set(key, nonce);
+    this.#map.set(key, nonce);
     return nonce;
   }
 
-  private cleanup(now: number): void {
-    for (const [key, lastNonce] of this.map) {
+  #cleanup(now: number): void {
+    for (const [key, lastNonce] of this.#map) {
       if (now > lastNonce) {
-        this.map.delete(key);
+        this.#map.delete(key);
       }
     }
   }

package/src/src/api/exchange/_methods/_base/{schemas.ts → commonSchemas.ts}

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-import { Hex, UnsignedInteger } from "../../../_schemas.js";
+import { Hex } from "../../../_schemas.js";
 
 /** Error response for failed operations. */
 export const ErrorResponse = /* @__PURE__ */ (() => {
@@ -48,17 +48,19 @@ export const SuccessResponse = /* @__PURE__ */ (() => {
 export type SuccessResponse = v.InferOutput<typeof SuccessResponse>;
 
 /** ECDSA signature components. */
-export const Signature = /* @__PURE__ */ (() => {
+export const SignatureSchema = /* @__PURE__ */ (() => {
   return v.pipe(
     v.object({
       /** First 32-byte component. */
       r: v.pipe(
-        v.pipe(Hex, v.length(66)),
+        Hex,
+        v.length(66),
         v.description("First 32-byte component."),
       ),
       /** Second 32-byte component. */
       s: v.pipe(
-        v.pipe(Hex, v.length(66)),
+        Hex,
+        v.length(66),
         v.description("Second 32-byte component."),
       ),
       /** Recovery identifier. */
@@ -70,31 +72,13 @@ export const Signature = /* @__PURE__ */ (() => {
     v.description("ECDSA signature components."),
   );
 })();
-export type Signature = v.InferOutput<typeof Signature>;
-
-/** Nonce (timestamp in ms) used to prevent replay attacks. */
-export const Nonce = /* @__PURE__ */ (() => {
-  return v.pipe(
-    UnsignedInteger,
-    v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-  );
-})();
-export type Nonce = v.InferOutput<typeof Nonce>;
-
-/** Chain ID in hex format for EIP-712 signing. */
-export const SignatureChainId = /* @__PURE__ */ (() => {
-  return v.pipe(
-    Hex,
-    v.description("Chain ID in hex format for EIP-712 signing."),
-  );
-})();
-export type SignatureChainId = v.InferOutput<typeof SignatureChainId>;
+export type SignatureSchema = v.InferOutput<typeof SignatureSchema>;
 
 /** HyperLiquid network type. */
-export const HyperliquidChain = /* @__PURE__ */ (() => {
+export const HyperliquidChainSchema = /* @__PURE__ */ (() => {
   return v.pipe(
     v.picklist(["Mainnet", "Testnet"]),
     v.description("HyperLiquid network type."),
   );
 })();
-export type HyperliquidChain = v.InferOutput<typeof HyperliquidChain>;
+export type HyperliquidChainSchema = v.InferOutput<typeof HyperliquidChainSchema>;

package/src/src/api/exchange/_methods/_base/errors.ts

@@ -1,4 +1,4 @@
-import { HyperliquidError } from "../../../../_errors.js";
+import { HyperliquidError } from "../../../../_base.js";
 
 // =============================================================
 // Error Detection (Duck Typing)

package/src/src/api/exchange/_methods/_base/execute.ts

@@ -1,6 +1,5 @@
 import * as v from "valibot";
-import type { HttpTransport } from "../../../../transport/http/mod.js";
-import type { WebSocketTransport } from "../../../../transport/websocket/mod.js";
+import type { IRequestTransport } from "../../../../transport/mod.js";
 import { Address, Hex, UnsignedInteger } from "../../../_schemas.js";
 import {
   type AbstractWallet,
@@ -13,7 +12,7 @@ import {
 import { assertSuccessResponse } from "./errors.js";
 import { defaultNonceManager } from "./_nonce.js";
 import { withLock } from "./_semaphore.js";
-import type { Signature } from "./schemas.js";
+import type { SignatureSchema } from "./commonSchemas.js";
 
 // =============================================================
 // Type Utilities
@@ -26,7 +25,7 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
 
 /** Options for any execute functions. */
 interface BaseOptions {
-  /** [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel a request. */
+  /** {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel a request. */
   signal?: AbortSignal;
 }
 
@@ -41,7 +40,7 @@ export type ExtractRequestOptions<T extends { action: Record<string, unknown> }>
 // =============================================================
 
 /** Base configuration shared by single-wallet and multi-sig configs. */
-interface BaseConfig<T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport> {
+interface BaseConfig<T extends IRequestTransport = IRequestTransport> {
   /** The transport used to connect to the Hyperliquid Exchange API. */
   transport: T;
 
@@ -69,17 +68,13 @@ interface BaseConfig<T extends HttpTransport | WebSocketTransport = HttpTranspor
 }
 
 /** Configuration for single-wallet Exchange API requests. */
-export interface ExchangeSingleWalletConfig<
-  T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport,
-> extends BaseConfig<T> {
+export interface ExchangeSingleWalletConfig<T extends IRequestTransport = IRequestTransport> extends BaseConfig<T> {
   /** The wallet used to sign requests. */
   wallet: AbstractWallet;
 }
 
 /** Configuration for multi-signature Exchange API requests. */
-export interface ExchangeMultiSigConfig<
-  T extends HttpTransport | WebSocketTransport = HttpTransport | WebSocketTransport,
-> extends BaseConfig<T> {
+export interface ExchangeMultiSigConfig<T extends IRequestTransport = IRequestTransport> extends BaseConfig<T> {
   /** Array of wallets for multi-sig. First wallet is the leader. */
   signers: readonly [AbstractWallet, ...AbstractWallet[]];
   /** The multi-signature account address. */
@@ -226,7 +221,7 @@ export async function executeUserSignedAction<T>(
 // =============================================================
 
 /** Remove leading zeros from signature components (required by Hyperliquid). */
-function trimSignature(sig: Signature): Signature {
+function trimSignature(sig: SignatureSchema): SignatureSchema {
   return {
     r: sig.r.replace(/^0x0+/, "0x") as `0x${string}`,
     s: sig.s.replace(/^0x0+/, "0x") as `0x${string}`,
@@ -242,7 +237,7 @@ async function signMultiSigL1(
   nonce: number,
   vaultAddress?: `0x${string}`,
   expiresAfter?: number,
-): Promise<[Record<string, unknown>, Signature]> {
+): Promise<[Record<string, unknown>, SignatureSchema]> {
   const { transport: { isTestnet }, signers, multiSigUser } = config;
   const multiSigUser_ = v.parse(Address, multiSigUser);
   const outerSigner_ = v.parse(Address, outerSigner);
@@ -292,7 +287,7 @@ async function signMultiSigUserSigned(
   types: Record<string, { name: string; type: string }[]>,
   outerSigner: `0x${string}`,
   nonce: number,
-): Promise<[Record<string, unknown>, Signature]> {
+): Promise<[Record<string, unknown>, SignatureSchema]> {
   const { signers, multiSigUser, transport: { isTestnet } } = config;
   const multiSigUser_ = v.parse(Address, multiSigUser);
   const outerSigner_ = v.parse(Address, outerSigner);

package/src/src/api/exchange/_methods/agentEnableDexAbstraction.ts

@@ -5,7 +5,7 @@ import * as v from "valibot";
 // ============================================================
 
 import { UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
+import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
 
 /**
  * Enable HIP-3 DEX abstraction.
@@ -26,16 +26,22 @@ export const AgentEnableDexAbstractionRequest = /* @__PURE__ */ (() => {
         v.description("Action to perform."),
       ),
       /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: Nonce,
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
+      ),
       /** ECDSA signature components. */
-      signature: Signature,
+      signature: v.pipe(
+        SignatureSchema,
+        v.description("ECDSA signature components."),
+      ),
       /** Expiration time of the action. */
       expiresAfter: v.pipe(
         v.optional(UnsignedInteger),
         v.description("Expiration time of the action."),
       ),
     }),
-    v.description("Enable HIP-3 DEX abstraction request."),
+    v.description("Enable HIP-3 DEX abstraction."),
   );
 })();
 export type AgentEnableDexAbstractionRequest = v.InferOutput<typeof AgentEnableDexAbstractionRequest>;