@hfunlabs/hyperliquid 0.27.1 → 0.30.0-hfunlabs.1

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

@@ -3,26 +3,35 @@
  * - Maximum 5 significant figures
  * - Maximum 6 (for perp) or 8 (for spot) - `szDecimals` decimal places
  * - Integer prices are always allowed regardless of significant figures
+ *
+ * @param price - The price to format (as string or number).
+ * @param szDecimals - The size decimals of the asset.
+ * @param type - The market type: "perp" for perpetuals or "spot" for spot markets. Default is "perp".
+ *
+ * @throws {RangeError} If the formatted price is 0
+ *
  * @example
  * ```ts
  * import { formatPrice } from "@nktkas/hyperliquid/utils";
- *
- * //        `true` for perp (default), `false` for spot
- * //                                              ⌄⌄⌄⌄⌄
- * const price = formatPrice("0.0000123456789", 0, false); // → "0.00001234"
+ * const price = formatPrice("0.0000123456789", 0, "spot"); // → "0.00001234"
  * ```
  */
-export declare function formatPrice(price: string | number, szDecimals: number, isPerp?: boolean): string;
+export declare function formatPrice(price: string | number, szDecimals: number, type?: "perp" | "spot"): string;
 /**
  * Format size according to Hyperliquid {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | rules}:
  * - Truncate decimal places to `szDecimals`
+ *
+ * @param size - The size to format (as string or number).
+ * @param szDecimals - The size decimals of the asset.
+ *
+ * @throws {RangeError} If the formatted size is 0
+ *
  * @example
  * ```ts
  * import { formatSize } from "@nktkas/hyperliquid/utils";
  *
  * const size = formatSize("1.23456789", 5); // → "1.23456"
  * ```
- * @note May return 0 if the value is not suitable, but when closing a position, a size of 0 means the full size.
  */
 export declare function formatSize(size: string | number, szDecimals: number): string;
 //# sourceMappingURL=_format.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"_format.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAE,OAAc,GAAG,MAAM,CAetG;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAQ5E"}
+{"version":3,"file":"_format.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,GAAG,MAAe,GAAG,MAAM,CAmB9G;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAY5E"}

package/script/src/utils/_format.js

@@ -7,44 +7,59 @@ exports.formatSize = formatSize;
  * - Maximum 5 significant figures
  * - Maximum 6 (for perp) or 8 (for spot) - `szDecimals` decimal places
  * - Integer prices are always allowed regardless of significant figures
+ *
+ * @param price - The price to format (as string or number).
+ * @param szDecimals - The size decimals of the asset.
+ * @param type - The market type: "perp" for perpetuals or "spot" for spot markets. Default is "perp".
+ *
+ * @throws {RangeError} If the formatted price is 0
+ *
  * @example
  * ```ts
  * import { formatPrice } from "@nktkas/hyperliquid/utils";
- *
- * //        `true` for perp (default), `false` for spot
- * //                                              ⌄⌄⌄⌄⌄
- * const price = formatPrice("0.0000123456789", 0, false); // → "0.00001234"
+ * const price = formatPrice("0.0000123456789", 0, "spot"); // → "0.00001234"
  * ```
  */
