@cubist-labs/cubesigner-sdk-ethers-v6 0.3.1

package/README.md

@@ -0,0 +1,8 @@
+# Ethers.js Signer implementation for CubeSigner TypeScript SDK
+
+This package provides a concrete implementation of the `AbstractSigner` abstract class
+from the `ethers` package that offloads all signing tasks to a remote CubeSigner service.
+
+For more information, check out the
+[@cubist-labs/cubesigner-sdk](https://www.npmjs.com/package/@cubist-labs/cubesigner-sdk)
+NPM package.

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import { TypedDataDomain, TypedDataField, ethers } from "ethers";
+import { KeyInfo, EvmSignRequest, MfaRequestInfo, SignerSession } from "@cubist-labs/cubesigner-sdk";
+/** Options for the signer */
+export interface SignerOptions {
+    /** Optional provider to use */
+    provider?: null | ethers.Provider;
+    /**
+     * The function to call when MFA information is retrieved. If this callback
+     * throws, no transaction is broadcast.
+     */
+    onMfaPoll?: (arg0: MfaRequestInfo) => void;
+    /**
+     * The amount of time (in milliseconds) to wait between checks for MFA
+     * updates. Default is 1000ms
+     */
+    mfaPollIntervalMs?: number;
+}
+/**
+ * A ethers.js Signer using CubeSigner
+ */
+export declare class Signer extends ethers.AbstractSigner {
+    #private;
+    /**
+     * Create new Signer instance
+     * @param {KeyInfo | string} address The key or the eth address of the account to use.
+     * @param {SignerSession} signerSession The underlying Signer session.
+     * @param {SignerOptions} options The options to use for the Signer instance
+     */
+    constructor(address: KeyInfo | string, signerSession: SignerSession, options?: SignerOptions);
+    /** Resolves to the signer address. */
+    getAddress(): Promise<string>;
+    /**
+     *  Returns the signer connected to %%provider%%.
+     *  @param {null | ethers.Provider} provider The optional provider instance to use.
+     *  @return {Signer} The signer connected to signer.
+     */
+    connect(provider: null | ethers.Provider): Signer;
+    /**
+     * Construct a signing request from a transaction. This populates the transaction
+     * type to `0x02` (EIP-1559) unless set.
+     *
+     * @param {ethers.TransactionRequest} tx The transaction
+     * @return {EvmSignRequest} The EVM sign request to be sent to CubeSigner
+     */
+    evmSignRequestFromTx(tx: ethers.TransactionRequest): Promise<EvmSignRequest>;
+    /**
+     * Sign a transaction. This method will block if the key requires MFA approval.
+     * @param {ethers.TransactionRequest} tx The transaction to sign.
+     * @return {Promise<string>} Hex-encoded RLP encoding of the transaction and its signature.
+     */
+    signTransaction(tx: ethers.TransactionRequest): Promise<string>;
+    /**
+     * Signs arbitrary messages. This uses CubeSigner's EIP-191 signing endpoint.
+     * The key (for this session) must have the `"AllowRawBlobSigning"` or
+     * `"AllowEip191Signing"` policy attached.
+     * @param {string | Uint8Array} message The message to sign.
+     * @return {Promise<string>} The signature.
+     */
+    signMessage(message: string | Uint8Array): Promise<string>;
+    /**
+     * Signs EIP-712 typed data. This uses CubeSigner's EIP-712 signing endpoint.
+     * The key (for this session) must have the `"AllowRawBlobSigning"` or
+     * `"AllowEip712Signing"` policy attached.
+     * @param {TypedDataDomain} domain The domain of the typed data.
+     * @param {Record<string, Array<TypedDataField>>} types The types of the typed data.
+     * @param {Record<string, any>} value The value of the typed data.
+     * @return {Promise<string>} The signature.
+     */
+    signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
+    /** @return {KeyInfo} The key corresponding to this address */
+    private key;
+    /**
+     * Initialize the signing a message using MFA approvals. This method populates
+     * missing fields. If the signing does not require MFA, this method throws.
+     * @param {ethers.TransactionRequest} tx The transaction to send.
+     * @return {string} The MFA id associated with the signing request.
+     */
+    sendTransactionMfaInit(tx: ethers.TransactionRequest): Promise<string>;
+    /**
+     * Send a transaction from an approved MFA request. The MFA request contains
+     * information about the approved signing request, which this method will
+     * execute.
+     * @param {MfaRequestInfo} mfaInfo The approved MFA request.
+     * @return {ethers.TransactionResponse} The result of submitting the transaction
+     */
+    sendTransactionMfaApproved(mfaInfo: MfaRequestInfo): Promise<ethers.TransactionResponse>;
+}

package/dist/index.js

@@ -0,0 +1,212 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Signer_instances, _Signer_address, _Signer_key, _Signer_signerSession, _Signer_onMfaPoll, _Signer_mfaPollIntervalMs, _Signer_handleMfa;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Signer = void 0;
+const ethers_1 = require("ethers");
+const cubesigner_sdk_1 = require("@cubist-labs/cubesigner-sdk");
+/**
+ * A ethers.js Signer using CubeSigner
+ */
+class Signer extends ethers_1.ethers.AbstractSigner {
+    /**
+     * Create new Signer instance
+     * @param {KeyInfo | string} address The key or the eth address of the account to use.
+     * @param {SignerSession} signerSession The underlying Signer session.
+     * @param {SignerOptions} options The options to use for the Signer instance
+     */
+    constructor(address, signerSession, options) {
+        super(options?.provider);
+        _Signer_instances.add(this);
+        /** The address of the account */
+        _Signer_address.set(this, void 0);
+        /** The key to use for signing */
+        _Signer_key.set(this, void 0);
+        /** The underlying session */
+        _Signer_signerSession.set(this, void 0);
+        /**
+         * The function to call when MFA information is retrieved. If this callback
+         * throws, no transaction is broadcast.
+         */
+        _Signer_onMfaPoll.set(this, void 0);
+        /** The amount of time to wait between checks for MFA updates */
+        _Signer_mfaPollIntervalMs.set(this, void 0);
+        if (typeof address === "string") {
+            __classPrivateFieldSet(this, _Signer_address, address, "f");
+        }
+        else {
+            __classPrivateFieldSet(this, _Signer_address, address.materialId, "f");
+            __classPrivateFieldSet(this, _Signer_key, address, "f");
+        }
+        __classPrivateFieldSet(this, _Signer_signerSession, signerSession, "f");
+        __classPrivateFieldSet(this, _Signer_onMfaPoll, options?.onMfaPoll ?? (( /* _mfaInfo: MfaRequestInfo */) => { }), "f"); // eslint-disable-line @typescript-eslint/no-empty-function
+        __classPrivateFieldSet(this, _Signer_mfaPollIntervalMs, options?.mfaPollIntervalMs ?? 1000, "f");
+    }
+    /** Resolves to the signer address. */
+    async getAddress() {
+        return __classPrivateFieldGet(this, _Signer_address, "f");
+    }
+    /**
+     *  Returns the signer connected to %%provider%%.
+     *  @param {null | ethers.Provider} provider The optional provider instance to use.
+     *  @return {Signer} The signer connected to signer.
+     */
+    connect(provider) {
+        return new Signer(__classPrivateFieldGet(this, _Signer_address, "f"), __classPrivateFieldGet(this, _Signer_signerSession, "f"), { provider });
+    }
+    /**
+     * Construct a signing request from a transaction. This populates the transaction
+     * type to `0x02` (EIP-1559) unless set.
+     *
+     * @param {ethers.TransactionRequest} tx The transaction
+     * @return {EvmSignRequest} The EVM sign request to be sent to CubeSigner
+     */
+    async evmSignRequestFromTx(tx) {
+        // get the chain id from the network or tx
+        let chainId = tx.chainId;
+        if (chainId === undefined) {
+            const network = await this.provider?.getNetwork();
+            chainId = network?.chainId?.toString() ?? "1";
+        }
+        // Convert the transaction into a JSON-RPC transaction
+        const rpcTx = this.provider instanceof ethers_1.JsonRpcApiProvider
+            ? this.provider.getRpcTransaction(tx)
+            : // We can just call the getRpcTransaction with a
+                // null receiver since it doesn't actually use it
+                // (and really should be declared static).
+                ethers_1.JsonRpcApiProvider.prototype.getRpcTransaction.call(null, tx);
+        rpcTx.type = (0, ethers_1.toBeHex)(tx.type ?? 0x02, 1); // we expect 0x0[0-2]
+        return {
+            chain_id: Number(chainId),
+            tx: rpcTx,
+        };
+    }
+    /**
+     * Sign a transaction. This method will block if the key requires MFA approval.
+     * @param {ethers.TransactionRequest} tx The transaction to sign.
+     * @return {Promise<string>} Hex-encoded RLP encoding of the transaction and its signature.
+     */
+    async signTransaction(tx) {
+        const req = await this.evmSignRequestFromTx(tx);
+        const res = await __classPrivateFieldGet(this, _Signer_signerSession, "f").signEvm(__classPrivateFieldGet(this, _Signer_address, "f"), req);
+        const data = await __classPrivateFieldGet(this, _Signer_instances, "m", _Signer_handleMfa).call(this, res);
+        return data.rlp_signed_tx;
+    }
+    /**
+     * Signs arbitrary messages. This uses CubeSigner's EIP-191 signing endpoint.
+     * The key (for this session) must have the `"AllowRawBlobSigning"` or
+     * `"AllowEip191Signing"` policy attached.
+     * @param {string | Uint8Array} message The message to sign.
+     * @return {Promise<string>} The signature.
+     */
+    async signMessage(message) {
+        const key = await this.key();
+        const res = await __classPrivateFieldGet(this, _Signer_signerSession, "f").signEip191(key.material_id, {
+            data: (0, cubesigner_sdk_1.encodeToHex)(message),
+        });
+        const data = await __classPrivateFieldGet(this, _Signer_instances, "m", _Signer_handleMfa).call(this, res);
+        return data.signature;
+    }
+    /**
+     * Signs EIP-712 typed data. This uses CubeSigner's EIP-712 signing endpoint.
+     * The key (for this session) must have the `"AllowRawBlobSigning"` or
+     * `"AllowEip712Signing"` policy attached.
+     * @param {TypedDataDomain} domain The domain of the typed data.
+     * @param {Record<string, Array<TypedDataField>>} types The types of the typed data.
+     * @param {Record<string, any>} value The value of the typed data.
+     * @return {Promise<string>} The signature.
+     */
+    async signTypedData(domain, types, value) {
+        const key = await this.key();
+        const res = await __classPrivateFieldGet(this, _Signer_signerSession, "f").signEip712(key.material_id, {
+            chain_id: 1,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            typed_data: {
+                domain,
+                types,
+                primaryType: ethers_1.TypedDataEncoder.getPrimaryType(types),
+                message: value,
+            },
+        });
+        const data = await __classPrivateFieldGet(this, _Signer_instances, "m", _Signer_handleMfa).call(this, res);
+        return data.signature;
+    }
+    /** @return {KeyInfo} The key corresponding to this address */
+    async key() {
+        if (__classPrivateFieldGet(this, _Signer_key, "f") === undefined) {
+            const key = (await __classPrivateFieldGet(this, _Signer_signerSession, "f").keys()).find((k) => k.material_id === __classPrivateFieldGet(this, _Signer_address, "f"));
+            if (key === undefined) {
+                throw new Error(`Cannot access key '${__classPrivateFieldGet(this, _Signer_address, "f")}'`);
+            }
+            __classPrivateFieldSet(this, _Signer_key, key, "f");
+        }
+        return __classPrivateFieldGet(this, _Signer_key, "f");
+    }
+    /**
+     * Initialize the signing a message using MFA approvals. This method populates
+     * missing fields. If the signing does not require MFA, this method throws.
+     * @param {ethers.TransactionRequest} tx The transaction to send.
+     * @return {string} The MFA id associated with the signing request.
+     */
+    async sendTransactionMfaInit(tx) {
+        const popTx = await this.populateTransaction(tx);
+        const req = await this.evmSignRequestFromTx(popTx);
+        const res = await __classPrivateFieldGet(this, _Signer_signerSession, "f").signEvm(__classPrivateFieldGet(this, _Signer_address, "f"), req);
+        return res.mfaId();
+    }
+    /**
+     * Send a transaction from an approved MFA request. The MFA request contains
+     * information about the approved signing request, which this method will
+     * execute.
+     * @param {MfaRequestInfo} mfaInfo The approved MFA request.
+     * @return {ethers.TransactionResponse} The result of submitting the transaction
+     */
+    async sendTransactionMfaApproved(mfaInfo) {
+        if (!mfaInfo.request.path.includes("/eth1/sign/")) {
+            throw new Error(`Expected EVM transaction signing request, got ${mfaInfo.request.path}`);
+        }
+        if (!mfaInfo.request.path.includes(__classPrivateFieldGet(this, _Signer_address, "f"))) {
+            throw new Error(`Expected signing request for ${__classPrivateFieldGet(this, _Signer_address, "f")} but got ${mfaInfo.request.path}`);
+        }
+        const signedTx = await __classPrivateFieldGet(this, _Signer_signerSession, "f").signEvm(__classPrivateFieldGet(this, _Signer_address, "f"), mfaInfo.request.body, {
+            mfaId: mfaInfo.id,
+            mfaOrgId: __classPrivateFieldGet(this, _Signer_signerSession, "f").orgId,
+            mfaConf: mfaInfo.receipt.confirmation,
+        });
+        return await this.provider.broadcastTransaction(signedTx.data().rlp_signed_tx);
+    }
+}
+exports.Signer = Signer;
+_Signer_address = new WeakMap(), _Signer_key = new WeakMap(), _Signer_signerSession = new WeakMap(), _Signer_onMfaPoll = new WeakMap(), _Signer_mfaPollIntervalMs = new WeakMap(), _Signer_instances = new WeakSet(), _Signer_handleMfa = 
+/**
+ * If the sign request requires MFA, this method waits for approvals
+ * @param {CubeSignerResponse<U>} res The response of a sign request
+ * @return {Promise<U>} The sign data after MFA approvals
+ */
+async function _Signer_handleMfa(res) {
+    while (res.requiresMfa()) {
+        await new Promise((resolve) => setTimeout(resolve, __classPrivateFieldGet(this, _Signer_mfaPollIntervalMs, "f")));
+        const mfaId = res.mfaId();
+        const mfaInfo = await __classPrivateFieldGet(this, _Signer_signerSession, "f").getMfaInfo(mfaId);
+        __classPrivateFieldGet(this, _Signer_onMfaPoll, "f").call(this, mfaInfo);
+        if (mfaInfo.receipt) {
+            res = await res.signWithMfaApproval({
+                mfaId,
+                mfaOrgId: __classPrivateFieldGet(this, _Signer_signerSession, "f").orgId,
+                mfaConf: mfaInfo.receipt.confirmation,
+            });
+        }
+    }
+    return res.data();
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,mCAOgB;AAChB,gEASqC;AAkBrC;;GAEG;AACH,MAAa,MAAO,SAAQ,eAAM,CAAC,cAAc;IAmB/C;;;;;OAKG;IACH,YAAY,OAAyB,EAAE,aAA4B,EAAE,OAAuB;QAC1F,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;;QAzB3B,iCAAiC;QACxB,kCAAiB;QAE1B,iCAAiC;QACjC,8BAAe;QAEf,6BAA6B;QACpB,wCAA8B;QAEvC;;;WAGG;QACM,oCAA2C;QAEpD,gEAAgE;QACvD,4CAA2B;QAUlC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,uBAAA,IAAI,mBAAY,OAAO,MAAA,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,uBAAA,IAAI,mBAAY,OAAO,CAAC,UAAU,MAAA,CAAC;YACnC,uBAAA,IAAI,eAAQ,OAAkB,MAAA,CAAC;QACjC,CAAC;QACD,uBAAA,IAAI,yBAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,qBAAc,OAAO,EAAE,SAAS,IAAI,CAAC,EAAC,8BAA8B,EAAE,EAAE,GAAE,CAAC,CAAC,MAAA,CAAC,CAAC,2DAA2D;QAC7I,uBAAA,IAAI,6BAAsB,OAAO,EAAE,iBAAiB,IAAI,IAAI,MAAA,CAAC;IAC/D,CAAC;IAED,sCAAsC;IACtC,KAAK,CAAC,UAAU;QACd,OAAO,uBAAA,IAAI,uBAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgC;QACtC,OAAO,IAAI,MAAM,CAAC,uBAAA,IAAI,uBAAS,EAAE,uBAAA,IAAI,6BAAe,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CAAC,EAA6B;QACtD,0CAA0C;QAC1C,IAAI,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;QACzB,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC;YAClD,OAAO,GAAG,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC;QAChD,CAAC;QAED,sDAAsD;QACtD,MAAM,KAAK,GACT,IAAI,CAAC,QAAQ,YAAY,2BAAkB;YACzC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACrC,CAAC,CAAC,gDAAgD;gBAChD,iDAAiD;gBACjD,0CAA0C;gBAC1C,2BAAkB,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpE,KAAK,CAAC,IAAI,GAAG,IAAA,gBAAO,EAAC,EAAE,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB;QAE/D,OAAuB;YACrB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;YACzB,EAAE,EAAE,KAAK;SACV,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,EAA6B;QACjD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,OAAO,CAAC,uBAAA,IAAI,uBAAS,EAAE,GAAG,CAAC,CAAC;QAClE,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,4CAAW,MAAf,IAAI,EAAY,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAA4B;QAC5C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAqB;YACnF,IAAI,EAAE,IAAA,4BAAW,EAAC,OAAO,CAAC;SAC3B,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,4CAAW,MAAf,IAAI,EAAY,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CACjB,MAAuB,EACvB,KAA4C,EAC5C,KAA0B;QAE1B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAqB;YACnF,QAAQ,EAAE,CAAC;YACX,8DAA8D;YAC9D,UAAU,EAAO;gBACf,MAAM;gBACN,KAAK;gBACL,WAAW,EAAE,yBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC;gBACnD,OAAO,EAAE,KAAK;aACf;SACF,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,4CAAW,MAAf,IAAI,EAAY,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,8DAA8D;IACtD,KAAK,CAAC,GAAG;QACf,IAAI,uBAAA,IAAI,mBAAK,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,CAAC,MAAM,uBAAA,IAAI,6BAAe,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,uBAAA,IAAI,uBAAS,CAAC,CAAC;YAC5F,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,sBAAsB,uBAAA,IAAI,uBAAS,GAAG,CAAC,CAAC;YAC1D,CAAC;YACD,uBAAA,IAAI,eAAQ,GAAG,MAAA,CAAC;QAClB,CAAC;QACD,OAAO,uBAAA,IAAI,mBAAK,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAAC,EAA6B;QACxD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,OAAO,CAAC,uBAAA,IAAI,uBAAS,EAAE,GAAG,CAAC,CAAC;QAClE,OAAO,GAAG,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,0BAA0B,CAAC,OAAuB;QACtD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,iDAAiD,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAA,IAAI,uBAAS,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,gCAAgC,uBAAA,IAAI,uBAAS,YAAY,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAChF,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,OAAO,CAChD,uBAAA,IAAI,uBAAS,EACb,OAAO,CAAC,OAAO,CAAC,IAAsB,EACtC;YACE,KAAK,EAAE,OAAO,CAAC,EAAE;YACjB,QAAQ,EAAE,uBAAA,IAAI,6BAAe,CAAC,KAAK;YACnC,OAAO,EAAE,OAAO,CAAC,OAAQ,CAAC,YAAY;SACvC,CACF,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,QAAS,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;IAClF,CAAC;CAwBF;AAxND,wBAwNC;;AAtBC;;;;GAIG;AACH,KAAK,4BAAe,GAA0B;IAC5C,OAAO,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAA,IAAI,iCAAmB,CAAC,CAAC,CAAC;QAE7E,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,6BAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC5D,uBAAA,IAAI,yBAAW,MAAf,IAAI,EAAY,OAAO,CAAC,CAAC;QACzB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,GAAG,GAAG,MAAM,GAAG,CAAC,mBAAmB,CAAC;gBAClC,KAAK;gBACL,QAAQ,EAAE,uBAAA,IAAI,6BAAe,CAAC,KAAK;gBACnC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY;aACtC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;AACpB,CAAC","sourcesContent":["import {\n  JsonRpcApiProvider,\n  TypedDataDomain,\n  TypedDataField,\n  TypedDataEncoder,\n  ethers,\n  toBeHex,\n} from \"ethers\";\nimport {\n  CubeSignerResponse,\n  KeyInfo,\n  Eip191SignRequest,\n  Eip712SignRequest,\n  EvmSignRequest,\n  MfaRequestInfo,\n  SignerSession,\n  encodeToHex,\n} from \"@cubist-labs/cubesigner-sdk\";\n\n/** Options for the signer */\nexport interface SignerOptions {\n  /** Optional provider to use */\n  provider?: null | ethers.Provider;\n  /**\n   * The function to call when MFA information is retrieved. If this callback\n   * throws, no transaction is broadcast.\n   */\n  onMfaPoll?: (arg0: MfaRequestInfo) => void;\n  /**\n   * The amount of time (in milliseconds) to wait between checks for MFA\n   * updates. Default is 1000ms\n   */\n  mfaPollIntervalMs?: number;\n}\n\n/**\n * A ethers.js Signer using CubeSigner\n */\nexport class Signer extends ethers.AbstractSigner {\n  /** The address of the account */\n  readonly #address: string;\n\n  /** The key to use for signing */\n  #key?: KeyInfo;\n\n  /** The underlying session */\n  readonly #signerSession: SignerSession;\n\n  /**\n   * The function to call when MFA information is retrieved. If this callback\n   * throws, no transaction is broadcast.\n   */\n  readonly #onMfaPoll: (arg0: MfaRequestInfo) => void;\n\n  /** The amount of time to wait between checks for MFA updates */\n  readonly #mfaPollIntervalMs: number;\n\n  /**\n   * Create new Signer instance\n   * @param {KeyInfo | string} address The key or the eth address of the account to use.\n   * @param {SignerSession} signerSession The underlying Signer session.\n   * @param {SignerOptions} options The options to use for the Signer instance\n   */\n  constructor(address: KeyInfo | string, signerSession: SignerSession, options?: SignerOptions) {\n    super(options?.provider);\n    if (typeof address === \"string\") {\n      this.#address = address;\n    } else {\n      this.#address = address.materialId;\n      this.#key = address as KeyInfo;\n    }\n    this.#signerSession = signerSession;\n    this.#onMfaPoll = options?.onMfaPoll ?? ((/* _mfaInfo: MfaRequestInfo */) => {}); // eslint-disable-line @typescript-eslint/no-empty-function\n    this.#mfaPollIntervalMs = options?.mfaPollIntervalMs ?? 1000;\n  }\n\n  /** Resolves to the signer address. */\n  async getAddress(): Promise<string> {\n    return this.#address;\n  }\n\n  /**\n   *  Returns the signer connected to %%provider%%.\n   *  @param {null | ethers.Provider} provider The optional provider instance to use.\n   *  @return {Signer} The signer connected to signer.\n   */\n  connect(provider: null | ethers.Provider): Signer {\n    return new Signer(this.#address, this.#signerSession, { provider });\n  }\n\n  /**\n   * Construct a signing request from a transaction. This populates the transaction\n   * type to `0x02` (EIP-1559) unless set.\n   *\n   * @param {ethers.TransactionRequest} tx The transaction\n   * @return {EvmSignRequest} The EVM sign request to be sent to CubeSigner\n   */\n  async evmSignRequestFromTx(tx: ethers.TransactionRequest): Promise<EvmSignRequest> {\n    // get the chain id from the network or tx\n    let chainId = tx.chainId;\n    if (chainId === undefined) {\n      const network = await this.provider?.getNetwork();\n      chainId = network?.chainId?.toString() ?? \"1\";\n    }\n\n    // Convert the transaction into a JSON-RPC transaction\n    const rpcTx =\n      this.provider instanceof JsonRpcApiProvider\n        ? this.provider.getRpcTransaction(tx)\n        : // We can just call the getRpcTransaction with a\n          // null receiver since it doesn't actually use it\n          // (and really should be declared static).\n          JsonRpcApiProvider.prototype.getRpcTransaction.call(null, tx);\n    rpcTx.type = toBeHex(tx.type ?? 0x02, 1); // we expect 0x0[0-2]\n\n    return <EvmSignRequest>{\n      chain_id: Number(chainId),\n      tx: rpcTx,\n    };\n  }\n\n  /**\n   * Sign a transaction. This method will block if the key requires MFA approval.\n   * @param {ethers.TransactionRequest} tx The transaction to sign.\n   * @return {Promise<string>} Hex-encoded RLP encoding of the transaction and its signature.\n   */\n  async signTransaction(tx: ethers.TransactionRequest): Promise<string> {\n    const req = await this.evmSignRequestFromTx(tx);\n    const res = await this.#signerSession.signEvm(this.#address, req);\n    const data = await this.#handleMfa(res);\n    return data.rlp_signed_tx;\n  }\n\n  /**\n   * Signs arbitrary messages. This uses CubeSigner's EIP-191 signing endpoint.\n   * The key (for this session) must have the `\"AllowRawBlobSigning\"` or\n   * `\"AllowEip191Signing\"` policy attached.\n   * @param {string | Uint8Array} message The message to sign.\n   * @return {Promise<string>} The signature.\n   */\n  async signMessage(message: string | Uint8Array): Promise<string> {\n    const key = await this.key();\n    const res = await this.#signerSession.signEip191(key.material_id, <Eip191SignRequest>{\n      data: encodeToHex(message),\n    });\n    const data = await this.#handleMfa(res);\n    return data.signature;\n  }\n\n  /**\n   * Signs EIP-712 typed data. This uses CubeSigner's EIP-712 signing endpoint.\n   * The key (for this session) must have the `\"AllowRawBlobSigning\"` or\n   * `\"AllowEip712Signing\"` policy attached.\n   * @param {TypedDataDomain} domain The domain of the typed data.\n   * @param {Record<string, Array<TypedDataField>>} types The types of the typed data.\n   * @param {Record<string, any>} value The value of the typed data.\n   * @return {Promise<string>} The signature.\n   */\n  async signTypedData(\n    domain: TypedDataDomain,\n    types: Record<string, Array<TypedDataField>>,\n    value: Record<string, any>, // eslint-disable-line @typescript-eslint/no-explicit-any\n  ): Promise<string> {\n    const key = await this.key();\n    const res = await this.#signerSession.signEip712(key.material_id, <Eip712SignRequest>{\n      chain_id: 1,\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      typed_data: <any>{\n        domain,\n        types,\n        primaryType: TypedDataEncoder.getPrimaryType(types),\n        message: value,\n      },\n    });\n    const data = await this.#handleMfa(res);\n    return data.signature;\n  }\n\n  /** @return {KeyInfo} The key corresponding to this address */\n  private async key(): Promise<KeyInfo> {\n    if (this.#key === undefined) {\n      const key = (await this.#signerSession.keys()).find((k) => k.material_id === this.#address);\n      if (key === undefined) {\n        throw new Error(`Cannot access key '${this.#address}'`);\n      }\n      this.#key = key;\n    }\n    return this.#key;\n  }\n\n  /**\n   * Initialize the signing a message using MFA approvals. This method populates\n   * missing fields. If the signing does not require MFA, this method throws.\n   * @param {ethers.TransactionRequest} tx The transaction to send.\n   * @return {string} The MFA id associated with the signing request.\n   */\n  async sendTransactionMfaInit(tx: ethers.TransactionRequest): Promise<string> {\n    const popTx = await this.populateTransaction(tx);\n    const req = await this.evmSignRequestFromTx(popTx);\n    const res = await this.#signerSession.signEvm(this.#address, req);\n    return res.mfaId();\n  }\n\n  /**\n   * Send a transaction from an approved MFA request. The MFA request contains\n   * information about the approved signing request, which this method will\n   * execute.\n   * @param {MfaRequestInfo} mfaInfo The approved MFA request.\n   * @return {ethers.TransactionResponse} The result of submitting the transaction\n   */\n  async sendTransactionMfaApproved(mfaInfo: MfaRequestInfo): Promise<ethers.TransactionResponse> {\n    if (!mfaInfo.request.path.includes(\"/eth1/sign/\")) {\n      throw new Error(`Expected EVM transaction signing request, got ${mfaInfo.request.path}`);\n    }\n    if (!mfaInfo.request.path.includes(this.#address)) {\n      throw new Error(\n        `Expected signing request for ${this.#address} but got ${mfaInfo.request.path}`,\n      );\n    }\n\n    const signedTx = await this.#signerSession.signEvm(\n      this.#address,\n      mfaInfo.request.body as EvmSignRequest,\n      {\n        mfaId: mfaInfo.id,\n        mfaOrgId: this.#signerSession.orgId,\n        mfaConf: mfaInfo.receipt!.confirmation,\n      },\n    );\n    return await this.provider!.broadcastTransaction(signedTx.data().rlp_signed_tx);\n  }\n\n  /**\n   * If the sign request requires MFA, this method waits for approvals\n   * @param {CubeSignerResponse<U>} res The response of a sign request\n   * @return {Promise<U>} The sign data after MFA approvals\n   */\n  async #handleMfa<U>(res: CubeSignerResponse<U>): Promise<U> {\n    while (res.requiresMfa()) {\n      await new Promise((resolve) => setTimeout(resolve, this.#mfaPollIntervalMs));\n\n      const mfaId = res.mfaId();\n      const mfaInfo = await this.#signerSession.getMfaInfo(mfaId);\n      this.#onMfaPoll(mfaInfo);\n      if (mfaInfo.receipt) {\n        res = await res.signWithMfaApproval({\n          mfaId,\n          mfaOrgId: this.#signerSession.orgId,\n          mfaConf: mfaInfo.receipt.confirmation,\n        });\n      }\n    }\n    return res.data();\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@cubist-labs/cubesigner-sdk-ethers-v6",
+  "version": "0.3.1",
+  "description": "Ethers.js Signer implementation",
+  "license": "MIT OR Apache-2.0",
+  "author": "Cubist, Inc.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "tsconfig.json",
+    "src/**",
+    "dist/**",
+    "../../NOTICE",
+    "../../LICENSE-APACHE",
+    "../../LICENSE-MIT"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepack": "tsc",
+    "test": "jest --maxWorkers=1"
+  },
+  "peerDependencies": {
+    "@cubist-labs/cubesigner-sdk": "^0.3.1"
+  },
+  "dependencies": {
+    "ethers": "6.7.1"
+  },
+  "directories": {
+    "test": "test"
+  }
+}

