@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,28 @@
+/**
+ * Format price according to Hyperliquid {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | rules}:
+ * - Maximum 5 significant figures
+ * - Maximum 6 (for perp) or 8 (for spot) - `szDecimals` decimal places
+ * - Integer prices are always allowed regardless of significant figures
+ * @example
+ * ```ts
+ * import { formatPrice } from "@nktkas/hyperliquid/utils";
+ *
+ * //        `true` for perp (default), `false` for spot
+ * //                                              ⌄⌄⌄⌄⌄
+ * const price = formatPrice("0.0000123456789", 0, false); // → "0.00001234"
+ * ```
+ */
+export declare function formatPrice(price: string | number, szDecimals: number, isPerp?: boolean): 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`
+ * @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/esm/src/utils/_format.d.ts.map

@@ -0,0 +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"}

package/esm/src/utils/_format.js

@@ -0,0 +1,157 @@
+/**
+ * Format price according to Hyperliquid {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size | rules}:
+ * - Maximum 5 significant figures
+ * - Maximum 6 (for perp) or 8 (for spot) - `szDecimals` decimal places
+ * - Integer prices are always allowed regardless of significant figures
+ * @example
+ * ```ts
+ * import { formatPrice } from "@nktkas/hyperliquid/utils";
+ *
+ * //        `true` for perp (default), `false` for spot
+ * //                                              ⌄⌄⌄⌄⌄
+ * const price = formatPrice("0.0000123456789", 0, false); // → "0.00001234"
+ * ```
+ */
+export function formatPrice(price, szDecimals, isPerp = true) {
+    price = price.toString().trim();
+    assertNumberString(price);
+    // Integer prices are always allowed
+    if (/^-?\d+$/.test(price))
+        return trimZeros(price);
+    // Apply decimal limit: max 6 (perp) or 8 (spot) - szDecimals
+    const maxDecimals = Math.max((isPerp ? 6 : 8) - szDecimals, 0);
+    price = StringMath.toFixedTruncate(price, maxDecimals);
+    // Apply sig figs limit: max 5 significant figures
+    price = StringMath.toPrecisionTruncate(price, 5);
+    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`
+ * @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 function formatSize(size, szDecimals) {
+    size = size.toString().trim();
+    assertNumberString(size);
+    // Apply decimal limit: szDecimals
+    size = StringMath.toFixedTruncate(size, szDecimals);
+    return size;
+}
+/** String-based Math operations for arbitrary precision */
+const StringMath = {
+    /** Floor log10 (magnitude): position of most significant digit */
+    log10Floor(value) {
+        const abs = value[0] === "-" ? value.slice(1) : value;
+        // Check if zero or invalid
+        const num = Number(abs);
+        if (num === 0 || isNaN(num))
+            return -Infinity;
+        const [int, dec] = abs.split(".");
+        // Number >= 1: magnitude = length of integer part - 1
+        if (Number(int) !== 0) {
+            const trimmed = int.replace(/^0+/, "");
+            return trimmed.length - 1;
+        }
+        // Number < 1: count leading zeros in decimal part
+        const leadingZeros = dec.match(/^0*/)?.[0].length ?? 0;
+        return -(leadingZeros + 1);
+    },
+    /** Multiply by 10^exp: shift decimal point left (negative) or right (positive) */
+    multiplyByPow10(value, exp) {
+        if (!Number.isInteger(exp))
+            throw new RangeError("Exponent must be an integer");
+        if (exp === 0)
+            return trimZeros(value);
+        const neg = value[0] === "-";
+        const abs = neg ? value.slice(1) : value;
+        const [intRaw, dec = ""] = abs.split(".");
+        // Normalize empty integer part to "0" (handles ".5" → "0.5")
+        const int = intRaw || "0";
+        let result;
+        if (exp > 0) {
+            // Shift right: move digits from decimal to integer
+            if (exp >= dec.length) {
+                result = int + dec + "0".repeat(exp - dec.length);
+            }
+            else {
+                result = int + dec.slice(0, exp) + "." + dec.slice(exp);
+            }
+        }
+        else {
+            // Shift left: move digits from integer to decimal
+            const absExp = -exp;
+            if (absExp >= int.length) {
+                result = "0." + "0".repeat(absExp - int.length) + int + dec;
+            }
+            else {
+                result = int.slice(0, -absExp) + "." + int.slice(-absExp) + dec;
+            }
+        }
+        return trimZeros((neg ? "-" : "") + result);
+    },
+    /** Returns the integer part of a number by removing any fractional digits */
+    trunc(value) {
+        const dotIndex = value.indexOf(".");
+        return dotIndex === -1 ? value : value.slice(0, dotIndex) || "0";
+    },
+    /** Truncate to a certain number of significant figures */
+    toPrecisionTruncate(value, precision) {
+        if (!Number.isInteger(precision))
+            throw new RangeError("Precision must be an integer");
+        if (precision < 1)
+            throw new RangeError("Precision must be positive");
+        if (/^-?0+(\.0*)?$/.test(value))
+            return "0"; // zero is special case (don't work with log10)
+        const neg = value[0] === "-";
+        const abs = neg ? value.slice(1) : value;
+        // Calculate how much to shift: align most significant digit to ones place + (maxSigFigs-1)
+        const magnitude = StringMath.log10Floor(abs);
+        const shiftAmount = precision - magnitude - 1;
+        // Shift right, truncate integer part, shift back
+        const shifted = StringMath.multiplyByPow10(abs, shiftAmount);
+        const truncated = StringMath.trunc(shifted);
+        const result = StringMath.multiplyByPow10(truncated, -shiftAmount);
+        // build final result and trim zeros
+        return trimZeros(neg ? "-" + result : result);
+    },
+    /** Truncate to a certain number of decimal places */
+    toFixedTruncate(value, decimals) {
+        if (!Number.isInteger(decimals))
+            throw new RangeError("Decimals must be an integer");
+        if (decimals < 0)
+            throw new RangeError("Decimals must be non-negative");
+        // Match number with up to `decimals` decimal places
+        const regex = new RegExp(`^-?(?:\\d+)?(?:\\.\\d{0,${decimals}})?`);
+        const result = value.match(regex)?.[0];
+        if (!result) {
+            throw new TypeError("Invalid number format");
+        }
+        // Trim zeros after truncation
+        return trimZeros(result);
+    },
+};
+function trimZeros(value) {
+    return value
+        // 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"
+}
+function assertNumberString(value) {
+    if (!/^-?(\d+\.?\d*|\.\d*)$/.test(value)) {
+        throw new TypeError("Invalid number format");
+    }
+}
+//# sourceMappingURL=_format.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_format.js","sourceRoot":"","sources":["../../../src/src/utils/_format.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,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,MAAM,UAAU,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"}

