@nktkas/hyperliquid 0.22.1 → 0.22.2

package/script/src/{signing.js → signing/_sorter.js}

@@ -1,423 +1,15 @@
-/**
- * This module contains functions for generating Hyperliquid transaction signatures
- * and interfaces to various wallet implementations.
- *
- * @example
- * ```ts
- * import { signL1Action } from "@nktkas/hyperliquid/signing";
- *
- * const action = {
- *   type: "cancel",
- *   cancels: [{ a: 0, o: 12345 }],
- * };
- * const nonce = Date.now();
- *
- * const signature = await signL1Action({
- *   wallet,
- *   action,
- *   nonce,
- *   isTestnet: true, // Change to false for mainnet
- * });
- * ```
- * @example
- * ```ts
- * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
- *
- * const action = {
- *   type: "approveAgent",
- *   hyperliquidChain: "Testnet", // "Mainnet" or "Testnet"
- *   signatureChainId: "0x66eee",
- *   nonce: Date.now(),
- *   agentAddress: "0x...",
- *   agentName: "Agent",
- * };
- *
- * const signature = await signUserSignedAction({
- *   wallet,
- *   action,
- *   types: {
- *     "HyperliquidTransaction:ApproveAgent": [
- *       { name: "hyperliquidChain", type: "string" },
- *       { name: "agentAddress", type: "address" },
- *       { name: "agentName", type: "string" },
- *       { name: "nonce", type: "uint64" },
- *     ],
- *   },
- *   chainId: parseInt(action.signatureChainId, 16),
- * });
- * ```
- *
- * @module
- */
 (function (factory) {
     if (typeof module === "object" && typeof module.exports === "object") {
         var v = factory(require, exports);
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "@noble/hashes/sha3", "../deps/jsr.io/@std/msgpack/1.0.3/encode.js", "../deps/jsr.io/@std/encoding/1.0.10/hex.js", "../deps/jsr.io/@std/bytes/1.0.6/concat.js"], factory);
+        define(["require", "exports"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.userSignedActionEip712Types = exports.actionSorter = void 0;
-    exports.createL1ActionHash = createL1ActionHash;
-    exports.signL1Action = signL1Action;
-    exports.signUserSignedAction = signUserSignedAction;
-    exports.signMultiSigAction = signMultiSigAction;
-    exports.isAbstractViemWalletClient = isAbstractViemWalletClient;
-    exports.isAbstractEthersSigner = isAbstractEthersSigner;
-    exports.isAbstractEthersV5Signer = isAbstractEthersV5Signer;
-    exports.isAbstractWindowEthereum = isAbstractWindowEthereum;
-    const sha3_1 = require("@noble/hashes/sha3");
-    const encode_js_1 = require("../deps/jsr.io/@std/msgpack/1.0.3/encode.js");
-    const hex_js_1 = require("../deps/jsr.io/@std/encoding/1.0.10/hex.js");
-    const concat_js_1 = require("../deps/jsr.io/@std/bytes/1.0.6/concat.js");
-    /**
-     * Create a hash of the L1 action.
-     *
-     * Note: Hash generation depends on the order of the action keys.
-     * @param action - The action to be hashed.
-     * @param nonce - Unique request identifier (recommended current timestamp in ms).
-     * @param vaultAddress - Optional vault address used in the action.
-     * @param expiresAfter - Optional expiration time of the action in milliseconds since the epoch.
-     * @returns The hash of the action.
-     */
-    function createL1ActionHash(action, nonce, vaultAddress, expiresAfter) {
-        // 1. Action
-        const actionBytes = (0, encode_js_1.encode)(normalizeIntegersForMsgPack(action));
-        // 2. Nonce
-        const nonceBytes = new Uint8Array(8);
-        new DataView(nonceBytes.buffer).setBigUint64(0, BigInt(nonce));
-        // 3. Vault address
-        let vaultMarker;
-        let vaultBytes;
-        if (vaultAddress) {
-            vaultMarker = Uint8Array.of(1);
-            vaultBytes = (0, hex_js_1.decodeHex)(vaultAddress.slice(2));
-        }
-        else {
-            vaultMarker = new Uint8Array(1);
-            vaultBytes = new Uint8Array();
-        }
-        // 4. Expires after
-        let expiresMarker;
-        let expiresBytes;
-        if (expiresAfter !== undefined) {
-            expiresMarker = new Uint8Array(1);
-            expiresBytes = new Uint8Array(8);
-            new DataView(expiresBytes.buffer).setBigUint64(0, BigInt(expiresAfter));
-        }
-        else {
-            expiresMarker = new Uint8Array();
-            expiresBytes = new Uint8Array();
-        }
-        // Create a keccak256 hash
-        const chunks = [
-            actionBytes,
-            nonceBytes,
-            vaultMarker,
-            vaultBytes,
-            expiresMarker,
-            expiresBytes,
-        ];
-        const bytes = (0, concat_js_1.concat)(chunks);
-        const hash = (0, sha3_1.keccak_256)(bytes);
-        return `0x${(0, hex_js_1.encodeHex)(hash)}`;
-    }
-    /** Layer to make {@link https://jsr.io/@std/msgpack | @std/msgpack} compatible with {@link https://github.com/msgpack/msgpack-javascript | @msgpack/msgpack}. */
-    function normalizeIntegersForMsgPack(obj) {
-        const THIRTY_ONE_BITS = 2147483648;
-        const THIRTY_TWO_BITS = 4294967296;
-        if (typeof obj === "number" && Number.isInteger(obj) &&
-            obj <= Number.MAX_SAFE_INTEGER && obj >= Number.MIN_SAFE_INTEGER &&
-            (obj >= THIRTY_TWO_BITS || obj < -THIRTY_ONE_BITS)) {
-            return BigInt(obj);
-        }
-        if (Array.isArray(obj)) {
-            return obj.map(normalizeIntegersForMsgPack);
-        }
-        if (obj && typeof obj === "object" && obj !== null) {
-            return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, normalizeIntegersForMsgPack(value)]));
-        }
-        return obj;
-    }
-    /**
-     * Sign an L1 action.
-     *
-     * Note: Signature generation depends on the order of the action keys.
-     * @param args - Arguments for signing the action.
-     * @returns The signature components r, s, and v.
-     * @example
-     * ```ts
-     * import { signL1Action } from "@nktkas/hyperliquid/signing";
-     * import { privateKeyToAccount } from "viem/accounts";
-     *
-     * const wallet = privateKeyToAccount("0x..."); // Your private key
-     *
-     * const action = {
-     *     type: "cancel",
-     *     cancels: [
-     *         { a: 0, o: 12345 }, // Asset index and order ID
-     *     ],
-     * };
-     * const nonce = Date.now();
-     *
-     * const signature = await signL1Action({
-     *     wallet,
-     *     action,
-     *     nonce,
-     *     isTestnet: true, // Change to false for mainnet
-     * });
-     *
-     * const response = await fetch("https://api.hyperliquid-testnet.xyz/exchange", {
-     *     method: "POST",
-     *     headers: { "Content-Type": "application/json" },
-     *     body: JSON.stringify({ action, signature, nonce }),
-     * });
-     * const body = await response.json();
-     * ```
-     */
-    async function signL1Action(args) {
-        const { wallet, action, nonce, isTestnet = false, vaultAddress, expiresAfter, } = args;
-        const domain = {
-            name: "Exchange",
-            version: "1",
-            chainId: 1337,
-            verifyingContract: "0x0000000000000000000000000000000000000000",
-        };
-        const types = {
-            Agent: [
-                { name: "source", type: "string" },
-                { name: "connectionId", type: "bytes32" },
-            ],
-        };
-        const actionHash = createL1ActionHash(action, nonce, vaultAddress, expiresAfter);
-        const message = {
-            source: isTestnet ? "b" : "a",
-            connectionId: actionHash,
-        };
-        const signature = await abstractSignTypedData({ wallet, domain, types, message });
-        return splitSignature(signature);
-    }
-    /**
-     * Sign a user-signed action.
-     *
-     * Note: Signature generation depends on the order of types.
-     *
-     * @param args - Arguments for signing the action.
-     * @returns The signature components r, s, and v.
-     * @example
-     * ```ts
-     * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
-     * import { privateKeyToAccount } from "viem/accounts";
-     *
-     * const wallet = privateKeyToAccount("0x..."); // Your private key
-     *
-     * const action = {
-     *     type: "approveAgent",
-     *     hyperliquidChain: "Testnet", // "Mainnet" or "Testnet"
-     *     signatureChainId: "0x66eee",
-     *     nonce: Date.now(),
-     *     agentAddress: "0x...", // Change to your agent address
-     *     agentName: "Agent",
-     * };
-     *
-     * const signature = await signUserSignedAction({
-     *     wallet,
-     *     action,
-     *     types: {
-     *         "HyperliquidTransaction:ApproveAgent": [
-     *             { name: "hyperliquidChain", type: "string" },
-     *             { name: "agentAddress", type: "address" },
-     *             { name: "agentName", type: "string" },
-     *             { name: "nonce", type: "uint64" },
-     *         ],
-     *     },
-     *     chainId: parseInt(action.signatureChainId, 16),
-     * });
-     *
-     * const response = await fetch("https://api.hyperliquid-testnet.xyz/exchange", {
-     *     method: "POST",
-     *     headers: { "Content-Type": "application/json" },
-     *     body: JSON.stringify({ action, signature, nonce: action.nonce }),
-     * });
-     * const body = await response.json();
-     * ```
-     */
-    async function signUserSignedAction(args) {
-        const { wallet, action, types, chainId } = args;
-        const domain = {
-            name: "HyperliquidSignTransaction",
-            version: "1",
-            chainId,
-            verifyingContract: "0x0000000000000000000000000000000000000000",
-        };
-        const signature = await abstractSignTypedData({ wallet, domain, types, message: action });
-        return splitSignature(signature);
-    }
-    /**
-     * Sign a multi-signature action.
-     *
-     * Note: Signature generation depends on the order of the action keys.
-     *
-     * @param args - Arguments for signing the action.
-     * @returns The signature components r, s, and v.
-     * @example
-     * ```ts
-     * import { signL1Action, signMultiSigAction } from "@nktkas/hyperliquid/signing";
-     * import { privateKeyToAccount } from "viem/accounts";
-     *
-     * const wallet = privateKeyToAccount("0x..."); // Your private key
-     * const multiSigUser = "0x..."; // Multi-sig user address
-     *
-     * const nonce = Date.now();
-     * const action = { // Example action
-     *   type: "scheduleCancel",
-     *   time: Date.now() + 10000
-     * };
-     *
-     * // First, create signature from one of the authorized signers
-     * const signature = await signL1Action({
-     *   wallet,
-     *   action: [multiSigUser.toLowerCase(), wallet.address.toLowerCase(), action],
-     *   nonce,
-     *   isTestnet: true,
-     * });
-     *
-     * // Then use it in the multi-sig action
-     * const multiSigSignature = await signMultiSigAction({
-     *   wallet,
-     *   action: {
-     *     type: "multiSig",
-     *     signatureChainId: "0x66eee",
-     *     signatures: [signature],
-     *     payload: {
-     *       multiSigUser,
-     *       outerSigner: wallet.address,
-     *       action,
-     *     }
-     *   },
-     *   nonce,
-     *   hyperliquidChain: "Testnet",
-     *   signatureChainId: "0x66eee",
-     * });
-     * ```
-     */
-    async function signMultiSigAction(args) {
-        const { wallet, action, nonce, hyperliquidChain, signatureChainId, vaultAddress, expiresAfter, } = args;
-        const multiSigActionHash = createL1ActionHash(action, nonce, vaultAddress, expiresAfter);
-        const message = {
-            multiSigActionHash,
-            hyperliquidChain,
-            signatureChainId,
-            nonce,
-        };
-        return await signUserSignedAction({
-            wallet,
-            action: message,
-            types: {
-                "HyperliquidTransaction:SendMultiSig": [
-                    { name: "hyperliquidChain", type: "string" },
-                    { name: "multiSigActionHash", type: "bytes32" },
-                    { name: "nonce", type: "uint64" },
-                ],
-            },
-            chainId: parseInt(signatureChainId, 16),
-        });
-    }
-    /** Signs typed data with the provided wallet using EIP-712. */
-    async function abstractSignTypedData(args) {
-        const { wallet, domain, types, message } = args;
-        if (isAbstractViemWalletClient(wallet)) {
-            return await wallet.signTypedData({
-                domain,
-                types: {
-                    EIP712Domain: [
-                        { name: "name", type: "string" },
-                        { name: "version", type: "string" },
-                        { name: "chainId", type: "uint256" },
-                        { name: "verifyingContract", type: "address" },
-                    ],
-                    ...types,
-                },
-                primaryType: Object.keys(types)[0],
-                message,
-            });
-        }
-        else if (isAbstractEthersSigner(wallet)) {
-            return await wallet.signTypedData(domain, types, message);
-        }
-        else if (isAbstractEthersV5Signer(wallet)) {
-            return await wallet._signTypedData(domain, types, message);
-        }
-        else if (isAbstractWindowEthereum(wallet)) {
-            return await signTypedDataWithWindowEthereum(wallet, domain, types, message);
-        }
-        else {
-            throw new Error("Unsupported wallet for signing typed data");
-        }
-    }
-    /** Signs typed data using `window.ethereum` (EIP-1193) with `eth_signTypedData_v4` (EIP-712). */
-    async function signTypedDataWithWindowEthereum(ethereum, domain, types, message) {
-        const accounts = await ethereum.request({
-            method: "eth_requestAccounts",
-            params: [],
-        });
-        if (!Array.isArray(accounts) || accounts.length === 0) {
-            throw new Error("No Ethereum accounts available");
-        }
-        const from = accounts[0];
-        const dataToSign = JSON.stringify({
-            domain,
-            types: {
-                EIP712Domain: [
-                    { name: "name", type: "string" },
-                    { name: "version", type: "string" },
-                    { name: "chainId", type: "uint256" },
-                    { name: "verifyingContract", type: "address" },
-                ],
-                ...types,
-            },
-            primaryType: Object.keys(types)[0],
-            message,
-        });
-        return await ethereum.request({
-            method: "eth_signTypedData_v4",
-            params: [from, dataToSign],
-        });
-    }
-    /** Splits a signature hexadecimal string into its components. */
-    function splitSignature(signature) {
-        const r = `0x${signature.slice(2, 66)}`;
-        const s = `0x${signature.slice(66, 130)}`;
-        const v = parseInt(signature.slice(130, 132), 16);
-        return { r, s, v };
-    }
-    /** Checks if the given value is an abstract viem wallet. */
-    function isAbstractViemWalletClient(client) {
-        return typeof client === "object" && client !== null &&
-            "signTypedData" in client && typeof client.signTypedData === "function" &&
-            (client.signTypedData.length === 1 || client.signTypedData.length === 2);
-    }
-    /** Checks if the given value is an abstract ethers signer. */
-    function isAbstractEthersSigner(client) {
-        return typeof client === "object" && client !== null &&
-            "signTypedData" in client && typeof client.signTypedData === "function" &&
-            client.signTypedData.length === 3;
-    }
-    /** Checks if the given value is an abstract ethers v5 signer. */
-    function isAbstractEthersV5Signer(client) {
-        return typeof client === "object" && client !== null &&
-            "_signTypedData" in client && typeof client._signTypedData === "function" &&
-            client._signTypedData.length === 3;
-    }
-    /** Checks if the given value is an abstract `window.ethereum` object. */
-    function isAbstractWindowEthereum(client) {
-        return typeof client === "object" && client !== null &&
-            "request" in client && typeof client.request === "function" &&
-            client.request.length >= 1;
-    }
     /** Action sorter for correct signature generation. */
     exports.actionSorter = {
         /** Sorts and formats an `approveAgent` action. */

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

@@ -0,0 +1,23 @@
+import type { Hex } from "../base.js";
+/** Abstract interface for a [viem wallet](https://viem.sh/docs/clients/wallet). */
+export interface AbstractViemWalletClient {
+    signTypedData(params: {
+        domain: {
+            name: string;
+            version: string;
+            chainId: number;
+            verifyingContract: Hex;
+        };
+        types: {
+            [key: string]: {
+                name: string;
+                type: string;
+            }[];
+        };
+        primaryType: string;
+        message: Record<string, unknown>;
+    }, options?: unknown): Promise<Hex>;
+}
+/** Checks if the given value is an abstract viem wallet. */
+export declare function isAbstractViemWalletClient(client: unknown): client is AbstractViemWalletClient;
+//# sourceMappingURL=_viem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_viem.d.ts","sourceRoot":"","sources":["../../../src/src/signing/_viem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,mFAAmF;AACnF,MAAM,WAAW,wBAAwB;IACrC,aAAa,CACT,MAAM,EAAE;QACJ,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,GAAG,CAAC;SAC1B,CAAC;QACF,KAAK,EAAE;YACH,CAAC,GAAG,EAAE,MAAM,GAAG;gBACX,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;aAChB,EAAE,CAAC;SACP,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,EACD,OAAO,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,GAAG,CAAC,CAAC;CACnB;AAED,4DAA4D;AAC5D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F"}

package/script/src/signing/_viem.js

@@ -0,0 +1,19 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isAbstractViemWalletClient = isAbstractViemWalletClient;
+    /** Checks if the given value is an abstract viem wallet. */
+    function isAbstractViemWalletClient(client) {
+        return typeof client === "object" && client !== null &&
+            "signTypedData" in client && typeof client.signTypedData === "function" &&
+            (client.signTypedData.length === 1 || client.signTypedData.length === 2);
+    }
+});

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