-function formatPrice(price, szDecimals, isPerp = true) {
+function formatPrice(price, szDecimals, type = "perp") {
     price = price.toString().trim();
     assertNumberString(price);
     // Integer prices are always allowed
     if (/^-?\d+$/.test(price))
-        return trimZeros(price);
+        return formatDecimalString(price);
     // Apply decimal limit: max 6 (perp) or 8 (spot) - szDecimals
-    const maxDecimals = Math.max((isPerp ? 6 : 8) - szDecimals, 0);
+    const maxDecimals = Math.max((type === "perp" ? 6 : 8) - szDecimals, 0);
     price = StringMath.toFixedTruncate(price, maxDecimals);
     // Apply sig figs limit: max 5 significant figures
     price = StringMath.toPrecisionTruncate(price, 5);
+    if (price === "0") {
+        throw new RangeError("Price is too small and was truncated to 0");
+    }
     return price;
 }
 /**
  * Format size according to Hyperliquid {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | rules}:
  * - Truncate decimal places to `szDecimals`
+ *
+ * @param size - The size to format (as string or number).
+ * @param szDecimals - The size decimals of the asset.
+ *
+ * @throws {RangeError} If the formatted size is 0
+ *
  * @example
  * ```ts
  * import { formatSize } from "@nktkas/hyperliquid/utils";
  *
  * const size = formatSize("1.23456789", 5); // → "1.23456"
  * ```
- * @note May return 0 if the value is not suitable, but when closing a position, a size of 0 means the full size.
  */
 function formatSize(size, szDecimals) {
     size = size.toString().trim();
     assertNumberString(size);
     // Apply decimal limit: szDecimals
     size = StringMath.toFixedTruncate(size, szDecimals);
+    if (size === "0") {
+        throw new RangeError("Size is too small and was truncated to 0");
+    }
     return size;
 }
 /** String-based Math operations for arbitrary precision */
@@ -71,7 +86,7 @@ const StringMath = {
         if (!Number.isInteger(exp))
             throw new RangeError("Exponent must be an integer");
         if (exp === 0)
-            return trimZeros(value);
+            return formatDecimalString(value);
         const neg = value[0] === "-";
         const abs = neg ? value.slice(1) : value;
         const [intRaw, dec = ""] = abs.split(".");
@@ -97,7 +112,7 @@ const StringMath = {
                 result = int.slice(0, -absExp) + "." + int.slice(-absExp) + dec;
             }
         }
-        return trimZeros((neg ? "-" : "") + result);
+        return formatDecimalString((neg ? "-" : "") + result);
     },
     /** Returns the integer part of a number by removing any fractional digits */
     trunc(value) {
@@ -122,7 +137,7 @@ const StringMath = {
         const truncated = StringMath.trunc(shifted);
         const result = StringMath.multiplyByPow10(truncated, -shiftAmount);
         // build final result and trim zeros
-        return trimZeros(neg ? "-" + result : result);
+        return formatDecimalString(neg ? "-" + result : result);
     },
     /** Truncate to a certain number of decimal places */
     toFixedTruncate(value, decimals) {
@@ -137,11 +152,13 @@ const StringMath = {
             throw new TypeError("Invalid number format");
         }
         // Trim zeros after truncation
-        return trimZeros(result);
+        return formatDecimalString(result);
     },
 };
