@nktkas/hyperliquid 0.19.0 → 0.19.2

package/script/src/clients/wallet.js

@@ -575,6 +575,58 @@
             this._validateResponse(response);
             return response;
         }
+        /**
+         * Convert a single-signature account to a multi-signature account.
+         * @param args - The parameters for the request.
+         * @param signal - An optional abort signal.
+         * @returns Successful response without specific data.
+         * @throws {ApiRequestError} When the API returns an error response.
+         *
+         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
+         * @example
+         * ```ts
+         * import * as hl from "@nktkas/hyperliquid";
+         * import { privateKeyToAccount } from "viem/accounts";
+         *
+         * const wallet = privateKeyToAccount("0x...");
+         * const transport = new hl.HttpTransport(); // or WebSocketTransport
+         * const client = new hl.WalletClient({ wallet, transport });
+         *
+         * const result = await client.convertToMultiSigUser({
+         *   authorizedUsers: ["0x...", "0x..."],
+         *   threshold: 2,
+         * });
+         * ```
+         */
+        async convertToMultiSigUser(args, signal) {
+            // Construct an action
+            const action = {
+                type: "convertToMultiSigUser",
+                hyperliquidChain: this._getHyperliquidChain(),
+                signatureChainId: await this._getSignatureChainId(),
+                signers: JSON.stringify(args),
+                nonce: await this.nonceManager(),
+            };
+            // Sign the action
+            const signature = await (0, signing_js_1.signUserSignedAction)({
+                wallet: this.wallet,
+                action,
+                types: {
+                    "HyperliquidTransaction:ConvertToMultiSigUser": [
+                        { name: "hyperliquidChain", type: "string" },
+                        { name: "signers", type: "string" },
+                        { name: "nonce", type: "uint64" },
+                    ],
+                },
+                chainId: parseInt(action.signatureChainId, 16),
+            });
+            // Send a request
+            const request = { action, signature, nonce: action.nonce };
+            const response = await this.transport.request("exchange", request, signal);
+            // Validate a response
+            this._validateResponse(response);
+            return response;
+        }
         /**
          * Create a sub-account.
          * @param args - The parameters for the request.
@@ -664,6 +716,88 @@
             this._validateResponse(response);
             return response;
         }
+        async cSignerAction(args, signal) {
+            // Destructure the parameters
+            const { expiresAfter = await this._getDefaultExpiresAfter(), ...actionArgs } = args;
+            // Construct an action
+            const nonce = await this.nonceManager();
+            const action = {
+                type: "CSignerAction",
+                ...actionArgs,
+            };
+            // Sign the action
+            const signature = await (0, signing_js_1.signL1Action)({
+                wallet: this.wallet,
+                action,
+                nonce,
+                isTestnet: this.isTestnet,
+                expiresAfter,
+            });
+            // Send a request
+            const request = { action, signature, nonce, expiresAfter };
+            const response = await this.transport.request("exchange", request, signal);
+            // Validate a response
+            this._validateResponse(response);
+            return response;
+        }
+        async cValidatorAction(args, signal) {
+            // Destructure the parameters
+            const { expiresAfter = await this._getDefaultExpiresAfter(), ...actionArgs } = args;
+            // Construct an action
+            const nonce = await this.nonceManager();
+            let action;
+            if ("changeProfile" in actionArgs) {
+                action = {
+                    type: "CValidatorAction",
+                    changeProfile: {
+                        node_ip: actionArgs.changeProfile.node_ip ?? null,
+                        name: actionArgs.changeProfile.name ?? null,
+                        description: actionArgs.changeProfile.description ?? null,
+                        unjailed: actionArgs.changeProfile.unjailed,
+                        disable_delegations: actionArgs.changeProfile.disable_delegations ?? null,
+                        commission_bps: actionArgs.changeProfile.commission_bps ?? null,
+                        signer: actionArgs.changeProfile.signer?.toLowerCase() ?? null,
+                    },
+                };
+            }
+            else if ("register" in actionArgs) {
+                action = {
+                    type: "CValidatorAction",
+                    register: {
+                        profile: {
+                            node_ip: { Ip: actionArgs.register.profile.node_ip.Ip },
+                            name: actionArgs.register.profile.name,
+                            description: actionArgs.register.profile.description,
+                            delegations_disabled: actionArgs.register.profile.delegations_disabled,
+                            commission_bps: actionArgs.register.profile.commission_bps,
+                            signer: actionArgs.register.profile.signer?.toLowerCase(),
+                        },
+                        unjailed: actionArgs.register.unjailed,
+                        initial_wei: actionArgs.register.initial_wei,
+                    },
+                };
+            }
+            else {
+                action = {
+                    type: "CValidatorAction",
+                    unregister: actionArgs.unregister,
+                };
+            }
+            // Sign the action
+            const signature = await (0, signing_js_1.signL1Action)({
+                wallet: this.wallet,
+                action,
+                nonce,
+                isTestnet: this.isTestnet,
+                expiresAfter,
+            });
+            // Send a request
+            const request = { action, signature, nonce, expiresAfter };
+            const response = await this.transport.request("exchange", request, signal);
+            // Validate a response
+            this._validateResponse(response);
+            return response;
+        }
         /**
          * Transfer native token from staking into the user's spot account.
          * @param args - The parameters for the request.
@@ -837,6 +971,85 @@
             this._validateResponse(response);
             return response;
         }
+        /**
+         * A multi-signature request.
+         * @param args - The parameters for the request.
+         * @param signal - An optional abort signal.
+         * @returns Successful response without specific data.
+         * @throws {ApiRequestError} When the API returns an error response.
+         *
+         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
+         * @example
+         * ```ts
+         * import * as hl from "@nktkas/hyperliquid";
+         * import { privateKeyToAccount } from "viem/accounts";
+         *
+         * const wallet = privateKeyToAccount("0x...");
+         * const transport = new hl.HttpTransport(); // or WebSocketTransport
+         * const client = new hl.WalletClient({ wallet, transport });
+         *
+         * const multiSigUser = "0x..."; // Multi-sig user address
+         *
+         * const nonce = Date.now();
+         * const action = { type: "scheduleCancel", time: Date.now() + 10000 };
+         *
+         * const signature = await hl.signL1Action({
+         *   wallet,
+         *   action: [multiSigUser.toLowerCase(), signer1.address.toLowerCase(), action],
+         *   nonce,
+         *   isTestnet: true,
+         * });
+         *
+         * const result = await client.multiSig({
+         *   signatures: [signature],
+         *   payload: {
+         *     multiSigUser,
+         *     outerSigner: wallet.address,
+         *     action,
+         *   },
+         *   nonce,
+         * });
+         * ```
+         * @unstable May not behave as expected and the interface may change in the future.
+         */
+        async multiSig(args, signal) {
+            // Destructure the parameters
+            const { vaultAddress = this.defaultVaultAddress, expiresAfter = await this._getDefaultExpiresAfter(), nonce, ...actionArgs } = args;
+            // Construct an action
+            const hyperliquidChain = this._getHyperliquidChain();
+            const action = {
+                type: "multiSig",
+                signatureChainId: await this._getSignatureChainId(),
+                signatures: actionArgs.signatures.map((signature) => ({
+                    r: signature.r.replace(/^0x0+/, "0x").toLowerCase(),
+                    s: signature.s.replace(/^0x0+/, "0x").toLowerCase(),
+                    v: signature.v,
+                })),
+                payload: {
+                    multiSigUser: actionArgs.payload.multiSigUser.toLowerCase(),
+                    outerSigner: actionArgs.payload.outerSigner.toLowerCase(),
+                    action: actionArgs.payload.action,
+                },
+            };
+            // Sign the action
+            const actionForMultiSig = structuredClone(action);
+            delete actionForMultiSig.type;
+            const signature = await (0, signing_js_1.signMultiSigAction)({
+                wallet: this.wallet,
+                action: actionForMultiSig,
+                nonce,
+                vaultAddress,
+                expiresAfter,
+                hyperliquidChain,
+                signatureChainId: action.signatureChainId,
+            });
+            // Send a request
+            const request = { action, signature, nonce, vaultAddress, expiresAfter };
+            const response = await this.transport.request("exchange", request, signal);
+            // Validate a response
+            this._validateResponse(response);
+            return response;
+        }
         /**
          * Place an order(s).
          * @param args - The parameters for the request.
@@ -931,16 +1144,6 @@
             this._validateResponse(response);
             return response;
         }
-        /**
-         * Deploying HIP-3 assets.
-         * @param args - The parameters for the request.
-         * @param signal - An optional abort signal.
-         * @returns Successful response without specific data.
-         * @throws {ApiRequestError} When the API returns an error response.
-         *
-         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-3-assets
-         * @untested
-         */
         async perpDeploy(args, signal) {
             // Construct an action
             const nonce = await this.nonceManager();
@@ -993,6 +1196,63 @@
             this._validateResponse(response);
             return response;
         }