@@ -0,0 +1,23 @@
+import type { Hex } from "../base.js";
+/** Abstract interface for a [window.ethereum](https://eips.ethereum.org/EIPS/eip-1193) object. */
+export interface AbstractWindowEthereum {
+    request(args: {
+        method: any;
+        params: any;
+    }): Promise<any>;
+}
+/** Signs typed data using `window.ethereum` (EIP-1193) with `eth_signTypedData_v4` (EIP-712). */
+export declare function signTypedDataWithWindowEthereum(ethereum: AbstractWindowEthereum, domain: {
+    name: string;
+    version: string;
+    chainId: number;
+    verifyingContract: Hex;
+}, types: {
+    [key: string]: {
+        name: string;
+        type: string;
+    }[];
+}, message: Record<string, unknown>): Promise<Hex>;
+/** Checks if the given value is an abstract `window.ethereum` object. */
+export declare function isAbstractWindowEthereum(client: unknown): client is AbstractWindowEthereum;
+//# sourceMappingURL=_window.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_window.d.ts","sourceRoot":"","sources":["../../../src/src/signing/_window.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,kGAAkG;AAClG,MAAM,WAAW,sBAAsB;IAEnC,OAAO,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7D;AAED,iGAAiG;AACjG,wBAAsB,+BAA+B,CACjD,QAAQ,EAAE,sBAAsB,EAChC,MAAM,EAAE;IACJ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,GAAG,CAAC;CAC1B,EACD,KAAK,EAAE;IACH,CAAC,GAAG,EAAE,MAAM,GAAG;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;CACP,EACD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,OAAO,CAAC,GAAG,CAAC,CAsBd;AAED,yEAAyE;AACzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F"}