package/src/index.ts

@@ -0,0 +1,255 @@
+import {
+  JsonRpcApiProvider,
+  TypedDataDomain,
+  TypedDataField,
+  TypedDataEncoder,
+  ethers,
+  toBeHex,
+} from "ethers";
+import {
+  CubeSignerResponse,
+  KeyInfo,
+  Eip191SignRequest,
+  Eip712SignRequest,
+  EvmSignRequest,
+  MfaRequestInfo,
+  SignerSession,
+  encodeToHex,
+} from "@cubist-labs/cubesigner-sdk";
+
+/** Options for the signer */
+export interface SignerOptions {
+  /** Optional provider to use */
+  provider?: null | ethers.Provider;
+  /**
+   * The function to call when MFA information is retrieved. If this callback
+   * throws, no transaction is broadcast.
+   */
+  onMfaPoll?: (arg0: MfaRequestInfo) => void;
+  /**
+   * The amount of time (in milliseconds) to wait between checks for MFA
+   * updates. Default is 1000ms
+   */
+  mfaPollIntervalMs?: number;
+}
+
+/**
+ * A ethers.js Signer using CubeSigner
+ */
+export class Signer extends ethers.AbstractSigner {
+  /** The address of the account */
+  readonly #address: string;
+
+  /** The key to use for signing */
+  #key?: KeyInfo;
+
+  /** The underlying session */
+  readonly #signerSession: SignerSession;
+
+  /**
+   * The function to call when MFA information is retrieved. If this callback
+   * throws, no transaction is broadcast.
+   */
+  readonly #onMfaPoll: (arg0: MfaRequestInfo) => void;
+
+  /** The amount of time to wait between checks for MFA updates */
+  readonly #mfaPollIntervalMs: number;
+
+  /**
+   * Create new Signer instance
+   * @param {KeyInfo | string} address The key or the eth address of the account to use.
+   * @param {SignerSession} signerSession The underlying Signer session.
+   * @param {SignerOptions} options The options to use for the Signer instance
+   */
+  constructor(address: KeyInfo | string, signerSession: SignerSession, options?: SignerOptions) {
+    super(options?.provider);
+    if (typeof address === "string") {
+      this.#address = address;
+    } else {
+      this.#address = address.materialId;
+      this.#key = address as KeyInfo;
+    }
+    this.#signerSession = signerSession;
+    this.#onMfaPoll = options?.onMfaPoll ?? ((/* _mfaInfo: MfaRequestInfo */) => {}); // eslint-disable-line @typescript-eslint/no-empty-function
+    this.#mfaPollIntervalMs = options?.mfaPollIntervalMs ?? 1000;
+  }
+
+  /** Resolves to the signer address. */
+  async getAddress(): Promise<string> {
+    return this.#address;
+  }
+
+  /**
+   *  Returns the signer connected to %%provider%%.
+   *  @param {null | ethers.Provider} provider The optional provider instance to use.
+   *  @return {Signer} The signer connected to signer.
+   */
+  connect(provider: null | ethers.Provider): Signer {
+    return new Signer(this.#address, this.#signerSession, { provider });
+  }
+
+  /**
+   * Construct a signing request from a transaction. This populates the transaction
+   * type to `0x02` (EIP-1559) unless set.
+   *
+   * @param {ethers.TransactionRequest} tx The transaction
+   * @return {EvmSignRequest} The EVM sign request to be sent to CubeSigner
+   */
+  async evmSignRequestFromTx(tx: ethers.TransactionRequest): Promise<EvmSignRequest> {
+    // get the chain id from the network or tx
+    let chainId = tx.chainId;
+    if (chainId === undefined) {
+      const network = await this.provider?.getNetwork();
+      chainId = network?.chainId?.toString() ?? "1";
+    }
+
+    // Convert the transaction into a JSON-RPC transaction
+    const rpcTx =
+      this.provider instanceof JsonRpcApiProvider
+        ? this.provider.getRpcTransaction(tx)
+        : // We can just call the getRpcTransaction with a
+          // null receiver since it doesn't actually use it
+          // (and really should be declared static).
+          JsonRpcApiProvider.prototype.getRpcTransaction.call(null, tx);
+    rpcTx.type = toBeHex(tx.type ?? 0x02, 1); // we expect 0x0[0-2]
+
+    return <EvmSignRequest>{
+      chain_id: Number(chainId),
+      tx: rpcTx,
+    };
+  }
+
+  /**
+   * Sign a transaction. This method will block if the key requires MFA approval.
+   * @param {ethers.TransactionRequest} tx The transaction to sign.
+   * @return {Promise<string>} Hex-encoded RLP encoding of the transaction and its signature.
+   */
+  async signTransaction(tx: ethers.TransactionRequest): Promise<string> {
+    const req = await this.evmSignRequestFromTx(tx);
+    const res = await this.#signerSession.signEvm(this.#address, req);
+    const data = await this.#handleMfa(res);
+    return data.rlp_signed_tx;
+  }
+
+  /**
+   * Signs arbitrary messages. This uses CubeSigner's EIP-191 signing endpoint.
+   * The key (for this session) must have the `"AllowRawBlobSigning"` or
+   * `"AllowEip191Signing"` policy attached.
+   * @param {string | Uint8Array} message The message to sign.
+   * @return {Promise<string>} The signature.
+   */
+  async signMessage(message: string | Uint8Array): Promise<string> {
+    const key = await this.key();
+    const res = await this.#signerSession.signEip191(key.material_id, <Eip191SignRequest>{
+      data: encodeToHex(message),
+    });
+    const data = await this.#handleMfa(res);
+    return data.signature;
+  }
+
+  /**
+   * Signs EIP-712 typed data. This uses CubeSigner's EIP-712 signing endpoint.
+   * The key (for this session) must have the `"AllowRawBlobSigning"` or
+   * `"AllowEip712Signing"` policy attached.
+   * @param {TypedDataDomain} domain The domain of the typed data.
+   * @param {Record<string, Array<TypedDataField>>} types The types of the typed data.
+   * @param {Record<string, any>} value The value of the typed data.
+   * @return {Promise<string>} The signature.
+   */
+  async signTypedData(
+    domain: TypedDataDomain,
+    types: Record<string, Array<TypedDataField>>,
+    value: Record<string, any>, // eslint-disable-line @typescript-eslint/no-explicit-any
+  ): Promise<string> {
+    const key = await this.key();
+    const res = await this.#signerSession.signEip712(key.material_id, <Eip712SignRequest>{
+      chain_id: 1,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      typed_data: <any>{
+        domain,
+        types,
+        primaryType: TypedDataEncoder.getPrimaryType(types),
+        message: value,
+      },
+    });
+    const data = await this.#handleMfa(res);
+    return data.signature;
+  }
+
+  /** @return {KeyInfo} The key corresponding to this address */
+  private async key(): Promise<KeyInfo> {
+    if (this.#key === undefined) {
+      const key = (await this.#signerSession.keys()).find((k) => k.material_id === this.#address);
+      if (key === undefined) {
+        throw new Error(`Cannot access key '${this.#address}'`);
+      }
+      this.#key = key;
+    }
+    return this.#key;
+  }
+
+  /**
+   * Initialize the signing a message using MFA approvals. This method populates
+   * missing fields. If the signing does not require MFA, this method throws.
+   * @param {ethers.TransactionRequest} tx The transaction to send.
+   * @return {string} The MFA id associated with the signing request.
+   */
+  async sendTransactionMfaInit(tx: ethers.TransactionRequest): Promise<string> {
+    const popTx = await this.populateTransaction(tx);
+    const req = await this.evmSignRequestFromTx(popTx);
+    const res = await this.#signerSession.signEvm(this.#address, req);
+    return res.mfaId();
+  }
+
+  /**
+   * Send a transaction from an approved MFA request. The MFA request contains
+   * information about the approved signing request, which this method will
+   * execute.
+   * @param {MfaRequestInfo} mfaInfo The approved MFA request.
+   * @return {ethers.TransactionResponse} The result of submitting the transaction
+   */
+  async sendTransactionMfaApproved(mfaInfo: MfaRequestInfo): Promise<ethers.TransactionResponse> {
+    if (!mfaInfo.request.path.includes("/eth1/sign/")) {
+      throw new Error(`Expected EVM transaction signing request, got ${mfaInfo.request.path}`);
+    }
+    if (!mfaInfo.request.path.includes(this.#address)) {
+      throw new Error(
+        `Expected signing request for ${this.#address} but got ${mfaInfo.request.path}`,
+      );
+    }
+
+    const signedTx = await this.#signerSession.signEvm(
+      this.#address,
+      mfaInfo.request.body as EvmSignRequest,
+      {
+        mfaId: mfaInfo.id,
+        mfaOrgId: this.#signerSession.orgId,
+        mfaConf: mfaInfo.receipt!.confirmation,
+      },
+    );
+    return await this.provider!.broadcastTransaction(signedTx.data().rlp_signed_tx);
+  }
+
+  /**
+   * If the sign request requires MFA, this method waits for approvals
+   * @param {CubeSignerResponse<U>} res The response of a sign request
+   * @return {Promise<U>} The sign data after MFA approvals
+   */
+  async #handleMfa<U>(res: CubeSignerResponse<U>): Promise<U> {
+    while (res.requiresMfa()) {
+      await new Promise((resolve) => setTimeout(resolve, this.#mfaPollIntervalMs));
+
+      const mfaId = res.mfaId();
+      const mfaInfo = await this.#signerSession.getMfaInfo(mfaId);
+      this.#onMfaPoll(mfaInfo);
+      if (mfaInfo.receipt) {
+        res = await res.signWithMfaApproval({
+          mfaId,
+          mfaOrgId: this.#signerSession.orgId,
+          mfaConf: mfaInfo.receipt.confirmation,
+        });
+      }
+    }
+    return res.data();
+  }
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "Node16",
+    "moduleResolution": "node16",
+    "outDir": "./dist"
+  },
+  "typedocOptions": {
+    "out": "./docs",
+    "entryPoints": ["src/index.ts"]
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.ts"]
+}