package/esm/src/utils/_recover.d.ts

@@ -0,0 +1,89 @@
+import { type Signature } from "../signing/mod.js";
+/**
+ * Recover the Ethereum address that signed an L1 action.
+ * @example
+ * ```ts
+ * import { recoverUserFromL1Action } from "@nktkas/hyperliquid/utils";
+ *
+ * const action = {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * };
+ * const nonce = 1700000000000;
+ * const signature = {
+ *   r: "0x...",
+ *   s: "0x...",
+ *   v: 27,
+ * } as const;
+ *
+ * const address = await recoverUserFromL1Action({ action, nonce, signature });
+ * console.log(`Signer address: ${address}`);
+ * ```
+ */
+export declare function recoverUserFromL1Action(params: {
+    /** The action that was signed (hash depends on key order). */
+    action: Record<string, unknown>;
+    /** The timestamp in ms used when signing. */
+    nonce: number;
+    /** The signature to recover the address from. */
+    signature: Signature;
+    /** Indicates if the action is for the testnet. (default: false) */
+    isTestnet?: boolean;
+    /** Optional vault address used in the action. */
+    vaultAddress?: `0x${string}`;
+    /** Optional expiration time in ms used in the action. */
+    expiresAfter?: number;
+}): Promise<`0x${string}`>;
+/**
+ * Recover the Ethereum address that signed a user-signed action.
+ * @example
+ * ```ts
+ * import { recoverUserFromUserSigned } from "@nktkas/hyperliquid/utils";
+ *
+ * const action = {
+ *   type: "approveAgent",
+ *   signatureChainId: "0x66eee" as const,
+ *   hyperliquidChain: "Mainnet",
+ *   agentAddress: "0x...",
+ *   agentName: "Agent",
+ *   nonce: 1700000000000,
+ * };
+ * const types = {
+ *   HyperliquidTransaction: [
+ *     { name: "hyperliquidChain", type: "string" },
+ *     // ... other fields
+ *   ],
+ * };
+ * const signature = {
+ *   r: "0x...",
+ *   s: "0x...",
+ *   v: 27,
+ * } as const;
+ *
+ * const address = await recoverUserFromUserSigned({ action, types, signature });
+ * console.log(`Signer address: ${address}`);
+ * ```
+ */
+export declare function recoverUserFromUserSigned(params: {
+    /** The action that was signed (hex strings must be in lower case). */
+    action: {
+        signatureChainId: `0x${string}`;
+        [key: string]: unknown;
+    } & ({
+        nonce: number;
+        time?: undefined;
+    } | {
+        time: number;
+        nonce?: undefined;
+    });
+    /** The types of the action (hash depends on key order). */
+    types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    };
+    /** The signature to recover the address from. */
+    signature: Signature;
+}): Promise<`0x${string}`>;
+//# sourceMappingURL=_recover.d.ts.map

