@metamask/keyring-sdk 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.2.0]
+
+### Added
+
+- Add `EthKeyringV1Adapter` and typed errors for adapting v2 ETH keyrings to legacy ETH keyring signing flows ([#555](https://github.com/MetaMask/accounts/pull/555))
+
+### Changed
+
+- Bump `@metamask/keyring-api` from `^23.1.0` to `^23.2.0` ([#562](https://github.com/MetaMask/accounts/pull/562))
+
+## [2.1.1]
+
+### Changed
+
+- Bump `@metamask/keyring-utils` from `^3.3.0` to `^3.3.1` ([#546](https://github.com/MetaMask/accounts/pull/546))
+
 ## [2.1.0]
 
 ### Added
@@ -70,9 +86,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial release, extracted from `@metamask/keyring-api` ([#478](https://github.com/MetaMask/accounts/pull/478)), ([#482](https://github.com/MetaMask/accounts/pull/482))
+- Initial release, extracted from `@metamask/keyring-api` ([#478](https://github.com/MetaMask/accounts/pull/478), [#482](https://github.com/MetaMask/accounts/pull/482))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.2.0...HEAD
+[2.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.1.1...@metamask/keyring-sdk@2.2.0
+[2.1.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.1.0...@metamask/keyring-sdk@2.1.1
 [2.1.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.0.2...@metamask/keyring-sdk@2.1.0
 [2.0.2]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.0.1...@metamask/keyring-sdk@2.0.2
 [2.0.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-sdk@2.0.0...@metamask/keyring-sdk@2.0.1

package/dist/eth/eth-4337-keyring.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=eth-4337-keyring.cjs.map

package/dist/eth/eth-4337-keyring.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-4337-keyring.cjs","sourceRoot":"","sources":["../../src/eth/eth-4337-keyring.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  EthBaseTransaction,\n  EthBaseUserOperation,\n  EthUserOperation,\n  EthUserOperationPatch,\n  KeyringExecutionContext,\n} from '@metamask/keyring-api';\n\n/**\n * Legacy ETH keyring methods for ERC-4337 accounts.\n */\nexport type Eth4337Keyring = {\n  /**\n   * Convert base transactions to a base UserOperation.\n   *\n   * @param address - Address of the account to prepare the user operation for.\n   * @param transactions - Base transactions to include in the UserOperation.\n   * @param context - Keyring execution context.\n   * @returns A pseudo-UserOperation that can be used to construct a real one.\n   */\n  prepareUserOperation?(\n    address: string,\n    transactions: EthBaseTransaction[],\n    context: KeyringExecutionContext,\n  ): Promise<EthBaseUserOperation>;\n\n  /**\n   * Patches properties of a UserOperation. Currently, only the\n   * `paymasterAndData` can be patched.\n   *\n   * @param address - Address of the account to patch the user operation for.\n   * @param userOperation - UserOperation to patch.\n   * @param context - Keyring execution context.\n   * @returns A patch to apply to the UserOperation.\n   */\n  patchUserOperation?(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<EthUserOperationPatch>;\n\n  /**\n   * Signs a UserOperation.\n   *\n   * @param address - Address of the account to sign the user operation for.\n   * @param userOperation - UserOperation to sign.\n   * @param context - Keyring execution context.\n   * @returns A promise that resolves to the signature.\n   */\n  signUserOperation?(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<string>;\n};\n"]}

package/dist/eth/eth-4337-keyring.d.cts

@@ -0,0 +1,35 @@
+import type { EthBaseTransaction, EthBaseUserOperation, EthUserOperation, EthUserOperationPatch, KeyringExecutionContext } from "@metamask/keyring-api";
+/**
+ * Legacy ETH keyring methods for ERC-4337 accounts.
+ */
+export type Eth4337Keyring = {
+    /**
+     * Convert base transactions to a base UserOperation.
+     *
+     * @param address - Address of the account to prepare the user operation for.
+     * @param transactions - Base transactions to include in the UserOperation.
+     * @param context - Keyring execution context.
+     * @returns A pseudo-UserOperation that can be used to construct a real one.
+     */
+    prepareUserOperation?(address: string, transactions: EthBaseTransaction[], context: KeyringExecutionContext): Promise<EthBaseUserOperation>;
+    /**
+     * Patches properties of a UserOperation. Currently, only the
+     * `paymasterAndData` can be patched.
+     *
+     * @param address - Address of the account to patch the user operation for.
+     * @param userOperation - UserOperation to patch.
+     * @param context - Keyring execution context.
+     * @returns A patch to apply to the UserOperation.
+     */
+    patchUserOperation?(address: string, userOperation: EthUserOperation, context: KeyringExecutionContext): Promise<EthUserOperationPatch>;
+    /**
+     * Signs a UserOperation.
+     *
+     * @param address - Address of the account to sign the user operation for.
+     * @param userOperation - UserOperation to sign.
+     * @param context - Keyring execution context.
+     * @returns A promise that resolves to the signature.
+     */
+    signUserOperation?(address: string, userOperation: EthUserOperation, context: KeyringExecutionContext): Promise<string>;
+};
+//# sourceMappingURL=eth-4337-keyring.d.cts.map

package/dist/eth/eth-4337-keyring.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-4337-keyring.d.cts","sourceRoot":"","sources":["../../src/eth/eth-4337-keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACxB,8BAA8B;AAE/B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;OAOG;IACH,oBAAoB,CAAC,CACnB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,kBAAkB,EAAE,EAClC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,CACjB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,gBAAgB,EAC/B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAChB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,gBAAgB,EAC/B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB,CAAC"}

package/dist/eth/eth-4337-keyring.d.mts

@@ -0,0 +1,35 @@
+import type { EthBaseTransaction, EthBaseUserOperation, EthUserOperation, EthUserOperationPatch, KeyringExecutionContext } from "@metamask/keyring-api";
+/**
+ * Legacy ETH keyring methods for ERC-4337 accounts.
+ */
+export type Eth4337Keyring = {
+    /**
+     * Convert base transactions to a base UserOperation.
+     *
+     * @param address - Address of the account to prepare the user operation for.
+     * @param transactions - Base transactions to include in the UserOperation.
+     * @param context - Keyring execution context.
+     * @returns A pseudo-UserOperation that can be used to construct a real one.
+     */
+    prepareUserOperation?(address: string, transactions: EthBaseTransaction[], context: KeyringExecutionContext): Promise<EthBaseUserOperation>;
+    /**
+     * Patches properties of a UserOperation. Currently, only the
+     * `paymasterAndData` can be patched.
+     *
+     * @param address - Address of the account to patch the user operation for.
+     * @param userOperation - UserOperation to patch.
+     * @param context - Keyring execution context.
+     * @returns A patch to apply to the UserOperation.
+     */
+    patchUserOperation?(address: string, userOperation: EthUserOperation, context: KeyringExecutionContext): Promise<EthUserOperationPatch>;
+    /**
+     * Signs a UserOperation.
+     *
+     * @param address - Address of the account to sign the user operation for.
+     * @param userOperation - UserOperation to sign.
+     * @param context - Keyring execution context.
+     * @returns A promise that resolves to the signature.
+     */
+    signUserOperation?(address: string, userOperation: EthUserOperation, context: KeyringExecutionContext): Promise<string>;
+};
+//# sourceMappingURL=eth-4337-keyring.d.mts.map

package/dist/eth/eth-4337-keyring.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-4337-keyring.d.mts","sourceRoot":"","sources":["../../src/eth/eth-4337-keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACxB,8BAA8B;AAE/B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;OAOG;IACH,oBAAoB,CAAC,CACnB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,kBAAkB,EAAE,EAClC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,CACjB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,gBAAgB,EAC/B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAChB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,gBAAgB,EAC/B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB,CAAC"}

package/dist/eth/eth-4337-keyring.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=eth-4337-keyring.mjs.map

package/dist/eth/eth-4337-keyring.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-4337-keyring.mjs","sourceRoot":"","sources":["../../src/eth/eth-4337-keyring.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  EthBaseTransaction,\n  EthBaseUserOperation,\n  EthUserOperation,\n  EthUserOperationPatch,\n  KeyringExecutionContext,\n} from '@metamask/keyring-api';\n\n/**\n * Legacy ETH keyring methods for ERC-4337 accounts.\n */\nexport type Eth4337Keyring = {\n  /**\n   * Convert base transactions to a base UserOperation.\n   *\n   * @param address - Address of the account to prepare the user operation for.\n   * @param transactions - Base transactions to include in the UserOperation.\n   * @param context - Keyring execution context.\n   * @returns A pseudo-UserOperation that can be used to construct a real one.\n   */\n  prepareUserOperation?(\n    address: string,\n    transactions: EthBaseTransaction[],\n    context: KeyringExecutionContext,\n  ): Promise<EthBaseUserOperation>;\n\n  /**\n   * Patches properties of a UserOperation. Currently, only the\n   * `paymasterAndData` can be patched.\n   *\n   * @param address - Address of the account to patch the user operation for.\n   * @param userOperation - UserOperation to patch.\n   * @param context - Keyring execution context.\n   * @returns A patch to apply to the UserOperation.\n   */\n  patchUserOperation?(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<EthUserOperationPatch>;\n\n  /**\n   * Signs a UserOperation.\n   *\n   * @param address - Address of the account to sign the user operation for.\n   * @param userOperation - UserOperation to sign.\n   * @param context - Keyring execution context.\n   * @returns A promise that resolves to the signature.\n   */\n  signUserOperation?(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<string>;\n};\n"]}

package/dist/eth/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAA6B","sourcesContent":["export * from './account-id';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAA6B","sourcesContent":["export * from './account-id';\nexport type * from './eth-4337-keyring';\n"]}

package/dist/eth/index.d.cts

@@ -1,2 +1,3 @@
 export * from "./account-id.cjs";
+export type * from "./eth-4337-keyring.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/eth/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B;AAC7B,4CAAwC"}

package/dist/eth/index.d.mts

@@ -1,2 +1,3 @@
 export * from "./account-id.mjs";
+export type * from "./eth-4337-keyring.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/eth/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B;AAC7B,4CAAwC"}

package/dist/eth/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B","sourcesContent":["export * from './account-id';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":"AAAA,iCAA6B","sourcesContent":["export * from './account-id';\nexport type * from './eth-4337-keyring';\n"]}

package/dist/v2/eth/eth-keyring-v1-adapter.cjs

@@ -0,0 +1,320 @@
+"use strict";
+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 _EthKeyringV1Adapter_instances, _EthKeyringV1Adapter_getAccount, _EthKeyringV1Adapter_getAccountForMethod, _EthKeyringV1Adapter_getSignTypedDataMethod, _EthKeyringV1Adapter_submitRequest;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EthKeyringV1Adapter = exports.EthKeyringV1MethodNotSupportedError = exports.EthKeyringV1AccountNotFoundError = void 0;
+const tx_1 = require("@ethereumjs/tx");
+const eth_sig_util_1 = require("@metamask/eth-sig-util");
+const keyring_api_1 = require("@metamask/keyring-api");
+const v2_1 = require("@metamask/keyring-api/v2");
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const uuid_1 = require("uuid");
+const keyring_v1_adapter_1 = require("../keyring-v1-adapter.cjs");
+const eth_keyring_wrapper_1 = require("./eth-keyring-wrapper.cjs");
+const METAMASK_ORIGIN = 'metamask';
+/**
+ * Convert a value to a valid JSON object.
+ *
+ * The function chains JSON.stringify and JSON.parse to ensure that the result
+ * is a valid JSON object.
+ *
+ * We assume that the input value is JSON-serializable.
+ *
+ * However, some transformations can occur like: in objects, undefined values
+ * are removed, and in arrays, they are replaced with null.
+ *
+ * @param value - Value to convert to JSON - Assumed to be JSON-serializable.
+ * @returns JSON representation of the value.
+ */
+function toJson(value) {
+    return JSON.parse(JSON.stringify(value));
+}
+/**
+ * Convert a chain ID (number or hex) to an EIP-155 CAIP chain ID string for keyring request scoping.
+ *
+ * @param chainId - The chain ID to convert.
+ * @returns The EIP-155 CAIP chain ID string.
+ */
+function toEip155Scope(chainId) {
+    return (0, utils_1.toCaipChainId)(utils_1.KnownCaipNamespace.Eip155, BigInt(chainId).toString());
+}
+/**
+ * Error thrown when an account cannot be resolved from the requested address.
+ */
+class EthKeyringV1AccountNotFoundError extends Error {
+    constructor(address) {
+        super(`Account not found for address: ${address}`);
+        this.name = 'EthKeyringV1AccountNotFoundError';
+        this.address = address;
+        Object.setPrototypeOf(this, EthKeyringV1AccountNotFoundError.prototype);
+    }
+}
+exports.EthKeyringV1AccountNotFoundError = EthKeyringV1AccountNotFoundError;
+/**
+ * Error thrown when a resolved account does not support a requested method.
+ */
+class EthKeyringV1MethodNotSupportedError extends Error {
+    constructor(method, address) {
+        super(`Account ${address} does not support method: ${method}`);
+        this.name = 'EthKeyringV1MethodNotSupportedError';
+        this.address = address;
+        this.method = method;
+        Object.setPrototypeOf(this, EthKeyringV1MethodNotSupportedError.prototype);
+    }
+}
+exports.EthKeyringV1MethodNotSupportedError = EthKeyringV1MethodNotSupportedError;
+/**
+ * Adapts a `KeyringV2` instance to the subset of the legacy ETH keyring API
+ * used by existing ETH export and signing flows.
+ *
+ * The adapter is account-agnostic: each method resolves the requested address
+ * against the wrapped v2 keyring's accounts, verifies that the resolved account
+ * supports the requested method, then forwards the request through the v2
+ * `submitRequest` or `exportAccount` APIs.
+ */
+class EthKeyringV1Adapter extends keyring_v1_adapter_1.KeyringV1Adapter {
+    constructor() {
+        super(...arguments);
+        _EthKeyringV1Adapter_instances.add(this);
+    }
+    /**
+     * Gets the private data associated with the given address so
+     * that it may be exported.
+     *
+     * Used by the UI to export an account.
+     *
+     * @param address - Address of the account to export.
+     * @returns A promise that resolves to the exported private key.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     */
+    async exportAccount(address) {
+        const { account } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccount).call(this, address);
+        if (!this.inner.exportAccount) {
+            throw new Error('Keyring does not support exportAccount');
+        }
+        const exportedAccount = await this.inner.exportAccount(account.id, {
+            type: v2_1.AccountExportType.PrivateKey,
+            encoding: v2_1.PrivateKeyEncoding.Hexadecimal,
+        });
+        return (0, utils_1.remove0x)(exportedAccount.privateKey);
+    }
+    /**
+     * Sign a transaction.
+     *
+     * @param address - Sender's address.
+     * @param transaction - Transaction.
+     * @returns A promise that resolves to the signed transaction.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support transaction signing.
+     */
+    async signTransaction(address, transaction) {
+        const { account, normalizedAddress } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.SignTransaction);
+        const chainId = transaction.common.chainId();
+        const tx = toJson({
+            ...transaction.toJSON(),
+            from: normalizedAddress,
+            type: `0x${transaction.type.toString(16)}`,
+            chainId: (0, utils_1.bigIntToHex)(chainId),
+        });
+        const signedTx = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.SignTransaction, toJson([tx]), toEip155Scope(chainId));
+        // Only take the signature fields from the keyring response. This prevents
+        // the keyring from overwriting the transaction payload we submitted.
+        const signature = (0, superstruct_1.mask)(signedTx, (0, superstruct_1.object)({
+            r: keyring_api_1.EthBytesStrictStruct,
+            s: keyring_api_1.EthBytesStrictStruct,
+            v: keyring_api_1.EthBytesStrictStruct,
+        }));
+        return tx_1.TransactionFactory.fromTxData({
+            ...tx,
+            r: signature.r,
+            s: signature.s,
+            v: signature.v,
+        });
+    }
+    /**
+     * Sign a message.
+     *
+     * @param address - Signer's address.
+     * @param data - Data to sign.
+     * @returns A promise that resolves to the signature.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support message signing.
+     */
+    async signMessage(address, data) {
+        const { account, normalizedAddress } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.Sign);
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.Sign, toJson([normalizedAddress, data]), ''), keyring_api_1.EthBytesStruct);
+    }
+    /**
+     * Sign an EIP-7702 authorization.
+     *
+     * @param address - Signer's address.
+     * @param authorization - Authorization tuple to sign.
+     * @returns A promise that resolves to the signature.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support EIP-7702 authorization signing.
+     */
+    async signEip7702Authorization(address, authorization) {
+        const { account } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, eth_keyring_wrapper_1.EthKeyringMethod.SignEip7702Authorization);
+        const [chainId] = authorization;
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, eth_keyring_wrapper_1.EthKeyringMethod.SignEip7702Authorization, [authorization], toEip155Scope(chainId)), keyring_api_1.EthBytesStruct);
+    }
+    /**
+     * Sign a personal message.
+     *
+     * Note: KeyringController says this should return a Buffer but it actually
+     * expects a string.
+     *
+     * @param address - Signer's address.
+     * @param message - Data to sign.
+     * @returns A promise that resolves to the signature.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support personal message signing.
+     */
+    async signPersonalMessage(address, message) {
+        const { account, normalizedAddress } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.PersonalSign);
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.PersonalSign, toJson([message, normalizedAddress]), ''), keyring_api_1.EthBytesStruct);
+    }
+    /**
+     * Sign a typed data message.
+     *
+     * @param address - Signer's address.
+     * @param typedData - Typed data to sign.
+     * @param options - Signing options.
+     * @param options.version - The typed data version to use.
+     * @returns A promise that resolves to the signature.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support the requested typed data signing method.
+     */
+    async signTypedData(address, typedData, options) {
+        const version = options?.version;
+        const method = __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getSignTypedDataMethod).call(this, version);
+        const { account, normalizedAddress } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, method);
+        // Extract chain ID as if it was a typed message (as defined by EIP-712), if
+        // input is not a typed message, then chain ID will be undefined!
+        const chainId = typedData.domain?.chainId;
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, method, toJson([normalizedAddress, typedData]), chainId === undefined ? '' : toEip155Scope(chainId)), keyring_api_1.EthBytesStruct);
+    }
+    /**
+     * Convert base transactions to a base UserOperation.
+     *
+     * @param address - Address of the sender.
+     * @param transactions - Base transactions to include in the UserOperation.
+     * @param context - Keyring execution context.
+     * @returns A pseudo-UserOperation that can be used to construct a real one.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support UserOperation preparation.
+     */
+    async prepareUserOperation(address, transactions, context) {
+        const { account } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.PrepareUserOperation);
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.PrepareUserOperation, 
+        // NOTE: This is inconsistent with the other methods. We are not wrapping `transactions` in an array.
+        // Which means the receiver of the `submitRequest` call would see individual transactions spread as
+        // separate params rather than a single transactions array as the first param, which doesn't match
+        // the method signature of `prepareUserOperation(address, transactions, context)`.
+        // This was already implemented like this in the legacy Snap keyring, so we keep the same logic here
+        // too!
+        toJson(transactions), toEip155Scope(context.chainId)), keyring_api_1.EthBaseUserOperationStruct);
+    }
+    /**
+     * Patches properties of a UserOperation. Currently, only the
+     * `paymasterAndData` can be patched.
+     *
+     * @param address - Address of the sender.
+     * @param userOperation - UserOperation to patch.
+     * @param context - Keyring execution context.
+     * @returns A patch to apply to the UserOperation.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support UserOperation patching.
+     */
+    async patchUserOperation(address, userOperation, context) {
+        const { account } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.PatchUserOperation);
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.PatchUserOperation, toJson([userOperation]), toEip155Scope(context.chainId)), keyring_api_1.EthUserOperationPatchStruct);
+    }
+    /**
+     * Signs a UserOperation.
+     *
+     * @param address - Address of the sender.
+     * @param userOperation - UserOperation to sign.
+     * @param context - Keyring execution context.
+     * @returns The signature of the UserOperation.
+     * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the
+     * address.
+     * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does
+     * not support UserOperation signing.
+     */
+    async signUserOperation(address, userOperation, context) {
+        const { account } = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccountForMethod).call(this, address, keyring_api_1.EthMethod.SignUserOperation);
+        return (0, keyring_utils_1.strictMask)(await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_submitRequest).call(this, account, keyring_api_1.EthMethod.SignUserOperation, toJson([userOperation]), toEip155Scope(context.chainId)), keyring_api_1.EthBytesStruct);
+    }
+}
+exports.EthKeyringV1Adapter = EthKeyringV1Adapter;
+_EthKeyringV1Adapter_instances = new WeakSet(), _EthKeyringV1Adapter_getAccount = async function _EthKeyringV1Adapter_getAccount(address) {
+    const normalizedAddress = (0, eth_sig_util_1.normalize)(address);
+    const normalizedAddressLowerCase = normalizedAddress?.toLowerCase();
+    if (!normalizedAddress || !normalizedAddressLowerCase) {
+        throw new EthKeyringV1AccountNotFoundError(address);
+    }
+    const accounts = await this.inner.getAccounts();
+    const account = accounts.find((keyringAccount) => {
+        const accountAddress = (0, eth_sig_util_1.normalize)(keyringAccount.address);
+        return accountAddress?.toLowerCase() === normalizedAddressLowerCase;
+    });
+    if (!account) {
+        throw new EthKeyringV1AccountNotFoundError(address);
+    }
+    return {
+        account,
+        normalizedAddress: normalizedAddress,
+    };
+}, _EthKeyringV1Adapter_getAccountForMethod = async function _EthKeyringV1Adapter_getAccountForMethod(address, method) {
+    const resolvedAccount = await __classPrivateFieldGet(this, _EthKeyringV1Adapter_instances, "m", _EthKeyringV1Adapter_getAccount).call(this, address);
+    if (!resolvedAccount.account.methods.includes(method)) {
+        throw new EthKeyringV1MethodNotSupportedError(method, address);
+    }
+    return resolvedAccount;
+}, _EthKeyringV1Adapter_getSignTypedDataMethod = function _EthKeyringV1Adapter_getSignTypedDataMethod(version) {
+    switch (version) {
+        case 'V3':
+            return keyring_api_1.EthMethod.SignTypedDataV3;
+        case 'V4':
+            return keyring_api_1.EthMethod.SignTypedDataV4;
+        case 'V1':
+        default:
+            // Use 'V1' by default to match other keyring implementations. V1 will be
+            // used if the version is not specified or not supported.
+            return keyring_api_1.EthMethod.SignTypedDataV1;
+    }
+}, _EthKeyringV1Adapter_submitRequest = async function _EthKeyringV1Adapter_submitRequest(account, method, params, scope) {
+    return (await this.inner.submitRequest({
+        id: (0, uuid_1.v4)(),
+        origin: METAMASK_ORIGIN,
+        scope,
+        account: account.id,
+        request: {
+            method,
+            params,
+        },
+    }));
+};
+//# sourceMappingURL=eth-keyring-v1-adapter.cjs.map