-function trimZeros(value) {
+function formatDecimalString(value) {
     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

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

@@ -1 +1 @@
-{"version":3,"file":"_format.js","sourceRoot":"","sources":["../../../src/src/utils/_format.ts"],"names":[],"mappings":";;AAcA,kCAeC;AAaD,gCAQC;AAlDD;;;;;;;;;;;;;GAaG;AACH,SAAgB,WAAW,CAAC,KAAsB,EAAE,UAAkB,EAAE,SAAkB,IAAI;IAC5F,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IAChC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE1B,oCAAoC;IACpC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;IAEnD,6DAA6D;IAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;IAC/D,KAAK,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAEvD,kDAAkD;IAClD,KAAK,GAAG,UAAU,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEjD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CAAC,IAAqB,EAAE,UAAkB;IAClE,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IAC9B,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEzB,kCAAkC;IAClC,IAAI,GAAG,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAEpD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG;IACjB,kEAAkE;IAClE,UAAU,CAAC,KAAa;QACtB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEtD,2BAA2B;QAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC;YAAE,OAAO,CAAC,QAAQ,CAAC;QAE9C,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACvC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5B,CAAC;QAED,kDAAkD;QAClD,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;QACvD,OAAO,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,kFAAkF;IAClF,eAAe,CAAC,KAAa,EAAE,GAAW;QACxC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;QAChF,IAAI,GAAG,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,6DAA6D;QAC7D,MAAM,GAAG,GAAG,MAAM,IAAI,GAAG,CAAC;QAE1B,IAAI,MAAc,CAAC;QAEnB,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,mDAAmD;YACnD,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACtB,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,kDAAkD;YAClD,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC;YACpB,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;YAClE,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,KAAa;QACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC;IACnE,CAAC;IAED,0DAA0D;IAC1D,mBAAmB,CAAC,KAAa,EAAE,SAAiB;QAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACvF,IAAI,SAAS,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;QACtE,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,GAAG,CAAC,CAAC,+CAA+C;QAE5F,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEzC,2FAA2F;QAC3F,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,CAAC,CAAC;QAE9C,iDAAiD;QACjD,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,UAAU,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,CAAC;QAEnE,oCAAoC;QACpC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,qDAAqD;IACrD,eAAe,CAAC,KAAa,EAAE,QAAgB;QAC7C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;QACrF,IAAI,QAAQ,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,+BAA+B,CAAC,CAAC;QAExE,oDAAoD;QACpD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,2BAA2B,QAAQ,KAAK,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAC/C,CAAC;QAED,8BAA8B;QAC9B,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;CACF,CAAC;AAEF,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,KAAK;QACV,uBAAuB;SACtB,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,oCAAoC;QACpE,wBAAwB;SACvB,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,gCAAgC;QACpE,gDAAgD;SAC/C,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,+BAA+B;QAC3D,4CAA4C;SAC3C,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,sBAAsB;QAC5C,0BAA0B;SACzB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa;AACxC,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACvC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC"}
+{"version":3,"file":"_format.js","sourceRoot":"","sources":["../../../src/src/utils/_format.ts"],"names":[],"mappings":";;AAkBA,kCAmBC;AAkBD,gCAYC;AAnED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,WAAW,CAAC,KAAsB,EAAE,UAAkB,EAAE,OAAwB,MAAM;IACpG,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IAChC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE1B,oCAAoC;IACpC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAE7D,6DAA6D;IAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;IACxE,KAAK,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAEvD,kDAAkD;IAClD,KAAK,GAAG,UAAU,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEjD,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;QAClB,MAAM,IAAI,UAAU,CAAC,2CAA2C,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,UAAU,CAAC,IAAqB,EAAE,UAAkB;IAClE,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IAC9B,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEzB,kCAAkC;IAClC,IAAI,GAAG,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAEpD,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,UAAU,CAAC,0CAA0C,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG;IACjB,kEAAkE;IAClE,UAAU,CAAC,KAAa;QACtB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEtD,2BAA2B;QAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC;YAAE,OAAO,CAAC,QAAQ,CAAC;QAE9C,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACvC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5B,CAAC;QAED,kDAAkD;QAClD,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;QACvD,OAAO,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,kFAAkF;IAClF,eAAe,CAAC,KAAa,EAAE,GAAW;QACxC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;QAChF,IAAI,GAAG,KAAK,CAAC;YAAE,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEjD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACzC,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,6DAA6D;QAC7D,MAAM,GAAG,GAAG,MAAM,IAAI,GAAG,CAAC;QAE1B,IAAI,MAAc,CAAC;QAEnB,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,mDAAmD;YACnD,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACtB,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,kDAAkD;YAClD,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC;YACpB,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;YAClE,CAAC;QACH,CAAC;QAED,OAAO,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,KAAa;QACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC;IACnE,CAAC;IAED,0DAA0D;IAC1D,mBAAmB,CAAC,KAAa,EAAE,SAAiB;QAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACvF,IAAI,SAAS,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;QACtE,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,GAAG,CAAC,CAAC,+CAA+C;QAE5F,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAEzC,2FAA2F;QAC3F,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,CAAC,CAAC;QAE9C,iDAAiD;QACjD,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,UAAU,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,WAAW,CAAC,CAAC;QAEnE,oCAAoC;QACpC,OAAO,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,qDAAqD;IACrD,eAAe,CAAC,KAAa,EAAE,QAAgB;QAC7C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAC;QACrF,IAAI,QAAQ,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,+BAA+B,CAAC,CAAC;QAExE,oDAAoD;QACpD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,2BAA2B,QAAQ,KAAK,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAC/C,CAAC;QAED,8BAA8B;QAC9B,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK;QACV,qCAAqC;SACpC,IAAI,EAAE,CAAC,0BAA0B;QAClC,uBAAuB;SACtB,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,oCAAoC;QACpE,wBAAwB;SACvB,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,gCAAgC;QACpE,gDAAgD;SAC/C,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,+BAA+B;QAC3D,4CAA4C;SAC3C,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,sBAAsB;QAC5C,0BAA0B;SACzB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa;AACxC,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACvC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC"}

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

@@ -1,16 +1,15 @@
-import type { IRequestTransport } from "../transport/base.js";
-export type DexOption = string[] | boolean;
-/** Options for creating a SymbolConverter instance. */
+import type { IRequestTransport } from "../transport/mod.js";
+/** Options for creating a {@link SymbolConverter} instance. */
 export interface SymbolConverterOptions {
     /** Transport instance to use for API requests. */
     transport: IRequestTransport;
     /** Optional dex support: array of dex names, true for all dexs, or false/undefined to skip. */
-    dexs?: DexOption;
+    dexs?: string[] | boolean;
 }
 /**
  * Utility class for converting asset symbols to their corresponding IDs and size decimals.
  * Supports perpetuals, spot markets, and optional builder dexs.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ *
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
@@ -32,18 +31,25 @@ export interface SymbolConverterOptions {
  *
  * const spotPairId = converter.getSpotPairId("HFUN/USDC"); // → "@2"
  * ```
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
  */
 export declare class SymbolConverter {
-    private readonly transport;
-    private readonly dexOption;
-    private readonly nameToAssetId;
-    private readonly nameToSzDecimals;
-    private readonly nameToSpotPairId;
-    private constructor();
+    #private;
+    /**
+     * 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: SymbolConverterOptions);
     /**
      * Create and initialize a SymbolConverter instance.
+     *
      * @param options - Configuration options including transport and optional dex support.
+     *
      * @returns Initialized SymbolConverter instance.
+     *
      * @example
      * ```ts
      * import { HttpTransport } from "@nktkas/hyperliquid";
@@ -56,18 +62,16 @@ export declare class SymbolConverter {
     static create(options: SymbolConverterOptions): Promise<SymbolConverter>;
     /**
      * Reload asset mappings from the API.
+     *
      * Useful for refreshing data when new assets are added.
      */
     reload(): Promise<void>;
-    private processDefaultPerps;
-    private processBuilderDexs;
-    private processBuilderDexResult;
-    private processSpotAssets;
     /**
      * Get asset ID for a coin.
      * - For Perpetuals, use the coin name (e.g., "BTC").
      * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
      * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     *
      * @example "BTC" → 0, "HYPE/USDC" → 10107, "test:ABC" → 110000
      */
     getAssetId(name: string): number | undefined;
@@ -76,6 +80,7 @@ export declare class SymbolConverter {
      * - For Perpetuals, use the coin name (e.g., "BTC").
      * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
      * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     *
      * @example "BTC" → 5, "HYPE/USDC" → 2, "test:ABC" → 0
      */
     getSzDecimals(name: string): number | undefined;
@@ -83,6 +88,7 @@ export declare class SymbolConverter {
      * Get spot pair ID for info endpoints and subscriptions (e.g., l2book, trades).
      *
      * Accepts spot markets in the "BASE/QUOTE" format (e.g., "HFUN/USDC").
+     *
      * @example "HFUN/USDC" → "@2", "PURR/USDC" → "PURR/USDC"
      */
     getSpotPairId(name: string): string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"_symbolConverter.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAK9D,MAAM,MAAM,SAAS,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC;AAE3C,uDAAuD;AACvD,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,SAAS,EAAE,iBAAiB,CAAC;IAC7B,+FAA+F;IAC/F,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAC3D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA6B;IAC9D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA6B;IAE9D,OAAO;IAKP;;;;;;;;;;;;OAYG;WACU,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAM9E;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IA6B7B,OAAO,CAAC,mBAAmB;YAOb,kBAAkB;IA6BhC,OAAO,CAAC,uBAAuB;IAU/B,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI5C;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI/C;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAGhD"}
+{"version":3,"file":"_symbolConverter.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAU7D,+DAA+D;AAC/D,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,SAAS,EAAE,iBAAiB,CAAC;IAC7B,+FAA+F;IAC/F,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,eAAe;;IAO1B;;;;;OAKG;gBACS,OAAO,EAAE,sBAAsB;IAK3C;;;;;;;;;;;;;;;OAeG;WACU,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAM9E;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAiG7B;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI5C;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI/C;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAGhD"}

package/script/src/utils/_symbolConverter.js

@@ -1,13 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SymbolConverter = void 0;
-const meta_js_1 = require("../api/info/meta.js");
-const spotMeta_js_1 = require("../api/info/spotMeta.js");
-const perpDexs_js_1 = require("../api/info/perpDexs.js");
+const mod_js_1 = require("../api/info/mod.js");
 /**
  * Utility class for converting asset symbols to their corresponding IDs and size decimals.
  * Supports perpetuals, spot markets, and optional builder dexs.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ *
  * @example
  * ```ts
  * import { HttpTransport } from "@nktkas/hyperliquid";
@@ -29,21 +27,32 @@ const perpDexs_js_1 = require("../api/info/perpDexs.js");
  *
  * const spotPairId = converter.getSpotPairId("HFUN/USDC"); // → "@2"
  * ```
+ *
+ * @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.
+     *
      * @param options - Configuration options including transport and optional dex support.
+     *
      * @returns Initialized SymbolConverter instance.
+     *
      * @example
      * ```ts
      * import { HttpTransport } from "@nktkas/hyperliquid";
@@ -60,14 +69,16 @@ 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 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, meta_js_1.meta)(config),
-            (0, spotMeta_js_1.spotMeta)(config),
-            (0, perpDexs_js_1.perpDexs)(config),
+            (0, mod_js_1.meta)(config),
+            (0, mod_js_1.spotMeta)(config),
+            needDexs ? (0, mod_js_1.perpDexs)(config) : undefined,
         ]);
         if (!perpMetaData?.universe?.length) {
             throw new Error("Invalid perpetual metadata response");
@@ -75,26 +86,26 @@ 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 (this.dexOption !== false) {
-            await this.processBuilderDexs(perpDexsData);
+        if (perpDexsData) {
+            await this.#processBuilderDexs(perpDexsData);
         }
     }
-    processDefaultPerps(perpMeta) {
-        perpMeta.universe.forEach((asset, index) => {
-            this.nameToAssetId.set(asset.name, index);
-            this.nameToSzDecimals.set(asset.name, asset.szDecimals);
+    #processDefaultPerps(perpMetaData) {
+        perpMetaData.universe.forEach((asset, index) => {
+            this.#nameToAssetId.set(asset.name, index);
+            this.#nameToSzDecimals.set(asset.name, asset.szDecimals);
         });
     }
-    async processBuilderDexs(perpDexs) {
-        if (!perpDexs || perpDexs.length <= 1)
+    async #processBuilderDexs(perpDexsData) {
+        if (!perpDexsData || perpDexsData.length <= 1)
             return;
-        const builderDexs = perpDexs
+        const builderDexs = perpDexsData
             .map((dex, index) => ({ dex, index }))
             .filter((item) => {
             return item.index > 0 && item.dex !== null && item.dex.name.length > 0;
@@ -102,33 +113,33 @@ 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 results = await Promise.allSettled(dexsToProcess.map((item) => (0, meta_js_1.meta)(config, { dex: item.dex.name })));
+        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(meta, perpDexIndex) {
+    #processBuilderDexResult(dexMeta, perpDexIndex) {
         const offset = 100000 + perpDexIndex * 10000;
-        meta.universe.forEach((asset, index) => {
+        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(spotMeta) {
+    #processSpotAssets(spotMetaData) {
         const tokenMap = new Map();
-        spotMeta.tokens.forEach((token) => {
+        spotMetaData.tokens.forEach((token) => {
             tokenMap.set(token.index, { name: token.name, szDecimals: token.szDecimals });
         });
-        spotMeta.universe.forEach((market) => {
+        spotMetaData.universe.forEach((market) => {
             if (market.tokens.length < 2)
                 return;
             const baseToken = tokenMap.get(market.tokens[0]);
@@ -137,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);
         });
     }
     /**
@@ -147,29 +158,32 @@ class SymbolConverter {
      * - For Perpetuals, use the coin name (e.g., "BTC").
      * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
      * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     *
      * @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.
      * - For Perpetuals, use the coin name (e.g., "BTC").
      * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
      * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     *
      * @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).
      *
      * Accepts spot markets in the "BASE/QUOTE" format (e.g., "HFUN/USDC").
+     *
      * @example "HFUN/USDC" → "@2", "PURR/USDC" → "PURR/USDC"
      */
     getSpotPairId(name) {
-        return this.nameToSpotPairId.get(name);
+        return this.#nameToSpotPairId.get(name);
     }
 }
 exports.SymbolConverter = SymbolConverter;

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

@@ -1 +1 @@
-{"version":3,"file":"_symbolConverter.js","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":";;;AACA,iDAA8D;AAC9D,yDAA0E;AAC1E,yDAA0E;AAY1E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,eAAe;IACT,SAAS,CAAoB;IAC7B,SAAS,CAAY;IACrB,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9D,YAAoB,OAA+B;QACjD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;OAYG;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;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7C,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnE,IAAA,cAAI,EAAC,MAAM,CAAC;YACZ,IAAA,sBAAQ,EAAC,MAAM,CAAC;YAChB,IAAA,sBAAQ,EAAC,MAAM,CAAC;SACjB,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,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAErC,sDAAsD;QACtD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,QAAsB;QAChD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,QAA0B;QACzD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC;YAAE,OAAO;QAE9C,MAAM,WAAW,GAAG,QAAQ;aACzB,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,SAAS,CAAC;YACjD,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAE,IAAI,CAAC,SAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpF,CAAC,CAAC,WAAW,CAAC,CAAC,yBAAyB;QAE1C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEvC,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,cAAI,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,uBAAuB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,IAAkB,EAAE,YAAoB;QACtE,MAAM,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC;QAE7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,iBAAiB,CAAC,QAA0B;QAClD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgD,CAAC;QACzE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,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,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,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,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF;AAjKD,0CAiKC"}
+{"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,4 +1,27 @@
+/**
+ * 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";
-export * from "./_recover.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,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,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);
@@ -16,5 +40,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./_symbolConverter.js"), exports);
 __exportStar(require("./_format.js"), exports);
-__exportStar(require("./_recover.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,wDAAsC;AACtC,+CAA6B;AAC7B,gDAA8B"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;;;;;;;;;;;;;AAEH,wDAAsC;AACtC,+CAA6B"}