@nktkas/hyperliquid 0.25.0-beta.1 → 0.25.0-beta.3

package/src/src/clients/multiSign.ts

@@ -0,0 +1,183 @@
+import type { IRequestTransport } from "../transports/base.js";
+import type {
+    CancelSuccessResponse,
+    CreateSubAccountResponse,
+    CreateVaultResponse,
+    MultiSigRequest,
+    OrderSuccessResponse,
+    SuccessResponse,
+    TwapCancelSuccessResponse,
+    TwapOrderSuccessResponse,
+} from "../schemas/mod.js";
+import { ExchangeClient, type ExchangeClientParameters } from "./exchange.js";
+import {
+    type AbstractWallet,
+    getWalletAddress,
+    signL1Action,
+    signUserSignedAction,
+    userSignedActionEip712Types,
+} from "../signing/mod.js";
+
+/** Parameters for the {@linkcode MultiSignClient} constructor. */
+export interface MultiSignClientParameters<
+    T extends IRequestTransport = IRequestTransport,
+    S extends readonly AbstractWallet[] = AbstractWallet[],
+> extends Omit<ExchangeClientParameters<T, S[0]>, "wallet"> {
+    /** The multi-signature account address. */
+    multiSignAddress: `0x${string}`;
+    /** Array of wallets used for multi-signature operations. The first wallet acts as the leader. */
+    signers: S;
+}
+
+/**
+ * Multi-signature exchange client for interacting with the Hyperliquid API.
+ * @typeParam T The transport used to connect to the Hyperliquid API.
+ * @typeParam S Array of wallets where the first wallet acts as the leader.
+ */
+export class MultiSignClient<
+    T extends IRequestTransport = IRequestTransport,
+    S extends readonly AbstractWallet[] = AbstractWallet[],
+> extends ExchangeClient<T, S[0]> implements MultiSignClientParameters<T, S> {
+    multiSignAddress: `0x${string}`;
+    signers: S;
+
+    /**
+     * @multisign Is the first wallet from {@linkcode signers}. Changing the property also changes the first element in the {@linkcode signers} array.
+     */
+    declare wallet: S[0];
+
+    /**
+     * Initialises a new multi-signature client instance.
+     * @param args - The parameters for the multi-signature client.
+     *
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const multiSignAddress = "0x...";
+     * const signers = [
+     *   "0x...", // private key; or any other wallet libraries
+     * ] as const;
+     *
+     * const transport = new hl.HttpTransport();
+     * const multiSignClient = new hl.MultiSignClient({ transport, multiSignAddress, signers });
+     * ```
+     */
+    constructor(args: MultiSignClientParameters<T, S>) {
+        super({ ...args, wallet: args.signers[0] });
+        this.multiSignAddress = args.multiSignAddress;
+        this.signers = args.signers;
+
+        Object.defineProperty(this, "wallet", {
+            get() {
+                return this.signers[0];
+            },
+            set(value) {
+                this.signers[0] = value;
+            },
+            enumerable: true,
+            configurable: true,
+        });
+    }
+
+    protected override async _executeL1Action<
+        T extends
+            | SuccessResponse
+            | CancelSuccessResponse
+            | CreateSubAccountResponse
+            | CreateVaultResponse
+            | OrderSuccessResponse
+            | TwapOrderSuccessResponse
+            | TwapCancelSuccessResponse,
+    >(
+        request: {
+            action: Exclude<
+                MultiSigRequest["action"]["payload"]["action"],
+                { type: keyof typeof userSignedActionEip712Types }
+            >;
+            vaultAddress?: `0x${string}`;
+            expiresAfter: number | string | undefined;
+        },
+        signal?: AbortSignal,
+    ): Promise<T> {
+        const { action, vaultAddress, expiresAfter } = request;
+
+        // Sign an L1 action
+        const nonce = await this.nonceManager();
+        const outerSigner = await getWalletAddress(this.signers[0]);
+        const signatures = await Promise.all(this.signers.map(async (signer) => {
+            return await signL1Action({
+                wallet: signer,
+                action: [this.multiSignAddress.toLowerCase(), outerSigner.toLowerCase(), action],
+                nonce,
+                isTestnet: this.transport.isTestnet,
+                vaultAddress,
+                expiresAfter: typeof expiresAfter === "string" ? Number(expiresAfter) : expiresAfter,
+            });
+        }));
+
+        // Send a request via multi-sign action
+        return await super.multiSig(
+            {
+                signatures,
+                payload: {
+                    multiSigUser: this.multiSignAddress,
+                    outerSigner,
+                    action,
+                },
+                nonce,
+            },
+            { signal, vaultAddress, expiresAfter },
+        );
+    }
+
+    protected override async _executeUserSignedAction<
+        T extends
+            | SuccessResponse
+            | CancelSuccessResponse
+            | CreateSubAccountResponse
+            | CreateVaultResponse
+            | OrderSuccessResponse
+            | TwapOrderSuccessResponse
+            | TwapCancelSuccessResponse,
+    >(
+        request: {
+            action: Extract<
+                MultiSigRequest["action"]["payload"]["action"],
+                { type: keyof typeof userSignedActionEip712Types }
+            >;
+        },
+        signal?: AbortSignal,
+    ): Promise<T> {
+        const { action } = request;
+
+        // Sign a user-signed action
+        const nonce = "nonce" in action ? action.nonce : action.time;
+        const outerSigner = await getWalletAddress(this.signers[0]);
+        const signatures = await Promise.all(this.signers.map(async (signer) => {
+            return await signUserSignedAction({
+                wallet: signer,
+                action: {
+                    payloadMultiSigUser: this.multiSignAddress,
+                    outerSigner,
+                    ...action,
+                },
+                types: userSignedActionEip712Types[action.type],
+            });
+        }));
+
+        // Send a request via multi-sign action
+        return await super.multiSig(
+            {
+                signatures,
+                payload: {
+                    multiSigUser: this.multiSignAddress,
+                    outerSigner,
+                    action,
+                },
+                nonce,
+            },
+            { signal },
+        );
+    }
+}