package/script/src/signing/_window.js

@@ -0,0 +1,43 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.signTypedDataWithWindowEthereum = signTypedDataWithWindowEthereum;
+    exports.isAbstractWindowEthereum = isAbstractWindowEthereum;
+    /** Signs typed data using `window.ethereum` (EIP-1193) with `eth_signTypedData_v4` (EIP-712). */
+    async function signTypedDataWithWindowEthereum(ethereum, domain, types, message) {
+        const accounts = await ethereum.request({ method: "eth_requestAccounts", params: [] });
+        if (!Array.isArray(accounts) || accounts.length === 0) {
+            throw new Error("No Ethereum accounts available");
+        }
+        const from = accounts[0];
+        const dataToSign = JSON.stringify({
+            domain,
+            types: {
+                EIP712Domain: [
+                    { name: "name", type: "string" },
+                    { name: "version", type: "string" },
+                    { name: "chainId", type: "uint256" },
+                    { name: "verifyingContract", type: "address" },
+                ],
+                ...types,
+            },
+            primaryType: Object.keys(types)[0],
+            message,
+        });
+        return await ethereum.request({ method: "eth_signTypedData_v4", params: [from, dataToSign] });
+    }
+    /** Checks if the given value is an abstract `window.ethereum` object. */
+    function isAbstractWindowEthereum(client) {
+        return typeof client === "object" && client !== null &&
+            "request" in client && typeof client.request === "function" &&
+            client.request.length >= 1;
+    }
+});