package/esm/src/utils/_recover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_recover.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_recover.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAGvE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,uBAAuB,CAAC,MAAM,EAAE;IACpD,8DAA8D;IAC9D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,SAAS,EAAE,SAAS,CAAC;IACrB,mEAAmE;IACnE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC7B,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CA+CzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,yBAAyB,CAAC,MAAM,EAAE;IACtD,sEAAsE;IACtE,MAAM,EACF;QACA,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,GACC,CACE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,SAAS,CAAA;KAAE,GACnC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,SAAS,CAAA;KAAE,CACtC,CAAC;IACJ,2DAA2D;IAC3D,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SACd,EAAE,CAAC;KACL,CAAC;IACF,iDAAiD;IACjD,SAAS,EAAE,SAAS,CAAC;CACtB,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CA6BzB"}

package/esm/src/utils/_recover.js

@@ -0,0 +1,119 @@
+import { keccak_256 } from "@noble/hashes/sha3.js";
+import * as secp from "@noble/secp256k1";
+import { createL1ActionHash } from "../signing/mod.js";
+import { hashTypedData } from "./_eip712.js";
+/**
+ * Recover the Ethereum address that signed an L1 action.
+ * @example
+ * ```ts
+ * import { recoverUserFromL1Action } from "@nktkas/hyperliquid/utils";
+ *
+ * const action = {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * };
+ * const nonce = 1700000000000;
+ * const signature = {
+ *   r: "0x...",
+ *   s: "0x...",
+ *   v: 27,
+ * } as const;
+ *
+ * const address = await recoverUserFromL1Action({ action, nonce, signature });
+ * console.log(`Signer address: ${address}`);
+ * ```
+ */
+export async function recoverUserFromL1Action(params) {
+    const { action, signature, nonce, isTestnet = false, vaultAddress, expiresAfter, } = params;
+    // 1. Create the action hash
+    const actionHash = createL1ActionHash({ action, nonce, vaultAddress, expiresAfter });
+    // 2. Hash the typed data according to EIP-712
+    const hash = hashTypedData({
+        domain: {
+            name: "Exchange",
+            version: "1",
+            chainId: 1337,
+            verifyingContract: "0x0000000000000000000000000000000000000000",
+        },
+        types: {
+            Agent: [
+                { name: "source", type: "string" },
+                { name: "connectionId", type: "bytes32" },
+            ],
+        },
+        primaryType: "Agent",
+        message: {
+            source: isTestnet ? "b" : "a",
+            connectionId: actionHash,
+        },
+    });
+    // 3. Convert signature to recovery format (v, r, s)
+    const sigr = secp.etc.concatBytes(new Uint8Array([signature.v - 27]), secp.etc.hexToBytes(signature.r.slice(2)), secp.etc.hexToBytes(signature.s.slice(2)));
+    // 4. Recover the public key from the signature and hash
+    const compressedPubKey = await secp.recoverPublicKeyAsync(sigr, hash, { prehash: false });
+    const uncompressedPubKey = secp.Point.fromBytes(compressedPubKey).toBytes(false);
+    // 5. Convert the public key to an Ethereum address
+    return publicKeyToAddress(uncompressedPubKey);
+}
+/**
+ * Recover the Ethereum address that signed a user-signed action.
+ * @example
+ * ```ts
+ * import { recoverUserFromUserSigned } from "@nktkas/hyperliquid/utils";
+ *
+ * const action = {
+ *   type: "approveAgent",
+ *   signatureChainId: "0x66eee" as const,
+ *   hyperliquidChain: "Mainnet",
+ *   agentAddress: "0x...",
+ *   agentName: "Agent",
+ *   nonce: 1700000000000,
+ * };
+ * const types = {
+ *   HyperliquidTransaction: [
+ *     { name: "hyperliquidChain", type: "string" },
+ *     // ... other fields
+ *   ],
+ * };
+ * const signature = {
+ *   r: "0x...",
+ *   s: "0x...",
+ *   v: 27,
+ * } as const;
+ *
+ * const address = await recoverUserFromUserSigned({ action, types, signature });
+ * console.log(`Signer address: ${address}`);
+ * ```
+ */
+export async function recoverUserFromUserSigned(params) {
+    const { action, types, signature } = params;
+    // 1. Hash the typed data according to EIP-712
+    const hash = hashTypedData({
+        domain: {
+            name: "HyperliquidSignTransaction",
+            version: "1",
+            chainId: parseInt(action.signatureChainId),
+            verifyingContract: "0x0000000000000000000000000000000000000000",
+        },
+        types,
+        primaryType: Object.keys(types)[0],
+        message: action,
+    });
+    // 2. Convert signature to recovery format (v, r, s)
+    const sigr = secp.etc.concatBytes(new Uint8Array([signature.v - 27]), secp.etc.hexToBytes(signature.r.slice(2)), secp.etc.hexToBytes(signature.s.slice(2)));
+    // 3. Recover the public key from the signature and hash
+    const compressedPubKey = await secp.recoverPublicKeyAsync(sigr, hash, { prehash: false });
+    const uncompressedPubKey = secp.Point.fromBytes(compressedPubKey).toBytes(false);
+    // 4. Convert the public key to an Ethereum address
+    return publicKeyToAddress(uncompressedPubKey);
+}
+/** Convert a public key to an Ethereum address. */
+function publicKeyToAddress(publicKey) {
+    // Remove the 0x04 prefix from uncompressed public key
+    const publicKeyWithoutPrefix = publicKey.slice(1);
+    // Hash the public key and take the last 20 bytes as the address
+    const hash = keccak_256(publicKeyWithoutPrefix);
+    const addressBytes = hash.slice(-20);
+    return `0x${secp.etc.bytesToHex(addressBytes)}`;
+}
+//# sourceMappingURL=_recover.js.map

