@hfunlabs/hyperliquid 0.30.2-hfunlabs.2 → 0.32.2-hfunlabs.2

package/esm/signing/_canonicalize.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Schema-driven key canonicalization for Hyperliquid action objects.
+ * @module
+ */
+import type { GenericSchema } from "valibot";
+import { HyperliquidError } from "../_base.js";
+/** Thrown when canonicalization fails due to schema/data key mismatch. */
+export declare class CanonicalizeError extends HyperliquidError {
+    constructor(message: string);
+}
+/**
+ * Recursively rebuilds a value with object keys in schema-definition order.
+ *
+ * @param schema A valibot schema defining the canonical key order.
+ * @param value The value whose keys should be reordered.
+ * @return A new value with keys in schema-definition order.
+ *
+ * @throws {CanonicalizeError} If keys in data don't match the schema.
+ *
+ * @example
+ * ```ts
+ * import { canonicalize } from "@nktkas/hyperliquid/signing";
+ * import { CancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ *
+ * const action = canonicalize(CancelRequest.entries.action, {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * });
+ * ```
+ */
+export declare function canonicalize<T>(schema: GenericSchema, value: T): T;
+//# sourceMappingURL=_canonicalize.d.ts.map

package/esm/signing/_canonicalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_canonicalize.d.ts","sourceRoot":"","sources":["../../src/signing/_canonicalize.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,0EAA0E;AAC1E,qBAAa,iBAAkB,SAAQ,gBAAgB;gBACzC,OAAO,EAAE,MAAM;CAI5B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAElE"}

package/esm/signing/_canonicalize.js