+        /**
+         * Transfer funds between Spot account and Perp dex account.
+         * @param args - The parameters for the request.
+         * @param signal - An optional abort signal.
+         * @returns Successful response without specific data.
+         * @throws {ApiRequestError} When the API returns an error response.
+         *
+         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#transfer-from-spot-account-to-perp-account-and-vice-versa
+         * @example
+         * ```ts
+         * import * as hl from "@nktkas/hyperliquid";
+         * import { privateKeyToAccount } from "viem/accounts";
+         *
+         * const wallet = privateKeyToAccount("0x...");
+         * const transport = new hl.HttpTransport(); // or WebSocketTransport
+         * const client = new hl.WalletClient({ wallet, transport });
+         *
+         * const result = await client.perpDexClassTransfer({
+         *   dex: "test",
+         *   token: "USDC",
+         *   amount: "1",
+         *   toPerp: true,
+         * });
+         * ```
+         */
+        async perpDexClassTransfer(args, signal) {
+            // Construct an action
+            const action = {
+                ...args,
+                type: "PerpDexClassTransfer",
+                hyperliquidChain: this._getHyperliquidChain(),
+                signatureChainId: await this._getSignatureChainId(),
+                nonce: await this.nonceManager(),
+            };
+            // Sign the action
+            const signature = await (0, signing_js_1.signUserSignedAction)({
+                wallet: this.wallet,
+                action,
+                types: {
+                    "HyperliquidTransaction:PerpDexClassTransfer": [
+                        { name: "hyperliquidChain", type: "string" },
+                        { name: "dex", type: "string" },
+                        { name: "token", type: "string" },
+                        { name: "amount", type: "string" },
+                        { name: "toPerp", type: "bool" },
+                        { name: "nonce", type: "uint64" },
+                    ],
+                },
+                chainId: parseInt(action.signatureChainId, 16),
+            });
+            // Send a request
+            const request = { action, signature, nonce: action.nonce };
+            const response = await this.transport.request("exchange", request, signal);
+            // Validate a response
+            this._validateResponse(response);
+            return response;
+        }
         /**
          * Create a referral code.
          * @param args - The parameters for the request.
@@ -1078,27 +1338,9 @@
             this._validateResponse(response);
             return response;
         }
-        /**
-         * Schedule a cancel-all operation at a future time.
-         * @param args - The parameters for the request.
-         * @param signal - An optional abort signal.
-         * @returns Successful response without specific data.
-         * @throws {ApiRequestError} When the API returns an error response.
-         *
-         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
-         * @example
-         * ```ts
-         * import * as hl from "@nktkas/hyperliquid";
-         * import { privateKeyToAccount } from "viem/accounts";
-         *
-         * const wallet = privateKeyToAccount("0x...");
-         * const transport = new hl.HttpTransport(); // or WebSocketTransport
-         * const client = new hl.WalletClient({ wallet, transport });
-         *
-         * const result = await client.scheduleCancel({ time: Date.now() + 3600000 });
-         * ```
-         */
-        async scheduleCancel(args = {}, signal) {
+        async scheduleCancel(args_or_signal, maybeSignal) {
+            const args = args_or_signal instanceof AbortSignal ? {} : args_or_signal ?? {};
+            const signal = args_or_signal instanceof AbortSignal ? args_or_signal : maybeSignal;
             // Destructure the parameters
             const { vaultAddress = this.defaultVaultAddress, expiresAfter = await this._getDefaultExpiresAfter(), ...actionArgs } = args;
             // Construct an action
@@ -1207,16 +1449,6 @@
             this._validateResponse(response);
             return response;
         }
-        /**
-         * Deploying HIP-1 and HIP-2 assets.
-         * @param args - The parameters for the request.
-         * @param signal - An optional abort signal.
-         * @returns Successful response without specific data.
-         * @throws {ApiRequestError} When the API returns an error response.
-         *
-         * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-1-and-hip-2-assets
-         * @untested
-         */
         async spotDeploy(args, signal) {
             // Construct an action
             const nonce = await this.nonceManager();
@@ -1763,7 +1995,7 @@
             return response;
         }
         /**
-         * Transfer funds between Spot and Perp accounts.
+         * Transfer funds between Spot account and Perp account.
          * @param args - The parameters for the request.
          * @param signal - An optional abort signal.
          * @returns Successful response without specific data.
@@ -2062,7 +2294,7 @@
         /** Guesses the chain ID based on the wallet type or the isTestnet flag. */
         async _guessSignatureChainId() {
             // Trying to get chain ID of the wallet
-            if ((0, signing_js_1.isAbstractViemWalletClient)(this.wallet)) {
+            if ((0, signing_js_1.isAbstractViemWalletClient)(this.wallet) || (0, signing_js_1.isAbstractExtendedViemWalletClient)(this.wallet)) {
                 if ("getChainId" in this.wallet && typeof this.wallet.getChainId === "function") {
                     const chainId = await this.wallet.getChainId();
                     return `0x${chainId.toString(16)}`;

package/script/src/signing.d.ts

@@ -51,6 +51,8 @@ import { type ValueMap, type ValueType } from "../deps/jsr.io/@std/msgpack/1.0.3
 import type { Hex } from "./base.js";
 export type { Hex };
 export type { ValueMap, ValueType };
+/** Abstract interface for a wallet that can sign typed data. */
+export type AbstractWallet = AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer | AbstractExtendedViemWalletClient | AbstractWindowEthereum;
 /** Abstract interface for a [viem wallet](https://viem.sh/docs/clients/wallet). */
 export interface AbstractViemWalletClient {
     signTypedData(params: {
@@ -98,7 +100,7 @@ export interface AbstractEthersV5Signer {
         }[];
     }, value: Record<string, unknown>): Promise<string>;
 }
-/** Abstract interface for an extended [viem wallet](https://viem.sh/docs/clients/wallet) (e.g. privy [useSignTypedData](https://docs.privy.io/reference/sdk/react-auth/functions/useSignTypedData#returns)). */
+/** Abstract interface for an extended [viem wallet](https://viem.sh/docs/clients/wallet) (e.g. privy [useSignTypedData](https://docs.privy.io/wallets/using-wallets/ethereum/sign-typed-data)). */
 export interface AbstractExtendedViemWalletClient {
     signTypedData(params: {
         domain: {
@@ -146,7 +148,7 @@ export declare function createL1ActionHash(action: ValueType, nonce: number, vau
  * import { signL1Action } from "@nktkas/hyperliquid/signing";
  * import { privateKeyToAccount } from "viem/accounts";
  *
- * const wallet = privateKeyToAccount("0x..."); // Change to your private key
+ * const wallet = privateKeyToAccount("0x..."); // Your private key
  *
  * const action = {
  *     type: "cancel",
@@ -173,7 +175,7 @@ export declare function createL1ActionHash(action: ValueType, nonce: number, vau
  */
 export declare function signL1Action(args: {
     /** Wallet to sign the action. */
-    wallet: AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer | AbstractExtendedViemWalletClient | AbstractWindowEthereum;
+    wallet: AbstractWallet;
     /** The action to be signed. */
     action: ValueType;
     /** Unique request identifier (recommended current timestamp in ms). */
@@ -200,7 +202,7 @@ export declare function signL1Action(args: {
  * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
  * import { privateKeyToAccount } from "viem/accounts";
  *
- * const wallet = privateKeyToAccount("0x..."); // Change to your private key
+ * const wallet = privateKeyToAccount("0x..."); // Your private key
  *
  * const action = {
  *     type: "approveAgent",
@@ -235,7 +237,7 @@ export declare function signL1Action(args: {
  */
 export declare function signUserSignedAction(args: {
     /** Wallet to sign the action. */
-    wallet: AbstractViemWalletClient | AbstractEthersSigner | AbstractEthersV5Signer | AbstractExtendedViemWalletClient | AbstractWindowEthereum;
+    wallet: AbstractWallet;
     /** The action to be signed. */
     action: Record<string, unknown>;
     /** The types of the action. */
@@ -252,6 +254,74 @@ export declare function signUserSignedAction(args: {
     s: Hex;
     v: number;
 }>;
+/**
+ * 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",
+ * });
+ * ```
+ * @unstable May not behave as expected and the interface may change in the future.
+ */
+export declare function signMultiSigAction(args: {
+    /** Wallet to sign the action. */
+    wallet: AbstractWallet;
+    /** The action to be signed. */
+    action: ValueMap;
+    /** Unique request identifier (recommended current timestamp in ms). */
+    nonce: number;
+    /** Optional vault address used in the action. */
+    vaultAddress?: Hex;
+    /** Optional expiration time of the action in milliseconds since the epoch. */
+    expiresAfter?: number;
+    /** HyperLiquid network ("Mainnet" or "Testnet"). */
+    hyperliquidChain: "Mainnet" | "Testnet";
+    /** Chain ID used for signing. */
+    signatureChainId: Hex;
+}): Promise<{
+    r: Hex;
+    s: Hex;
+    v: number;
+}>;
 /** Checks if the given value is an abstract viem wallet. */
 export declare function isAbstractViemWalletClient(client: unknown): client is AbstractViemWalletClient;
 /** Checks if the given value is an abstract ethers signer. */

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

@@ -1 +1 @@
-{"version":3,"file":"signing.d.ts","sourceRoot":"","sources":["../../src/src/signing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAGH,OAAO,EAA2B,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAGrH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,YAAY,EAAE,GAAG,EAAE,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAEpC,mFAAmF;AACnF,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,MAAM,EAAE;QAClB,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,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpB;AAED,sGAAsG;AACtG,MAAM,WAAW,oBAAoB;IACjC,aAAa,CACT,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yGAAyG;AACzG,MAAM,WAAW,sBAAsB;IACnC,cAAc,CACV,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,gNAAgN;AAChN,MAAM,WAAW,gCAAgC;IAC7C,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,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;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,GAAG,CA+BnH;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE;IACrC,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA+BzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC7C,iCAAiC;IACjC,MAAM,EACA,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC3D,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAYzC;AAyGD,4DAA4D;AAC5D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F;AAED,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAItF;AAED,iEAAiE;AACjE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F;AAED,qGAAqG;AACrG,wBAAgB,kCAAkC,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAItG;AAED,yEAAyE;AACzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F"}
+{"version":3,"file":"signing.d.ts","sourceRoot":"","sources":["../../src/src/signing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAGH,OAAO,EAA2B,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,6CAA6C,CAAC;AAGrH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,YAAY,EAAE,GAAG,EAAE,CAAC;AACpB,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAEpC,gEAAgE;AAChE,MAAM,MAAM,cAAc,GACpB,wBAAwB,GACxB,oBAAoB,GACpB,sBAAsB,GACtB,gCAAgC,GAChC,sBAAsB,CAAC;AAE7B,mFAAmF;AACnF,MAAM,WAAW,wBAAwB;IACrC,aAAa,CAAC,MAAM,EAAE;QAClB,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,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpB;AAED,sGAAsG;AACtG,MAAM,WAAW,oBAAoB;IACjC,aAAa,CACT,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yGAAyG;AACzG,MAAM,WAAW,sBAAsB;IACnC,cAAc,CACV,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,EACD,KAAK,EAAE;QACH,CAAC,GAAG,EAAE,MAAM,GAAG;YACX,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SAChB,EAAE,CAAC;KACP,EACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,mMAAmM;AACnM,MAAM,WAAW,gCAAgC;IAC7C,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,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;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,GAAG,CA+BnH;AA4BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE;IACrC,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,+BAA+B;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA+BzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC7C,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC3D,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAYzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE;IAC3C,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,+BAA+B;IAC/B,MAAM,EAAE,QAAQ,CAAC;IACjB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;IACxC,iCAAiC;IACjC,gBAAgB,EAAE,GAAG,CAAC;CACzB,GAAG,OAAO,CAAC;IAAE,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA+BzC;AAoGD,4DAA4D;AAC5D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAI9F;AAED,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAItF;AAED,iEAAiE;AACjE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F;AAED,qGAAqG;AACrG,wBAAgB,kCAAkC,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,wBAAwB,CAItG;AAED,yEAAyE;AACzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,sBAAsB,CAI1F"}

package/script/src/signing.js

@@ -61,6 +61,7 @@
     exports.createL1ActionHash = createL1ActionHash;
     exports.signL1Action = signL1Action;
     exports.signUserSignedAction = signUserSignedAction;
+    exports.signMultiSigAction = signMultiSigAction;
     exports.isAbstractViemWalletClient = isAbstractViemWalletClient;
     exports.isAbstractEthersSigner = isAbstractEthersSigner;
     exports.isAbstractEthersV5Signer = isAbstractEthersV5Signer;
@@ -136,7 +137,7 @@
      * import { signL1Action } from "@nktkas/hyperliquid/signing";
      * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x..."); // Change to your private key
+     * const wallet = privateKeyToAccount("0x..."); // Your private key
      *
      * const action = {
      *     type: "cancel",
@@ -194,7 +195,7 @@
      * import { signUserSignedAction } from "@nktkas/hyperliquid/signing";
      * import { privateKeyToAccount } from "viem/accounts";
      *
-     * const wallet = privateKeyToAccount("0x..."); // Change to your private key
+     * const wallet = privateKeyToAccount("0x..."); // Your private key
      *
      * const action = {
      *     type: "approveAgent",
@@ -238,6 +239,76 @@
         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",
+     * });
+     * ```
+     * @unstable May not behave as expected and the interface may change in the future.
+     */
+    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;