package/esm/src/utils/_recover.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_recover.js","sourceRoot":"","sources":["../../../src/src/utils/_recover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAkB,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,MAa7C;IACC,MAAM,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,SAAS,GAAG,KAAK,EACjB,YAAY,EACZ,YAAY,GACb,GAAG,MAAM,CAAC;IAEX,4BAA4B;IAC5B,MAAM,UAAU,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAErF,8CAA8C;IAC9C,MAAM,IAAI,GAAG,aAAa,CAAC;QACzB,MAAM,EAAE;YACN,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,IAAI;YACb,iBAAiB,EAAE,4CAA4C;SAChE;QACD,KAAK,EAAE;YACL,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE;aAC1C;SACF;QACD,WAAW,EAAE,OAAO;QACpB,OAAO,EAAE;YACP,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;YAC7B,YAAY,EAAE,UAAU;SACzB;KACF,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAC/B,IAAI,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAClC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAC1C,CAAC;IAEF,wDAAwD;IACxD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1F,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjF,mDAAmD;IACnD,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,MAoB/C;IACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAE5C,8CAA8C;IAC9C,MAAM,IAAI,GAAG,aAAa,CAAC;QACzB,MAAM,EAAE;YACN,IAAI,EAAE,4BAA4B;YAClC,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC1C,iBAAiB,EAAE,4CAA4C;SAChE;QACD,KAAK;QACL,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,EAAE,MAAM;KAChB,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAC/B,IAAI,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAClC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAC1C,CAAC;IAEF,wDAAwD;IACxD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1F,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjF,mDAAmD;IACnD,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;AAChD,CAAC;AAED,mDAAmD;AACnD,SAAS,kBAAkB,CAAC,SAAqB;IAC/C,sDAAsD;IACtD,MAAM,sBAAsB,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClD,gEAAgE;IAChE,MAAM,IAAI,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,KAAK,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;AAClD,CAAC"}

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

@@ -0,0 +1,90 @@
+import type { IRequestTransport } from "../transport/base.js";
+export type DexOption = string[] | boolean;
+/** Options for creating a 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;
+}
+/**
+ * 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";
+ * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const converter = await SymbolConverter.create({ transport });
+ *
+ * // By default, dexs are not loaded; specify them when creating an instance
+ * // const converter = await SymbolConverter.create({ transport, dexs: ["test"] });
+ *
+ * const btcId = converter.getAssetId("BTC"); // perpetual → 0
+ * const hypeUsdcId = converter.getAssetId("HYPE/USDC"); // spot market → 10107
+ * const dexAbcId = converter.getAssetId("test:ABC"); // builder dex (if enabled) → 110000
+ *
+ * const btcSzDecimals = converter.getSzDecimals("BTC"); // perpetual → 5
+ * const hypeUsdcSzDecimals = converter.getSzDecimals("HYPE/USDC"); // spot market → 2
+ * const dexAbcSzDecimals = converter.getSzDecimals("test:ABC"); // builder dex (if enabled) → 0
+ *
+ * const spotPairId = converter.getSpotPairId("HFUN/USDC"); // → "@2"
+ * ```
+ */
+export declare class SymbolConverter {
+    private readonly transport;
+    private readonly dexOption;
+    private readonly nameToAssetId;
+    private readonly nameToSzDecimals;
+    private readonly nameToSpotPairId;
+    private constructor();
+    /**
+     * 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";
+     * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+     *
+     * const transport = new HttpTransport(); // or `WebSocketTransport`
+     * const converter = await SymbolConverter.create({ transport });
+     * ```
+     */
+    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;
+    /**
+     * 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: string): number | undefined;
+    /**
+     * 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;
+}
+//# sourceMappingURL=_symbolConverter.d.ts.map

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

@@ -0,0 +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"}