@@ -0,0 +1,137 @@
+/**
+ * Schema-driven key canonicalization for Hyperliquid action objects.
+ * @module
+ */
+import { HyperliquidError } from "../_base.js";
+/** Thrown when canonicalization fails due to schema/data key mismatch. */
+export class CanonicalizeError extends HyperliquidError {
+    constructor(message) {
+        super(message);
+        this.name = "CanonicalizeError";
+    }
+}
+/**
+ * Recursively rebuilds a value with object keys in schema-definition order.
+ *
+ * @param schema A valibot schema defining the canonical key order.
+ * @param value The value whose keys should be reordered.
+ * @return A new value with keys in schema-definition order.
+ *
+ * @throws {CanonicalizeError} If keys in data don't match the schema.
+ *
+ * @example
+ * ```ts
+ * import { canonicalize } from "@nktkas/hyperliquid/signing";
+ * import { CancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ *
+ * const action = canonicalize(CancelRequest.entries.action, {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * });
+ * ```
+ */
+export function canonicalize(schema, value) {
+    return walk(schema, value);
+}
+// ============================================================
+// Recursive walker
+// ============================================================
+function walk(schema, value) {
+    const t = schema.type;
+    // Unwrap optional / nullable / nullish
+    if (t === "optional" || t === "nullable" || t === "nullish") {
+        return value === null || value === undefined ? value : walk(schema.wrapped, value);
+    }
+    // Object → reorder keys by schema.entries
+    if (t === "object" && isRecord(value)) {
+        return reorderObject(schema.entries, value);
+    }
+    // Array → canonicalize each item
+    if (t === "array" && Array.isArray(value)) {
+        return value.map((item) => walk(schema.item, item));
+    }
+    // Tuple → canonicalize each item by index
+    if (t === "tuple" && Array.isArray(value)) {
+        return value.map((item, i) => walk(schema.items[i], item));
+    }
+    // Variant → match option by discriminator + structural fallback
+    if (t === "variant" && isRecord(value)) {
+        const option = matchVariantOption(schema.key, schema.options, value);
+        if (option)
+            return walk(option, value);
+        throw new CanonicalizeError(`No variant option matches data (discriminator "${schema.key}" = ${JSON.stringify(value[schema.key])})`);
+    }
+    // Union → match option structurally
+    if (t === "union" && isRecord(value)) {
+        const option = matchByStructure(schema.options, value);
+        if (option)
+            return walk(option, value);
+        return value;
+    }
+    // Primitives, literals, picklists, enums → return as-is
+    return value;
+}
+// ============================================================
+// Helpers
+// ============================================================
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function reorderObject(entries, value) {
+    for (const key of Object.keys(value)) {
+        if (!(key in entries)) {
+            throw new CanonicalizeError(`Key "${key}" exists in data but not in schema`);
+        }
+    }
+    for (const key of Object.keys(entries)) {
+        if (!(key in value)) {
+            const t = entries[key].type;
+            if (t !== "optional" && t !== "nullable" && t !== "nullish") {
+                throw new CanonicalizeError(`Required key "${key}" exists in schema but not in data`);
+            }
+        }
+    }
+    const result = {};
+    for (const key of Object.keys(entries)) {
+        if (key in value) {
+            result[key] = walk(entries[key], value[key]);
+        }
+    }
+    return result;
+}
+function matchVariantOption(discriminatorKey, options, value) {
+    const discriminatorValue = value[discriminatorKey];
+    const matching = [];
+    for (const option of options) {
+        if (option.type === "object" && option.entries && discriminatorKey in option.entries) {
+            const keySchema = option.entries[discriminatorKey];
+            if (keySchema.type === "literal" && keySchema.literal === discriminatorValue) {
+                matching.push(option);
+            }
+        }
+    }
+    if (matching.length === 1)
+        return matching[0];
+    if (matching.length > 1)
+        return matchByStructure(matching, value);
+    return undefined;
+}
+function matchByStructure(options, value) {
+    const dataKeys = new Set(Object.keys(value));
+    for (const option of options) {
+        if (option.type === "object" && option.entries) {
+            if ([...dataKeys].every((k) => k in option.entries)) {
+                const allRequired = Object.keys(option.entries).every((k) => {
+                    if (dataKeys.has(k))
+                        return true;
+                    const t = option.entries[k].type;
+                    return t === "optional" || t === "nullable" || t === "nullish";
+                });
+                if (allRequired)
+                    return option;
+            }
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=_canonicalize.js.map

package/esm/signing/_canonicalize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_canonicalize.js","sourceRoot":"","sources":["../../src/signing/_canonicalize.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,0EAA0E;AAC1E,MAAM,OAAO,iBAAkB,SAAQ,gBAAgB;IACrD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAAI,MAAqB,EAAE,KAAQ;IAC7D,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAM,CAAC;AAClC,CAAC;AAiBD,+DAA+D;AAC/D,mBAAmB;AACnB,+DAA+D;AAE/D,SAAS,IAAI,CAAC,MAAkB,EAAE,KAAc;IAC9C,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;IAEtB,uCAAuC;IACvC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;QAC5D,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAQ,EAAE,KAAK,CAAC,CAAC;IACtF,CAAC;IAED,0CAA0C;IAC1C,IAAI,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,OAAO,aAAa,CAAC,MAAM,CAAC,OAAQ,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,iCAAiC;IACjC,IAAI,CAAC,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,0CAA0C;IAC1C,IAAI,CAAC,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,gEAAgE;IAChE,IAAI,CAAC,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAI,EAAE,MAAM,CAAC,OAAQ,EAAE,KAAK,CAAC,CAAC;QACvE,IAAI,MAAM;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,IAAI,iBAAiB,CACzB,kDAAkD,MAAM,CAAC,GAAG,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAI,CAAC,CAAC,GAAG,CACzG,CAAC;IACJ,CAAC;IAED,oCAAoC;IACpC,IAAI,CAAC,KAAK,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAQ,EAAE,KAAK,CAAC,CAAC;QACxD,IAAI,MAAM;YAAE,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACxD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+DAA+D;AAC/D,UAAU;AACV,+DAA+D;AAE/D,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,aAAa,CAAC,OAAmC,EAAE,KAA8B;IACxF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,iBAAiB,CAAC,QAAQ,GAAG,oCAAoC,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YAC5B,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC5D,MAAM,IAAI,iBAAiB,CAAC,iBAAiB,GAAG,oCAAoC,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB,CACzB,gBAAwB,EACxB,OAA8B,EAC9B,KAA8B;IAE9B,MAAM,kBAAkB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnD,MAAM,QAAQ,GAAiB,EAAE,CAAC;IAClC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,IAAI,gBAAgB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrF,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YACnD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBAC7E,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAElE,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,gBAAgB,CACvB,OAA8B,EAC9B,KAA8B;IAE9B,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAC/C,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAQ,CAAC,EAAE,CAAC;gBACrD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC1D,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;wBAAE,OAAO,IAAI,CAAC;oBACjC,MAAM,CAAC,GAAG,MAAM,CAAC,OAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;oBAClC,OAAO,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,SAAS,CAAC;gBACjE,CAAC,CAAC,CAAC;gBACH,IAAI,WAAW;oBAAE,OAAO,MAAM,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/esm/signing/mod.d.ts

@@ -0,0 +1,293 @@
+/**
+ * Low-level utilities for signing Hyperliquid transactions.
+ * @module
+ */
+import { type AbstractWallet, type Signature } from "./_abstractWallet.js";
+export { type AbstractEthersV5Signer, type AbstractEthersV6Signer, type AbstractViemJsonRpcAccount, type AbstractViemLocalAccount, type AbstractWallet, AbstractWalletError, getWalletAddress, getWalletChainId, type Signature, } from "./_abstractWallet.js";
+export { canonicalize, CanonicalizeError } from "./_canonicalize.js";
+/**
+ * Creates a hash of the L1 action.
+ *
+ * @param args The action and metadata to hash
+ * @return The keccak256 hash as a hex string
+ *
+ * @example
+ * ```ts
+ * import { canonicalize, createL1ActionHash } from "@nktkas/hyperliquid/signing";
+ * import { CancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ *
+ * const action = canonicalize(CancelRequest.entries.action, {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * });
+ * const nonce = Date.now();
+ *
+ * const actionHash = createL1ActionHash({ action, nonce });
+ * ```
+ */
+export declare function createL1ActionHash(args: {
+    /** The action to be hashed (hash depends on key order). */
+    action: Record<string, unknown> | unknown[];
+    /** The current timestamp in ms. */
+    nonce: number;
+    /** Optional vault address used in the action. */
+    vaultAddress?: `0x${string}`;
+    /** Optional expiration time of the action in ms since the epoch. */
+    expiresAfter?: number;
+}): `0x${string}`;
+/**
+ * Signs an L1 action.
+ *
+ * @param args The wallet, action, and signing parameters
+ * @return The ECDSA signature components
+ *
+ * @throws {AbstractWalletError} If signing fails
+ *
+ * @example
+ * ```ts
+ * import { canonicalize, signL1Action } from "@nktkas/hyperliquid/signing";
+ * import { CancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers or any AbstractWallet
+ *
+ * const action = canonicalize(CancelRequest.entries.action, {
+ *   type: "cancel",
+ *   cancels: [{ a: 0, o: 12345 }],
+ * });
+ * const nonce = Date.now();
+ *
+ * const signature = await signL1Action({ wallet, action, nonce });
+ *
+ * // Send the signed action to the Hyperliquid API
+ * const response = await fetch("https://api.hyperliquid.xyz/exchange", {
+ *   method: "POST",
+ *   headers: { "Content-Type": "application/json" },
+ *   body: JSON.stringify({ action, signature, nonce }),
+ * });
+ * const body = await response.json();
+ * ```
+ */
+export declare function signL1Action(args: {
+    /** Wallet to sign the action. */
+    wallet: AbstractWallet;
+    /** The action to be signed (hash depends on key order). */
+    action: Record<string, unknown> | unknown[];
+    /** The current timestamp in ms. */
+    nonce: number;
+    /**
+     * 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 of the action in ms since the epoch. */
+    expiresAfter?: number;
+}): Promise<Signature>;
+/**
+ * Signs a user-signed action.
+ *
+ * @param args The wallet, action, and EIP-712 types
+ * @return The ECDSA signature components
+ *
+ * @throws {AbstractWalletError} If signing fails
+ *
+ * @example
+ * ```ts
+ * import { canonicalize, signUserSignedAction } from "@nktkas/hyperliquid/signing";
+ * import { ApproveAgentRequest, ApproveAgentTypes } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers or any AbstractWallet
+ *
+ * const action = canonicalize(ApproveAgentRequest.entries.action, {
+ *   type: "approveAgent",
+ *   signatureChainId: "0x66eee" as const,
+ *   hyperliquidChain: "Mainnet",
+ *   agentAddress: "0x...",
+ *   agentName: "Agent",
+ *   nonce: Date.now(),
+ * });
+ *
+ * const signature = await signUserSignedAction({ wallet, action, types: ApproveAgentTypes });
+ *
+ * // Send the signed action to the Hyperliquid API
+ * const response = await fetch("https://api.hyperliquid.xyz/exchange", {
+ *   method: "POST",
+ *   headers: { "Content-Type": "application/json" },
+ *   body: JSON.stringify({ action, signature, nonce: action.nonce }),
+ * });
+ * const body = await response.json();
+ * ```
+ */
+export declare function signUserSignedAction(args: {
+    /** Wallet to sign the action. */
+    wallet: AbstractWallet;
+    /** The action to be signed (hex strings must be in lower case). */
+    action: {
+        signatureChainId: `0x${string}`;
+        [key: string]: unknown;
+    };
+    /** The types of the action (hash depends on key order). */
+    types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    };
+}): Promise<Signature>;
+/**
+ * Signs a multi-signature action wrapper with the leader signer.
+ *
+ * @param args The wallet, action, and signing parameters
+ * @return The ECDSA signature components
+ *
+ * @throws {AbstractWalletError} If signing fails
+ *
+ * @example
+ * ```ts
+ * import { canonicalize, signL1Action, signMultiSigAction, trimSignature } from "@nktkas/hyperliquid/signing";
+ * import { ScheduleCancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers or any AbstractWallet
+ * const multiSigUser = "0x...";
+ *
+ * const action = canonicalize(ScheduleCancelRequest.entries.action, {
+ *   type: "scheduleCancel",
+ *   time: Date.now() + 10000,
+ * });
+ * const nonce = Date.now();
+ *
+ * // Create the required number of signatures
+ * const signatures = await Promise.all(["0x...", "0x..."].map(async (signerPrivKey) => {
+ *   const sig = await signL1Action({
+ *     wallet: privateKeyToAccount(signerPrivKey as `0x${string}`), // viem or ethers or any AbstractWallet
+ *     action: [multiSigUser.toLowerCase(), wallet.address.toLowerCase(), action], // hex strings must be in lower case
+ *     nonce,
+ *   });
+ *   return trimSignature(sig);
+ * }));
+ *
+ * // Then use signatures in the multi-sig action
+ * const multiSigAction = {
+ *   type: "multiSig",
+ *   signatureChainId: "0x66eee" as const,
+ *   signatures,
+ *   payload: {
+ *     multiSigUser,
+ *     outerSigner: wallet.address,
+ *     action,
+ *   },
+ * };
+ * const multiSigSignature = await signMultiSigAction({ wallet, action: multiSigAction, nonce });
+ *
+ * // Send the multi-sig action to the Hyperliquid API
+ * const response = await fetch("https://api.hyperliquid.xyz/exchange", {
+ *   method: "POST",
+ *   headers: { "Content-Type": "application/json" },
+ *   body: JSON.stringify({ action: multiSigAction, signature: multiSigSignature, nonce }),
+ * });
+ * const body = await response.json();
+ * ```
+ */
+export declare function signMultiSigAction(args: {
+    /** Wallet to sign the action. */
+    wallet: AbstractWallet;
+    /** The action to be signed (hash depends on key order). */
+    action: {
+        signatureChainId: `0x${string}`;
+        [key: string]: unknown;
+    };
+    /** The current timestamp in ms. */
+    nonce: number;
+    /**
+     * 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 of the action in ms since the epoch. */
+    expiresAfter?: number;
+}): Promise<Signature>;
+/**
+ * Signs an L1 action with multi-sig orchestration.
+ *
+ * Collects signatures from all signers, builds the multi-sig wrapper,
+ * and signs the wrapper with the leader (first signer).
+ *
+ * @param args The signers, action, and signing parameters
+ * @return A tuple of [multiSigAction, leaderSignature]
+ *
+ * @throws {AbstractWalletError} If signing fails
+ */
+export declare function signMultiSigL1(args: {
+    /** Array of wallets for multi-sig. First wallet is the leader. */
+    signers: readonly [AbstractWallet, ...AbstractWallet[]];
+    /** The multi-signature account address. */
+    multiSigUser: `0x${string}`;
+    /** The leader wallet address (outer signer). */
+    outerSigner: `0x${string}`;
+    /** Signature chain ID for EIP-712. */
+    signatureChainId: `0x${string}`;
+    /** The action payload. */
+    action: Record<string, unknown>;
+    /** The current timestamp in ms. */
+    nonce: number;
+    /**
+     * 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 of the action in ms since the epoch. */
+    expiresAfter?: number;
+}): Promise<[Record<string, unknown>, Signature]>;
+/**
+ * Signs a user-signed action (EIP-712) with multi-sig orchestration.
+ *
+ * Collects signatures from all signers (with multi-sig payload fields injected),
+ * builds the multi-sig wrapper, and signs the wrapper with the leader.
+ *
+ * @param args The signers, action, types, and signing parameters
+ * @return A tuple of [multiSigAction, leaderSignature]
+ *
+ * @throws {AbstractWalletError} If signing fails
+ */
+export declare function signMultiSigUserSigned(args: {
+    /** Array of wallets for multi-sig. First wallet is the leader. */
+    signers: readonly [AbstractWallet, ...AbstractWallet[]];
+    /** The multi-signature account address. */
+    multiSigUser: `0x${string}`;
+    /** The leader wallet address (outer signer). */
+    outerSigner: `0x${string}`;
+    /** The action payload (must include signatureChainId). */
+    action: {
+        signatureChainId: `0x${string}`;
+        [key: string]: unknown;
+    };
+    /** EIP-712 type definitions. */
+    types: {
+        [key: string]: {
+            name: string;
+            type: string;
+        }[];
+    };
+    /** The current timestamp in ms. */
+    nonce: number;
+    /**
+     * Indicates if the action is for the testnet.
+     *
+     * Default: `false`
+     */
+    isTestnet?: boolean;
+}): Promise<[Record<string, unknown>, Signature]>;
+/** Remove leading zeros from signature r,s components (required for multi-signature in Hyperliquid API). */
+export declare function trimSignature(sig: Signature): Signature;
+//# sourceMappingURL=mod.d.ts.map

package/esm/signing/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/signing/mod.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAiB,MAAM,sBAAsB,CAAC;AAE1F,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,SAAS,GACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAyCrE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IACvC,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;IAC5C,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,KAAK,MAAM,EAAE,CAgChB;AAuCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE;IACvC,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC;IAC5C,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,SAAS,CAAC,CAarB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC/C,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,mEAAmE;IACnE,MAAM,EAAE;QACN,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,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;CACH,GAAG,OAAO,CAAC,SAAS,CAAC,CAcrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE;IAC7C,iCAAiC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,2DAA2D;IAC3D,MAAM,EAAE;QACN,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,SAAS,CAAC,CAuBrB;AAMD;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE;IACzC,kEAAkE;IAClE,OAAO,EAAE,SAAS,CAAC,cAAc,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;IACxD,2CAA2C;IAC3C,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,gDAAgD;IAChD,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,sCAAsC;IACtC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iDAAiD;IACjD,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CA6ChD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAAC,IAAI,EAAE;IACjD,kEAAkE;IAClE,OAAO,EAAE,SAAS,CAAC,cAAc,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;IACxD,2CAA2C;IAC3C,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,gDAAgD;IAChD,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,0DAA0D;IAC1D,MAAM,EAAE;QACN,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,gCAAgC;IAChC,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC3D,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAmDhD;AAMD,4GAA4G;AAC5G,wBAAgB,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAMvD"}