package/dist/v2/eth/eth-keyring-v1-adapter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-keyring-v1-adapter.cjs","sourceRoot":"","sources":["../../../src/v2/eth/eth-keyring-v1-adapter.ts"],"names":[],"mappings":";;;;;;;;;AACA,uCAAoD;AAEpD,yDAAmE;AACnE,uDAM+B;AAW/B,iDAGkC;AAElC,2DAAqD;AACrD,uDAAqD;AAErD,2CAKyB;AACzB,+BAAkC;AAGlC,kEAAyD;AACzD,mEAAyD;AAEzD,MAAM,eAAe,GAAG,UAAU,CAAC;AAenC;;;;;;;;;;;;;GAaG;AACH,SAAS,MAAM,CAA2B,KAAc;IACtD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAS,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,OAAiC;IACtD,OAAO,IAAA,qBAAa,EAAC,0BAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC9E,CAAC;AAkBD;;GAEG;AACH,MAAa,gCAAiC,SAAQ,KAAK;IAGzD,YAAY,OAAe;QACzB,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,kCAAkC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,gCAAgC,CAAC,SAAS,CAAC,CAAC;IAC1E,CAAC;CACF;AATD,4EASC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,KAAK;IAK5D,YAAY,MAAc,EAAE,OAAe;QACzC,KAAK,CAAC,WAAW,OAAO,6BAA6B,MAAM,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,GAAG,qCAAqC,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mCAAmC,CAAC,SAAS,CAAC,CAAC;IAC7E,CAAC;CACF;AAZD,kFAYC;AAED;;;;;;;;GAQG;AACH,MAAa,mBACX,SAAQ,qCAA8B;IADxC;;;IAwYA,CAAC;IApYC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CAAC,OAAY;QAC9B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,uEAAY,MAAhB,IAAI,EAAa,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE;YACjE,IAAI,EAAE,sBAAiB,CAAC,UAAU;YAClC,QAAQ,EAAE,uBAAkB,CAAC,WAAW;SACzC,CAAC,CAAC;QAEH,OAAO,IAAA,gBAAQ,EAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACnB,OAAY,EACZ,WAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC/C,OAAO,EACP,uBAAS,CAAC,eAAe,CAC1B,CAAC;QAEF,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC7C,MAAM,EAAE,GAAG,MAAM,CAAC;YAChB,GAAG,WAAW,CAAC,MAAM,EAAE;YACvB,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,KAAK,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YAC1C,OAAO,EAAE,IAAA,mBAAW,EAAC,OAAO,CAAC;SAC9B,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACzB,OAAO,EACP,uBAAS,CAAC,eAAe,EACzB,MAAM,CAAS,CAAC,EAAE,CAAC,CAAC,EACpB,aAAa,CAAC,OAAO,CAAC,CACvB,CAAC;QAEF,0EAA0E;QAC1E,qEAAqE;QACrE,MAAM,SAAS,GAAG,IAAA,kBAAI,EACpB,QAAQ,EACR,IAAA,oBAAM,EAAC;YACL,CAAC,EAAE,kCAAoB;YACvB,CAAC,EAAE,kCAAoB;YACvB,CAAC,EAAE,kCAAoB;SACxB,CAAC,CACH,CAAC;QAEF,OAAO,uBAAkB,CAAC,UAAU,CAAC;YACnC,GAAI,EAA2B;YAC/B,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,CAAC,EAAE,SAAS,CAAC,CAAC;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,WAAW,CAAC,OAAY,EAAE,IAAY;QAC1C,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC/C,OAAO,EACP,uBAAS,CAAC,IAAI,CACf,CAAC;QAEF,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,uBAAS,CAAC,IAAI,EACd,MAAM,CAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,EACzC,EAAE,CACH,EACD,4BAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAY,EACZ,aAAqE;QAErE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC5B,OAAO,EACP,sCAAgB,CAAC,wBAAwB,CAC1C,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC;QAEhC,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,sCAAgB,CAAC,wBAAwB,EACzC,CAAC,aAAa,CAAC,EACf,aAAa,CAAC,OAAO,CAAC,CACvB,EACD,4BAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAY,EAAE,OAAY;QAClD,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC/C,OAAO,EACP,uBAAS,CAAC,YAAY,CACvB,CAAC;QAEF,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,uBAAS,CAAC,YAAY,EACtB,MAAM,CAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAC5C,EAAE,CACH,EACD,4BAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CACjB,OAAY,EACZ,SAA8C,EAC9C,OAAiC;QAEjC,MAAM,OAAO,GAAG,OAAO,EAAE,OAA2C,CAAC;QACrE,MAAM,MAAM,GAAG,uBAAA,IAAI,mFAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC;QACrD,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC/C,OAAO,EACP,MAAM,CACP,CAAC;QAEF,4EAA4E;QAC5E,iEAAiE;QACjE,MAAM,OAAO,GAAI,SAAiC,CAAC,MAAM,EAAE,OAAO,CAAC;QAEnE,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,MAAM,EACN,MAAM,CAAS,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,EAC9C,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CACpD,EACD,4BAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,YAAkC,EAClC,OAAgC;QAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC5B,OAAO,EACP,uBAAS,CAAC,oBAAoB,CAC/B,CAAC;QAEF,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,uBAAS,CAAC,oBAAoB;QAC9B,qGAAqG;QACrG,mGAAmG;QACnG,kGAAkG;QAClG,kFAAkF;QAClF,oGAAoG;QACpG,OAAO;QACP,MAAM,CAAS,YAAY,CAAC,EAC5B,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAC/B,EACD,wCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,aAA+B,EAC/B,OAAgC;QAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC5B,OAAO,EACP,uBAAS,CAAC,kBAAkB,CAC7B,CAAC;QAEF,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,uBAAS,CAAC,kBAAkB,EAC5B,MAAM,CAAS,CAAC,aAAa,CAAC,CAAC,EAC/B,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAC/B,EACD,yCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,aAA+B,EAC/B,OAAgC;QAEhC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,gFAAqB,MAAzB,IAAI,EAC5B,OAAO,EACP,uBAAS,CAAC,iBAAiB,CAC5B,CAAC;QAEF,OAAO,IAAA,0BAAU,EACf,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EACR,OAAO,EACP,uBAAS,CAAC,iBAAiB,EAC3B,MAAM,CAAS,CAAC,aAAa,CAAC,CAAC,EAC/B,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAC/B,EACD,4BAAc,CACf,CAAC;IACJ,CAAC;CAwEF;AAxYD,kDAwYC;kFAtEC,KAAK,0CAAa,OAAe;IAC/B,MAAM,iBAAiB,GAAG,IAAA,wBAAY,EAAC,OAAO,CAAC,CAAC;IAChD,MAAM,0BAA0B,GAAG,iBAAiB,EAAE,WAAW,EAAE,CAAC;IAEpE,IAAI,CAAC,iBAAiB,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACtD,MAAM,IAAI,gCAAgC,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;QAC/C,MAAM,cAAc,GAAG,IAAA,wBAAY,EAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC5D,OAAO,cAAc,EAAE,WAAW,EAAE,KAAK,0BAA0B,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,gCAAgC,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACL,OAAO;QACP,iBAAiB,EAAE,iBAAwB;KAC5C,CAAC;AACJ,CAAC,6CAED,KAAK,mDACH,OAAe,EACf,MAAc;IAEd,MAAM,eAAe,GAAG,MAAM,uBAAA,IAAI,uEAAY,MAAhB,IAAI,EAAa,OAAO,CAAC,CAAC;IAExD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,mCAAmC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC,qGAGC,OAAyC;IAEzC,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,IAAI;YACP,OAAO,uBAAS,CAAC,eAAe,CAAC;QACnC,KAAK,IAAI;YACP,OAAO,uBAAS,CAAC,eAAe,CAAC;QACnC,KAAK,IAAI,CAAC;QACV;YACE,yEAAyE;YACzE,yDAAyD;YACzD,OAAO,uBAAS,CAAC,eAAe,CAAC;IACrC,CAAC;AACH,CAAC,uCAED,KAAK,6CACH,OAAuB,EACvB,MAAc,EACd,MAAqB,EACrB,KAAa;IAEb,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;QACrC,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,MAAM,EAAE,eAAe;QACvB,KAAK;QACL,OAAO,EAAE,OAAO,CAAC,EAAE;QACnB,OAAO,EAAE;YACP,MAAM;YACN,MAAM;SACP;KACF,CAAC,CAAW,CAAC;AAChB,CAAC","sourcesContent":["import type { TypedTransaction } from '@ethereumjs/tx';\nimport { TransactionFactory } from '@ethereumjs/tx';\nimport type { SignTypedDataVersion } from '@metamask/eth-sig-util';\nimport { normalize as ethNormalize } from '@metamask/eth-sig-util';\nimport {\n  EthBaseUserOperationStruct,\n  EthBytesStrictStruct,\n  EthBytesStruct,\n  EthMethod,\n  EthUserOperationPatchStruct,\n} from '@metamask/keyring-api';\nimport type {\n  EthBaseTransaction,\n  EthBaseUserOperation,\n  EthUserOperation,\n  EthUserOperationPatch,\n  KeyringAccount,\n  KeyringExecutionContext,\n  KeyringRequest,\n} from '@metamask/keyring-api';\nimport type { Keyring as KeyringV2 } from '@metamask/keyring-api/v2';\nimport {\n  AccountExportType,\n  PrivateKeyEncoding,\n} from '@metamask/keyring-api/v2';\nimport type { BaseKeyring, EthKeyring } from '@metamask/keyring-utils';\nimport { strictMask } from '@metamask/keyring-utils';\nimport { mask, object } from '@metamask/superstruct';\nimport type { Hex, Json } from '@metamask/utils';\nimport {\n  bigIntToHex,\n  KnownCaipNamespace,\n  remove0x,\n  toCaipChainId,\n} from '@metamask/utils';\nimport { v4 as uuid } from 'uuid';\n\nimport type { Eth4337Keyring } from '../../eth';\nimport { KeyringV1Adapter } from '../keyring-v1-adapter';\nimport { EthKeyringMethod } from './eth-keyring-wrapper';\n\nconst METAMASK_ORIGIN = 'metamask';\n\ntype RequestParams = NonNullable<KeyringRequest['request']['params']>;\n\ntype ResolvedAccount = {\n  account: KeyringAccount;\n  normalizedAddress: Hex;\n};\n\ntype TypedDataWithDomain = {\n  domain?: {\n    chainId?: string | number;\n  };\n};\n\n/**\n * Convert a value to a valid JSON object.\n *\n * The function chains JSON.stringify and JSON.parse to ensure that the result\n * is a valid JSON object.\n *\n * We assume that the input value is JSON-serializable.\n *\n * However, some transformations can occur like: in objects, undefined values\n * are removed, and in arrays, they are replaced with null.\n *\n * @param value - Value to convert to JSON - Assumed to be JSON-serializable.\n * @returns JSON representation of the value.\n */\nfunction toJson<Type extends Json = Json>(value: unknown): Type {\n  return JSON.parse(JSON.stringify(value)) as Type;\n}\n\n/**\n * Convert a chain ID (number or hex) to an EIP-155 CAIP chain ID string for keyring request scoping.\n *\n * @param chainId - The chain ID to convert.\n * @returns The EIP-155 CAIP chain ID string.\n */\nfunction toEip155Scope(chainId: string | number | bigint): string {\n  return toCaipChainId(KnownCaipNamespace.Eip155, BigInt(chainId).toString());\n}\n\n/**\n * Legacy ETH keyring API surface exposed by {@link EthKeyringV1Adapter}.\n */\nexport type BaseEthKeyring = BaseKeyring &\n  // Only pick account-related methods (signing and exporting).\n  Pick<\n    EthKeyring,\n    | 'exportAccount'\n    | 'signMessage'\n    | 'signEip7702Authorization'\n    | 'signPersonalMessage'\n    | 'signTypedData'\n    | 'signTransaction'\n  > &\n  Eth4337Keyring;\n\n/**\n * Error thrown when an account cannot be resolved from the requested address.\n */\nexport class EthKeyringV1AccountNotFoundError extends Error {\n  readonly address: string;\n\n  constructor(address: string) {\n    super(`Account not found for address: ${address}`);\n    this.name = 'EthKeyringV1AccountNotFoundError';\n    this.address = address;\n    Object.setPrototypeOf(this, EthKeyringV1AccountNotFoundError.prototype);\n  }\n}\n\n/**\n * Error thrown when a resolved account does not support a requested method.\n */\nexport class EthKeyringV1MethodNotSupportedError extends Error {\n  readonly address: string;\n\n  readonly method: string;\n\n  constructor(method: string, address: string) {\n    super(`Account ${address} does not support method: ${method}`);\n    this.name = 'EthKeyringV1MethodNotSupportedError';\n    this.address = address;\n    this.method = method;\n    Object.setPrototypeOf(this, EthKeyringV1MethodNotSupportedError.prototype);\n  }\n}\n\n/**\n * Adapts a `KeyringV2` instance to the subset of the legacy ETH keyring API\n * used by existing ETH export and signing flows.\n *\n * The adapter is account-agnostic: each method resolves the requested address\n * against the wrapped v2 keyring's accounts, verifies that the resolved account\n * supports the requested method, then forwards the request through the v2\n * `submitRequest` or `exportAccount` APIs.\n */\nexport class EthKeyringV1Adapter<InnerKeyring extends KeyringV2 = KeyringV2>\n  extends KeyringV1Adapter<InnerKeyring>\n  implements BaseEthKeyring\n{\n  /**\n   * Gets the private data associated with the given address so\n   * that it may be exported.\n   *\n   * Used by the UI to export an account.\n   *\n   * @param address - Address of the account to export.\n   * @returns A promise that resolves to the exported private key.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   */\n  async exportAccount(address: Hex): Promise<string> {\n    const { account } = await this.#getAccount(address);\n\n    if (!this.inner.exportAccount) {\n      throw new Error('Keyring does not support exportAccount');\n    }\n\n    const exportedAccount = await this.inner.exportAccount(account.id, {\n      type: AccountExportType.PrivateKey,\n      encoding: PrivateKeyEncoding.Hexadecimal,\n    });\n\n    return remove0x(exportedAccount.privateKey);\n  }\n\n  /**\n   * Sign a transaction.\n   *\n   * @param address - Sender's address.\n   * @param transaction - Transaction.\n   * @returns A promise that resolves to the signed transaction.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support transaction signing.\n   */\n  async signTransaction(\n    address: Hex,\n    transaction: TypedTransaction,\n  ): Promise<TypedTransaction> {\n    const { account, normalizedAddress } = await this.#getAccountForMethod(\n      address,\n      EthMethod.SignTransaction,\n    );\n\n    const chainId = transaction.common.chainId();\n    const tx = toJson({\n      ...transaction.toJSON(),\n      from: normalizedAddress,\n      type: `0x${transaction.type.toString(16)}`,\n      chainId: bigIntToHex(chainId),\n    });\n\n    const signedTx = await this.#submitRequest(\n      account,\n      EthMethod.SignTransaction,\n      toJson<Json[]>([tx]),\n      toEip155Scope(chainId),\n    );\n\n    // Only take the signature fields from the keyring response. This prevents\n    // the keyring from overwriting the transaction payload we submitted.\n    const signature = mask(\n      signedTx,\n      object({\n        r: EthBytesStrictStruct,\n        s: EthBytesStrictStruct,\n        v: EthBytesStrictStruct,\n      }),\n    );\n\n    return TransactionFactory.fromTxData({\n      ...(tx as Record<string, Json>),\n      r: signature.r,\n      s: signature.s,\n      v: signature.v,\n    });\n  }\n\n  /**\n   * Sign a message.\n   *\n   * @param address - Signer's address.\n   * @param data - Data to sign.\n   * @returns A promise that resolves to the signature.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support message signing.\n   */\n  async signMessage(address: Hex, data: string): Promise<string> {\n    const { account, normalizedAddress } = await this.#getAccountForMethod(\n      address,\n      EthMethod.Sign,\n    );\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthMethod.Sign,\n        toJson<Json[]>([normalizedAddress, data]),\n        '',\n      ),\n      EthBytesStruct,\n    );\n  }\n\n  /**\n   * Sign an EIP-7702 authorization.\n   *\n   * @param address - Signer's address.\n   * @param authorization - Authorization tuple to sign.\n   * @returns A promise that resolves to the signature.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support EIP-7702 authorization signing.\n   */\n  async signEip7702Authorization(\n    address: Hex,\n    authorization: [chainId: number, contractAddress: Hex, nonce: number],\n  ): Promise<string> {\n    const { account } = await this.#getAccountForMethod(\n      address,\n      EthKeyringMethod.SignEip7702Authorization,\n    );\n\n    const [chainId] = authorization;\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthKeyringMethod.SignEip7702Authorization,\n        [authorization],\n        toEip155Scope(chainId),\n      ),\n      EthBytesStruct,\n    );\n  }\n\n  /**\n   * Sign a personal message.\n   *\n   * Note: KeyringController says this should return a Buffer but it actually\n   * expects a string.\n   *\n   * @param address - Signer's address.\n   * @param message - Data to sign.\n   * @returns A promise that resolves to the signature.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support personal message signing.\n   */\n  async signPersonalMessage(address: Hex, message: Hex): Promise<string> {\n    const { account, normalizedAddress } = await this.#getAccountForMethod(\n      address,\n      EthMethod.PersonalSign,\n    );\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthMethod.PersonalSign,\n        toJson<Json[]>([message, normalizedAddress]),\n        '',\n      ),\n      EthBytesStruct,\n    );\n  }\n\n  /**\n   * Sign a typed data message.\n   *\n   * @param address - Signer's address.\n   * @param typedData - Typed data to sign.\n   * @param options - Signing options.\n   * @param options.version - The typed data version to use.\n   * @returns A promise that resolves to the signature.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support the requested typed data signing method.\n   */\n  async signTypedData(\n    address: Hex,\n    typedData: unknown[] | Record<string, unknown>,\n    options?: Record<string, unknown>,\n  ): Promise<string> {\n    const version = options?.version as SignTypedDataVersion | undefined;\n    const method = this.#getSignTypedDataMethod(version);\n    const { account, normalizedAddress } = await this.#getAccountForMethod(\n      address,\n      method,\n    );\n\n    // Extract chain ID as if it was a typed message (as defined by EIP-712), if\n    // input is not a typed message, then chain ID will be undefined!\n    const chainId = (typedData as TypedDataWithDomain).domain?.chainId;\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        method,\n        toJson<Json[]>([normalizedAddress, typedData]),\n        chainId === undefined ? '' : toEip155Scope(chainId),\n      ),\n      EthBytesStruct,\n    );\n  }\n\n  /**\n   * Convert base transactions to a base UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param transactions - Base transactions to include in the UserOperation.\n   * @param context - Keyring execution context.\n   * @returns A pseudo-UserOperation that can be used to construct a real one.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support UserOperation preparation.\n   */\n  async prepareUserOperation(\n    address: string,\n    transactions: EthBaseTransaction[],\n    context: KeyringExecutionContext,\n  ): Promise<EthBaseUserOperation> {\n    const { account } = await this.#getAccountForMethod(\n      address,\n      EthMethod.PrepareUserOperation,\n    );\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthMethod.PrepareUserOperation,\n        // NOTE: This is inconsistent with the other methods. We are not wrapping `transactions` in an array.\n        // Which means the receiver of the `submitRequest` call would see individual transactions spread as\n        // separate params rather than a single transactions array as the first param, which doesn't match\n        // the method signature of `prepareUserOperation(address, transactions, context)`.\n        // This was already implemented like this in the legacy Snap keyring, so we keep the same logic here\n        // too!\n        toJson<Json[]>(transactions),\n        toEip155Scope(context.chainId),\n      ),\n      EthBaseUserOperationStruct,\n    );\n  }\n\n  /**\n   * Patches properties of a UserOperation. Currently, only the\n   * `paymasterAndData` can be patched.\n   *\n   * @param address - Address of the sender.\n   * @param userOperation - UserOperation to patch.\n   * @param context - Keyring execution context.\n   * @returns A patch to apply to the UserOperation.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support UserOperation patching.\n   */\n  async patchUserOperation(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<EthUserOperationPatch> {\n    const { account } = await this.#getAccountForMethod(\n      address,\n      EthMethod.PatchUserOperation,\n    );\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthMethod.PatchUserOperation,\n        toJson<Json[]>([userOperation]),\n        toEip155Scope(context.chainId),\n      ),\n      EthUserOperationPatchStruct,\n    );\n  }\n\n  /**\n   * Signs a UserOperation.\n   *\n   * @param address - Address of the sender.\n   * @param userOperation - UserOperation to sign.\n   * @param context - Keyring execution context.\n   * @returns The signature of the UserOperation.\n   * @throws {@link EthKeyringV1AccountNotFoundError} if no account matches the\n   * address.\n   * @throws {@link EthKeyringV1MethodNotSupportedError} if the account does\n   * not support UserOperation signing.\n   */\n  async signUserOperation(\n    address: string,\n    userOperation: EthUserOperation,\n    context: KeyringExecutionContext,\n  ): Promise<string> {\n    const { account } = await this.#getAccountForMethod(\n      address,\n      EthMethod.SignUserOperation,\n    );\n\n    return strictMask(\n      await this.#submitRequest(\n        account,\n        EthMethod.SignUserOperation,\n        toJson<Json[]>([userOperation]),\n        toEip155Scope(context.chainId),\n      ),\n      EthBytesStruct,\n    );\n  }\n\n  async #getAccount(address: string): Promise<ResolvedAccount> {\n    const normalizedAddress = ethNormalize(address);\n    const normalizedAddressLowerCase = normalizedAddress?.toLowerCase();\n\n    if (!normalizedAddress || !normalizedAddressLowerCase) {\n      throw new EthKeyringV1AccountNotFoundError(address);\n    }\n\n    const accounts = await this.inner.getAccounts();\n    const account = accounts.find((keyringAccount) => {\n      const accountAddress = ethNormalize(keyringAccount.address);\n      return accountAddress?.toLowerCase() === normalizedAddressLowerCase;\n    });\n\n    if (!account) {\n      throw new EthKeyringV1AccountNotFoundError(address);\n    }\n\n    return {\n      account,\n      normalizedAddress: normalizedAddress as Hex,\n    };\n  }\n\n  async #getAccountForMethod(\n    address: string,\n    method: string,\n  ): Promise<ResolvedAccount> {\n    const resolvedAccount = await this.#getAccount(address);\n\n    if (!resolvedAccount.account.methods.includes(method)) {\n      throw new EthKeyringV1MethodNotSupportedError(method, address);\n    }\n\n    return resolvedAccount;\n  }\n\n  #getSignTypedDataMethod(\n    version: SignTypedDataVersion | undefined,\n  ): EthMethod {\n    switch (version) {\n      case 'V3':\n        return EthMethod.SignTypedDataV3;\n      case 'V4':\n        return EthMethod.SignTypedDataV4;\n      case 'V1':\n      default:\n        // Use 'V1' by default to match other keyring implementations. V1 will be\n        // used if the version is not specified or not supported.\n        return EthMethod.SignTypedDataV1;\n    }\n  }\n\n  async #submitRequest<Result extends Json = Json>(\n    account: KeyringAccount,\n    method: string,\n    params: RequestParams,\n    scope: string,\n  ): Promise<Result> {\n    return (await this.inner.submitRequest({\n      id: uuid(),\n      origin: METAMASK_ORIGIN,\n      scope,\n      account: account.id,\n      request: {\n        method,\n        params,\n      },\n    })) as Result;\n  }\n}\n"]}