@metamask-previews/eth-simple-keyring 11.0.0-855692d → 11.0.0-ca02a28

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `SimpleKeyringV2` class implementing `KeyringV2` interface ([#409](https://github.com/MetaMask/accounts/pull/409)), ([#410](https://github.com/MetaMask/accounts/pull/410)), ([#413](https://github.com/MetaMask/accounts/pull/413))
+  - Wraps legacy `SimpleKeyring` to expose accounts via the unified `KeyringV2` API and the `KeyringAccount` type.
+  - Extends `EthKeyringWrapper` for common Ethereum logic.
+
 ## [11.0.0]
 
 ### Changed

package/dist/simple-keyring-v2.cjs

@@ -0,0 +1,201 @@
+"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 _SimpleKeyringV2_instances, _SimpleKeyringV2_createKeyringAccount, _SimpleKeyringV2_getPrivateKeys, _SimpleKeyringV2_setPrivateKeys, _SimpleKeyringV2_withRollback, _SimpleKeyringV2_importPrivateKeyOrRollback;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleKeyringV2 = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const utils_1 = require("@metamask/utils");
+/**
+ * Methods supported by SimpleKeyring EOA accounts.
+ * SimpleKeyring supports all standard signing methods plus encryption and app keys.
+ */
+const SIMPLE_KEYRING_METHODS = [
+    keyring_api_1.EthMethod.SignTransaction,
+    keyring_api_1.EthMethod.Sign,
+    keyring_api_1.EthMethod.PersonalSign,
+    keyring_api_1.EthMethod.SignTypedDataV1,
+    keyring_api_1.EthMethod.SignTypedDataV3,
+    keyring_api_1.EthMethod.SignTypedDataV4,
+    keyring_api_1.EthKeyringMethod.Decrypt,
+    keyring_api_1.EthKeyringMethod.GetEncryptionPublicKey,
+    keyring_api_1.EthKeyringMethod.GetAppKeyAddress,
+    keyring_api_1.EthKeyringMethod.SignEip7702Authorization,
+];
+const simpleKeyringV2Capabilities = {
+    scopes: [keyring_api_1.EthScope.Eoa],
+    privateKey: {
+        importFormats: [
+            { encoding: keyring_api_1.PrivateKeyEncoding.Hexadecimal, type: keyring_api_1.EthAccountType.Eoa },
+        ],
+        exportFormats: [{ encoding: keyring_api_1.PrivateKeyEncoding.Hexadecimal }],
+    },
+};
+class SimpleKeyringV2 extends keyring_api_1.EthKeyringWrapper {
+    constructor(options) {
+        super({
+            type: keyring_api_1.KeyringType.PrivateKey,
+            inner: options.legacyKeyring,
+            capabilities: simpleKeyringV2Capabilities,
+        });
+        _SimpleKeyringV2_instances.add(this);
+    }
+    async getAccounts() {
+        const addresses = await this.inner.getAccounts();
+        return addresses.map((address) => {
+            // Check if we already have this account in the registry
+            const existingId = this.registry.getAccountId(address);
+            if (existingId) {
+                const cached = this.registry.get(existingId);
+                if (cached) {
+                    return cached;
+                }
+            }
+            // Create and register the account if not already cached
+            return __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_createKeyringAccount).call(this, address);
+        });
+    }
+    async createAccounts(options) {
+        return this.withLock(async () => {
+            // For SimpleKeyring, we only support private key import
+            if (options.type !== 'private-key:import') {
+                throw new Error(`Unsupported account creation type for SimpleKeyring: ${options.type}`);
+            }
+            // Validate account type
+            if (options.accountType !== keyring_api_1.EthAccountType.Eoa) {
+                throw new Error(`Unsupported account type for SimpleKeyring: ${options.accountType}. Only '${keyring_api_1.EthAccountType.Eoa}' is supported.`);
+            }
+            const { encoding, privateKey } = options;
+            // Validate encoding
+            if (encoding !== keyring_api_1.PrivateKeyEncoding.Hexadecimal) {
+                throw new Error(`Unsupported encoding for SimpleKeyring: ${encoding}. Only '${keyring_api_1.PrivateKeyEncoding.Hexadecimal}' is supported.`);
+            }
+            // Import the private key (with automatic rollback on failure)
+            const newAddress = await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_importPrivateKeyOrRollback).call(this, privateKey);
+            // Create and return the new KeyringAccount
+            const newAccount = __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_createKeyringAccount).call(this, newAddress);
+            return [newAccount];
+        });
+    }
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    async deleteAccount(accountId) {
+        await this.withLock(async () => {
+            const account = await this.getAccount(accountId);
+            // Remove from the legacy keyring
+            this.inner.removeAccount(account.address);
+            // Remove from the registry
+            this.registry.delete(accountId);
+        });
+    }
+    /**
+     * Export the private key for an account in hexadecimal format.
+     *
+     * @param accountId - The ID of the account to export.
+     * @param options - Export options (only hexadecimal encoding is supported).
+     * @returns The exported account with private key.
+     */
+    async exportAccount(accountId, options) {
+        const account = await this.getAccount(accountId);
+        const requestedEncoding = options?.encoding ?? keyring_api_1.PrivateKeyEncoding.Hexadecimal;
+        if (requestedEncoding !== keyring_api_1.PrivateKeyEncoding.Hexadecimal) {
+            throw new Error(`Unsupported encoding for SimpleKeyring: ${requestedEncoding}. Only '${keyring_api_1.PrivateKeyEncoding.Hexadecimal}' is supported.`);
+        }
+        const privateKeyHex = await this.inner.exportAccount(this.toHexAddress(account.address));
+        // Sanitize private key format
+        const privateKey = (0, utils_1.add0x)(privateKeyHex);
+        const exported = {
+            type: 'private-key',
+            privateKey,
+            encoding: keyring_api_1.PrivateKeyEncoding.Hexadecimal,
+        };
+        return exported;
+    }
+}
+exports.SimpleKeyringV2 = SimpleKeyringV2;
+_SimpleKeyringV2_instances = new WeakSet(), _SimpleKeyringV2_createKeyringAccount = function _SimpleKeyringV2_createKeyringAccount(address) {
+    const id = this.registry.register(address);
+    const account = {
+        id,
+        type: keyring_api_1.EthAccountType.Eoa,
+        address,
+        scopes: [...this.capabilities.scopes],
+        methods: [...SIMPLE_KEYRING_METHODS],
+        options: {
+            entropy: {
+                type: keyring_api_1.KeyringAccountEntropyTypeOption.PrivateKey,
+            },
+            exportable: true,
+        },
+    };
+    // Add the account to the registry
+    this.registry.set(account);
+    return account;
+}, _SimpleKeyringV2_getPrivateKeys = 
+/**
+ * Get all private keys from the inner SimpleKeyring.
+ *
+ * @returns An array of private keys in hexadecimal format.
+ */
+async function _SimpleKeyringV2_getPrivateKeys() {
+    return await this.inner.serialize();
+}, _SimpleKeyringV2_setPrivateKeys = 
+/**
+ * Set private keys in the inner SimpleKeyring.
+ *
+ * @param privateKeys - An array of private keys in hexadecimal format.
+ */
+async function _SimpleKeyringV2_setPrivateKeys(privateKeys) {
+    await this.inner.deserialize(privateKeys);
+}, _SimpleKeyringV2_withRollback = 
+/**
+ * Executes a transactional update on the inner keyring state.
+ * If the callback throws, the state is automatically rolled back.
+ *
+ * @param callback - A function that receives the current private keys and performs the update.
+ * Should return the result on success, or throw to trigger rollback.
+ * @returns The result of the callback.
+ * @throws Error if the callback throws (after rollback).
+ */
+async function _SimpleKeyringV2_withRollback(callback) {
+    const originalPrivateKeys = await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_getPrivateKeys).call(this);
+    try {
+        return await callback(originalPrivateKeys);
+    }
+    catch (error) {
+        // Rollback on error
+        await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_setPrivateKeys).call(this, originalPrivateKeys);
+        throw error;
+    }
+}, _SimpleKeyringV2_importPrivateKeyOrRollback = 
+/**
+ * Import a private key and return the new address.
+ * If the import fails (no new address added), rolls back to the original state.
+ *
+ * @param privateKey - The private key to import in hexadecimal format.
+ * @returns The address of the newly imported account.
+ * @throws Error if the import fails or no new address is added.
+ */
+async function _SimpleKeyringV2_importPrivateKeyOrRollback(privateKey) {
+    return __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_withRollback).call(this, async (currentPrivateKeys) => {
+        // Get current addresses before import
+        const addressesBefore = new Set(await this.inner.getAccounts());
+        // Import the new private key
+        await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_setPrivateKeys).call(this, [...currentPrivateKeys, privateKey]);
+        // Get addresses after import and find the newly added one
+        const addressesAfter = await this.inner.getAccounts();
+        // Find the new address by diffing the two sets
+        const newAddresses = addressesAfter.filter((addr) => !addressesBefore.has(addr));
+        if (newAddresses.length !== 1 || !newAddresses[0]) {
+            throw new Error('Failed to import private key');
+        }
+        return newAddresses[0];
+    });
+};
+//# sourceMappingURL=simple-keyring-v2.cjs.map

package/dist/simple-keyring-v2.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-keyring-v2.cjs","sourceRoot":"","sources":["../src/simple-keyring-v2.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uDAe+B;AAE/B,2CAAkD;AAKlD;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,uBAAS,CAAC,eAAe;IACzB,uBAAS,CAAC,IAAI;IACd,uBAAS,CAAC,YAAY;IACtB,uBAAS,CAAC,eAAe;IACzB,uBAAS,CAAC,eAAe;IACzB,uBAAS,CAAC,eAAe;IACzB,8BAAgB,CAAC,OAAO;IACxB,8BAAgB,CAAC,sBAAsB;IACvC,8BAAgB,CAAC,gBAAgB;IACjC,8BAAgB,CAAC,wBAAwB;CAC1C,CAAC;AAEF,MAAM,2BAA2B,GAAwB;IACvD,MAAM,EAAE,CAAC,sBAAQ,CAAC,GAAG,CAAC;IACtB,UAAU,EAAE;QACV,aAAa,EAAE;YACb,EAAE,QAAQ,EAAE,gCAAkB,CAAC,WAAW,EAAE,IAAI,EAAE,4BAAc,CAAC,GAAG,EAAE;SACvE;QACD,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,gCAAkB,CAAC,WAAW,EAAE,CAAC;KAC9D;CACF,CAAC;AAYF,MAAa,eACX,SAAQ,+BAAgC;IAGxC,YAAY,OAA+B;QACzC,KAAK,CAAC;YACJ,IAAI,EAAE,yBAAW,CAAC,UAAU;YAC5B,KAAK,EAAE,OAAO,CAAC,aAAa;YAC5B,YAAY,EAAE,2BAA2B;SAC1C,CAAC,CAAC;;IACL,CAAC;IAwGD,KAAK,CAAC,WAAW;QACf,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEjD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,wDAAwD;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC7C,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YAED,wDAAwD;YACxD,OAAO,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC9B,wDAAwD;YACxD,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,CAAC,IAAI,EAAE,CACvE,CAAC;YACJ,CAAC;YAED,wBAAwB;YACxB,IAAI,OAAO,CAAC,WAAW,KAAK,4BAAc,CAAC,GAAG,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CACb,+CAA+C,OAAO,CAAC,WAAW,WAAW,4BAAc,CAAC,GAAG,iBAAiB,CACjH,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;YAEzC,oBAAoB;YACpB,IAAI,QAAQ,KAAK,gCAAkB,CAAC,WAAW,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CACb,2CAA2C,QAAQ,WAAW,gCAAkB,CAAC,WAAW,iBAAiB,CAC9G,CAAC;YACJ,CAAC;YAED,8DAA8D;YAC9D,MAAM,UAAU,GAAG,MAAM,uBAAA,IAAI,+EAA4B,MAAhC,IAAI,EAA6B,UAAU,CAAC,CAAC;YAEtE,2CAA2C;YAC3C,MAAM,UAAU,GAAG,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,UAAU,CAAC,CAAC;YAC1D,OAAO,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,SAAoB;QACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEjD,iCAAiC;YACjC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAE1C,2BAA2B;YAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CACjB,SAAoB,EACpB,OAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,iBAAiB,GACrB,OAAO,EAAE,QAAQ,IAAI,gCAAkB,CAAC,WAAW,CAAC;QAEtD,IAAI,iBAAiB,KAAK,gCAAkB,CAAC,WAAW,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,2CAA2C,iBAAiB,WAAW,gCAAkB,CAAC,WAAW,iBAAiB,CACvH,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAClD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CACnC,CAAC;QACF,8BAA8B;QAC9B,MAAM,UAAU,GAAG,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAoB;YAChC,IAAI,EAAE,aAAa;YACnB,UAAU;YACV,QAAQ,EAAE,gCAAkB,CAAC,WAAW;SACzC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AA7ND,0CA6NC;mIA3MuB,OAAY;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE3C,MAAM,OAAO,GAAmB;QAC9B,EAAE;QACF,IAAI,EAAE,4BAAc,CAAC,GAAG;QACxB,OAAO;QACP,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE,CAAC,GAAG,sBAAsB,CAAC;QACpC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,IAAI,EAAE,6CAA+B,CAAC,UAAU;aACjD;YACD,UAAU,EAAE,IAAI;SACjB;KACF,CAAC;IAEF,kCAAkC;IAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,KAAK,0CAAiB,WAAqB;IACzC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,wCACH,QAA2D;IAE3D,MAAM,mBAAmB,GAAG,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,CAAkB,CAAC;IAEzD,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,oBAAoB;QACpB,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,EAAiB,mBAAmB,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,sDAA6B,UAAkB;IAClD,OAAO,uBAAA,IAAI,iEAAc,MAAlB,IAAI,EAAe,KAAK,EAAE,kBAAkB,EAAE,EAAE;QACrD,sCAAsC;QACtC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAEhE,6BAA6B;QAC7B,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,EAAiB,CAAC,GAAG,kBAAkB,EAAE,UAAU,CAAC,CAAC,CAAC;QAEhE,0DAA0D;QAC1D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEtD,+CAA+C;QAC/C,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,CACxC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  type CreateAccountOptions,\n  EthAccountType,\n  EthKeyringMethod,\n  EthKeyringWrapper,\n  EthMethod,\n  EthScope,\n  type ExportAccountOptions,\n  type ExportedAccount,\n  type KeyringAccount,\n  KeyringAccountEntropyTypeOption,\n  type KeyringCapabilities,\n  type KeyringV2,\n  KeyringType,\n  PrivateKeyEncoding,\n} from '@metamask/keyring-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport { add0x, type Hex } from '@metamask/utils';\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nimport type SimpleKeyring from './simple-keyring';\n\n/**\n * Methods supported by SimpleKeyring EOA accounts.\n * SimpleKeyring supports all standard signing methods plus encryption and app keys.\n */\nconst SIMPLE_KEYRING_METHODS = [\n  EthMethod.SignTransaction,\n  EthMethod.Sign,\n  EthMethod.PersonalSign,\n  EthMethod.SignTypedDataV1,\n  EthMethod.SignTypedDataV3,\n  EthMethod.SignTypedDataV4,\n  EthKeyringMethod.Decrypt,\n  EthKeyringMethod.GetEncryptionPublicKey,\n  EthKeyringMethod.GetAppKeyAddress,\n  EthKeyringMethod.SignEip7702Authorization,\n];\n\nconst simpleKeyringV2Capabilities: KeyringCapabilities = {\n  scopes: [EthScope.Eoa],\n  privateKey: {\n    importFormats: [\n      { encoding: PrivateKeyEncoding.Hexadecimal, type: EthAccountType.Eoa },\n    ],\n    exportFormats: [{ encoding: PrivateKeyEncoding.Hexadecimal }],\n  },\n};\n\n/**\n * Concrete {@link KeyringV2} adapter for {@link SimpleKeyring}.\n *\n * This wrapper exposes the accounts and signing capabilities of the legacy\n * SimpleKeyring via the unified V2 interface.\n */\nexport type SimpleKeyringV2Options = {\n  legacyKeyring: SimpleKeyring;\n};\n\nexport class SimpleKeyringV2\n  extends EthKeyringWrapper<SimpleKeyring>\n  implements KeyringV2\n{\n  constructor(options: SimpleKeyringV2Options) {\n    super({\n      type: KeyringType.PrivateKey,\n      inner: options.legacyKeyring,\n      capabilities: simpleKeyringV2Capabilities,\n    });\n  }\n\n  /**\n   * Creates a KeyringAccount object for the given address and index.\n   *\n   * @param address - The account address.\n   * @returns The created KeyringAccount.\n   */\n  #createKeyringAccount(address: Hex): KeyringAccount {\n    const id = this.registry.register(address);\n\n    const account: KeyringAccount = {\n      id,\n      type: EthAccountType.Eoa,\n      address,\n      scopes: [...this.capabilities.scopes],\n      methods: [...SIMPLE_KEYRING_METHODS],\n      options: {\n        entropy: {\n          type: KeyringAccountEntropyTypeOption.PrivateKey,\n        },\n        exportable: true,\n      },\n    };\n\n    // Add the account to the registry\n    this.registry.set(account);\n\n    return account;\n  }\n\n  /**\n   * Get all private keys from the inner SimpleKeyring.\n   *\n   * @returns An array of private keys in hexadecimal format.\n   */\n  async #getPrivateKeys(): Promise<string[]> {\n    return await this.inner.serialize();\n  }\n\n  /**\n   * Set private keys in the inner SimpleKeyring.\n   *\n   * @param privateKeys - An array of private keys in hexadecimal format.\n   */\n  async #setPrivateKeys(privateKeys: string[]): Promise<void> {\n    await this.inner.deserialize(privateKeys);\n  }\n\n  /**\n   * Executes a transactional update on the inner keyring state.\n   * If the callback throws, the state is automatically rolled back.\n   *\n   * @param callback - A function that receives the current private keys and performs the update.\n   * Should return the result on success, or throw to trigger rollback.\n   * @returns The result of the callback.\n   * @throws Error if the callback throws (after rollback).\n   */\n  async #withRollback<Result>(\n    callback: (currentPrivateKeys: string[]) => Promise<Result>,\n  ): Promise<Result> {\n    const originalPrivateKeys = await this.#getPrivateKeys();\n\n    try {\n      return await callback(originalPrivateKeys);\n    } catch (error) {\n      // Rollback on error\n      await this.#setPrivateKeys(originalPrivateKeys);\n      throw error;\n    }\n  }\n\n  /**\n   * Import a private key and return the new address.\n   * If the import fails (no new address added), rolls back to the original state.\n   *\n   * @param privateKey - The private key to import in hexadecimal format.\n   * @returns The address of the newly imported account.\n   * @throws Error if the import fails or no new address is added.\n   */\n  async #importPrivateKeyOrRollback(privateKey: string): Promise<Hex> {\n    return this.#withRollback(async (currentPrivateKeys) => {\n      // Get current addresses before import\n      const addressesBefore = new Set(await this.inner.getAccounts());\n\n      // Import the new private key\n      await this.#setPrivateKeys([...currentPrivateKeys, privateKey]);\n\n      // Get addresses after import and find the newly added one\n      const addressesAfter = await this.inner.getAccounts();\n\n      // Find the new address by diffing the two sets\n      const newAddresses = addressesAfter.filter(\n        (addr) => !addressesBefore.has(addr),\n      );\n\n      if (newAddresses.length !== 1 || !newAddresses[0]) {\n        throw new Error('Failed to import private key');\n      }\n\n      return newAddresses[0];\n    });\n  }\n\n  async getAccounts(): Promise<KeyringAccount[]> {\n    const addresses = await this.inner.getAccounts();\n\n    return addresses.map((address) => {\n      // Check if we already have this account in the registry\n      const existingId = this.registry.getAccountId(address);\n      if (existingId) {\n        const cached = this.registry.get(existingId);\n        if (cached) {\n          return cached;\n        }\n      }\n\n      // Create and register the account if not already cached\n      return this.#createKeyringAccount(address);\n    });\n  }\n\n  async createAccounts(\n    options: CreateAccountOptions,\n  ): Promise<KeyringAccount[]> {\n    return this.withLock(async () => {\n      // For SimpleKeyring, we only support private key import\n      if (options.type !== 'private-key:import') {\n        throw new Error(\n          `Unsupported account creation type for SimpleKeyring: ${options.type}`,\n        );\n      }\n\n      // Validate account type\n      if (options.accountType !== EthAccountType.Eoa) {\n        throw new Error(\n          `Unsupported account type for SimpleKeyring: ${options.accountType}. Only '${EthAccountType.Eoa}' is supported.`,\n        );\n      }\n\n      const { encoding, privateKey } = options;\n\n      // Validate encoding\n      if (encoding !== PrivateKeyEncoding.Hexadecimal) {\n        throw new Error(\n          `Unsupported encoding for SimpleKeyring: ${encoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`,\n        );\n      }\n\n      // Import the private key (with automatic rollback on failure)\n      const newAddress = await this.#importPrivateKeyOrRollback(privateKey);\n\n      // Create and return the new KeyringAccount\n      const newAccount = this.#createKeyringAccount(newAddress);\n      return [newAccount];\n    });\n  }\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * @param accountId - The account ID to delete.\n   */\n  async deleteAccount(accountId: AccountId): Promise<void> {\n    await this.withLock(async () => {\n      const account = await this.getAccount(accountId);\n\n      // Remove from the legacy keyring\n      this.inner.removeAccount(account.address);\n\n      // Remove from the registry\n      this.registry.delete(accountId);\n    });\n  }\n\n  /**\n   * Export the private key for an account in hexadecimal format.\n   *\n   * @param accountId - The ID of the account to export.\n   * @param options - Export options (only hexadecimal encoding is supported).\n   * @returns The exported account with private key.\n   */\n  async exportAccount(\n    accountId: AccountId,\n    options?: ExportAccountOptions,\n  ): Promise<ExportedAccount> {\n    const account = await this.getAccount(accountId);\n\n    const requestedEncoding =\n      options?.encoding ?? PrivateKeyEncoding.Hexadecimal;\n\n    if (requestedEncoding !== PrivateKeyEncoding.Hexadecimal) {\n      throw new Error(\n        `Unsupported encoding for SimpleKeyring: ${requestedEncoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`,\n      );\n    }\n\n    const privateKeyHex = await this.inner.exportAccount(\n      this.toHexAddress(account.address),\n    );\n    // Sanitize private key format\n    const privateKey = add0x(privateKeyHex);\n\n    const exported: ExportedAccount = {\n      type: 'private-key',\n      privateKey,\n      encoding: PrivateKeyEncoding.Hexadecimal,\n    };\n\n    return exported;\n  }\n}\n"]}

package/dist/simple-keyring-v2.d.cts

@@ -0,0 +1,33 @@
+import { type CreateAccountOptions, EthKeyringWrapper, type ExportAccountOptions, type ExportedAccount, type KeyringAccount, type KeyringV2 } from "@metamask/keyring-api";
+import type { AccountId } from "@metamask/keyring-utils";
+import type SimpleKeyring from "./simple-keyring.cjs";
+/**
+ * Concrete {@link KeyringV2} adapter for {@link SimpleKeyring}.
+ *
+ * This wrapper exposes the accounts and signing capabilities of the legacy
+ * SimpleKeyring via the unified V2 interface.
+ */
+export type SimpleKeyringV2Options = {
+    legacyKeyring: SimpleKeyring;
+};
+export declare class SimpleKeyringV2 extends EthKeyringWrapper<SimpleKeyring> implements KeyringV2 {
+    #private;
+    constructor(options: SimpleKeyringV2Options);
+    getAccounts(): Promise<KeyringAccount[]>;
+    createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+    /**
+     * Export the private key for an account in hexadecimal format.
+     *
+     * @param accountId - The ID of the account to export.
+     * @param options - Export options (only hexadecimal encoding is supported).
+     * @returns The exported account with private key.
+     */
+    exportAccount(accountId: AccountId, options?: ExportAccountOptions): Promise<ExportedAccount>;
+}
+//# sourceMappingURL=simple-keyring-v2.d.cts.map

package/dist/simple-keyring-v2.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-keyring-v2.d.cts","sourceRoot":"","sources":["../src/simple-keyring-v2.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,oBAAoB,EAGzB,iBAAiB,EAGjB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,cAAc,EAGnB,KAAK,SAAS,EAGf,8BAA8B;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAIzD,OAAO,KAAK,aAAa,6BAAyB;AA6BlD;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,qBAAa,eACX,SAAQ,iBAAiB,CAAC,aAAa,CACvC,YAAW,SAAS;;gBAER,OAAO,EAAE,sBAAsB;IA8GrC,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAkBxC,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IAkC5B;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxD;;;;;;OAMG;IACG,aAAa,CACjB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,eAAe,CAAC;CA0B5B"}

package/dist/simple-keyring-v2.d.mts

@@ -0,0 +1,33 @@
+import { type CreateAccountOptions, EthKeyringWrapper, type ExportAccountOptions, type ExportedAccount, type KeyringAccount, type KeyringV2 } from "@metamask/keyring-api";
+import type { AccountId } from "@metamask/keyring-utils";
+import type SimpleKeyring from "./simple-keyring.mjs";
+/**
+ * Concrete {@link KeyringV2} adapter for {@link SimpleKeyring}.
+ *
+ * This wrapper exposes the accounts and signing capabilities of the legacy
+ * SimpleKeyring via the unified V2 interface.
+ */
+export type SimpleKeyringV2Options = {
+    legacyKeyring: SimpleKeyring;
+};
+export declare class SimpleKeyringV2 extends EthKeyringWrapper<SimpleKeyring> implements KeyringV2 {
+    #private;
+    constructor(options: SimpleKeyringV2Options);
+    getAccounts(): Promise<KeyringAccount[]>;
+    createAccounts(options: CreateAccountOptions): Promise<KeyringAccount[]>;
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    deleteAccount(accountId: AccountId): Promise<void>;
+    /**
+     * Export the private key for an account in hexadecimal format.
+     *
+     * @param accountId - The ID of the account to export.
+     * @param options - Export options (only hexadecimal encoding is supported).
+     * @returns The exported account with private key.
+     */
+    exportAccount(accountId: AccountId, options?: ExportAccountOptions): Promise<ExportedAccount>;
+}
+//# sourceMappingURL=simple-keyring-v2.d.mts.map

package/dist/simple-keyring-v2.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-keyring-v2.d.mts","sourceRoot":"","sources":["../src/simple-keyring-v2.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,oBAAoB,EAGzB,iBAAiB,EAGjB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,cAAc,EAGnB,KAAK,SAAS,EAGf,8BAA8B;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,gCAAgC;AAIzD,OAAO,KAAK,aAAa,6BAAyB;AA6BlD;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,qBAAa,eACX,SAAQ,iBAAiB,CAAC,aAAa,CACvC,YAAW,SAAS;;gBAER,OAAO,EAAE,sBAAsB;IA8GrC,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAkBxC,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC;IAkC5B;;;;OAIG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxD;;;;;;OAMG;IACG,aAAa,CACjB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,eAAe,CAAC;CA0B5B"}

package/dist/simple-keyring-v2.mjs

@@ -0,0 +1,197 @@
+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 _SimpleKeyringV2_instances, _SimpleKeyringV2_createKeyringAccount, _SimpleKeyringV2_getPrivateKeys, _SimpleKeyringV2_setPrivateKeys, _SimpleKeyringV2_withRollback, _SimpleKeyringV2_importPrivateKeyOrRollback;
+import { EthAccountType, EthKeyringMethod, EthKeyringWrapper, EthMethod, EthScope, KeyringAccountEntropyTypeOption, KeyringType, PrivateKeyEncoding } from "@metamask/keyring-api";
+import { add0x } from "@metamask/utils";
+/**
+ * Methods supported by SimpleKeyring EOA accounts.
+ * SimpleKeyring supports all standard signing methods plus encryption and app keys.
+ */
+const SIMPLE_KEYRING_METHODS = [
+    EthMethod.SignTransaction,
+    EthMethod.Sign,
+    EthMethod.PersonalSign,
+    EthMethod.SignTypedDataV1,
+    EthMethod.SignTypedDataV3,
+    EthMethod.SignTypedDataV4,
+    EthKeyringMethod.Decrypt,
+    EthKeyringMethod.GetEncryptionPublicKey,
+    EthKeyringMethod.GetAppKeyAddress,
+    EthKeyringMethod.SignEip7702Authorization,
+];
+const simpleKeyringV2Capabilities = {
+    scopes: [EthScope.Eoa],
+    privateKey: {
+        importFormats: [
+            { encoding: PrivateKeyEncoding.Hexadecimal, type: EthAccountType.Eoa },
+        ],
+        exportFormats: [{ encoding: PrivateKeyEncoding.Hexadecimal }],
+    },
+};
+export class SimpleKeyringV2 extends EthKeyringWrapper {
+    constructor(options) {
+        super({
+            type: KeyringType.PrivateKey,
+            inner: options.legacyKeyring,
+            capabilities: simpleKeyringV2Capabilities,
+        });
+        _SimpleKeyringV2_instances.add(this);
+    }
+    async getAccounts() {
+        const addresses = await this.inner.getAccounts();
+        return addresses.map((address) => {
+            // Check if we already have this account in the registry
+            const existingId = this.registry.getAccountId(address);
+            if (existingId) {
+                const cached = this.registry.get(existingId);
+                if (cached) {
+                    return cached;
+                }
+            }
+            // Create and register the account if not already cached
+            return __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_createKeyringAccount).call(this, address);
+        });
+    }
+    async createAccounts(options) {
+        return this.withLock(async () => {
+            // For SimpleKeyring, we only support private key import
+            if (options.type !== 'private-key:import') {
+                throw new Error(`Unsupported account creation type for SimpleKeyring: ${options.type}`);
+            }
+            // Validate account type
+            if (options.accountType !== EthAccountType.Eoa) {
+                throw new Error(`Unsupported account type for SimpleKeyring: ${options.accountType}. Only '${EthAccountType.Eoa}' is supported.`);
+            }
+            const { encoding, privateKey } = options;
+            // Validate encoding
+            if (encoding !== PrivateKeyEncoding.Hexadecimal) {
+                throw new Error(`Unsupported encoding for SimpleKeyring: ${encoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`);
+            }
+            // Import the private key (with automatic rollback on failure)
+            const newAddress = await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_importPrivateKeyOrRollback).call(this, privateKey);
+            // Create and return the new KeyringAccount
+            const newAccount = __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_createKeyringAccount).call(this, newAddress);
+            return [newAccount];
+        });
+    }
+    /**
+     * Delete an account from the keyring.
+     *
+     * @param accountId - The account ID to delete.
+     */
+    async deleteAccount(accountId) {
+        await this.withLock(async () => {
+            const account = await this.getAccount(accountId);
+            // Remove from the legacy keyring
+            this.inner.removeAccount(account.address);
+            // Remove from the registry
+            this.registry.delete(accountId);
+        });
+    }
+    /**
+     * Export the private key for an account in hexadecimal format.
+     *
+     * @param accountId - The ID of the account to export.
+     * @param options - Export options (only hexadecimal encoding is supported).
+     * @returns The exported account with private key.
+     */
+    async exportAccount(accountId, options) {
+        const account = await this.getAccount(accountId);
+        const requestedEncoding = options?.encoding ?? PrivateKeyEncoding.Hexadecimal;
+        if (requestedEncoding !== PrivateKeyEncoding.Hexadecimal) {
+            throw new Error(`Unsupported encoding for SimpleKeyring: ${requestedEncoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`);
+        }
+        const privateKeyHex = await this.inner.exportAccount(this.toHexAddress(account.address));
+        // Sanitize private key format
+        const privateKey = add0x(privateKeyHex);
+        const exported = {
+            type: 'private-key',
+            privateKey,
+            encoding: PrivateKeyEncoding.Hexadecimal,
+        };
+        return exported;
+    }
+}
+_SimpleKeyringV2_instances = new WeakSet(), _SimpleKeyringV2_createKeyringAccount = function _SimpleKeyringV2_createKeyringAccount(address) {
+    const id = this.registry.register(address);
+    const account = {
+        id,
+        type: EthAccountType.Eoa,
+        address,
+        scopes: [...this.capabilities.scopes],
+        methods: [...SIMPLE_KEYRING_METHODS],
+        options: {
+            entropy: {
+                type: KeyringAccountEntropyTypeOption.PrivateKey,
+            },
+            exportable: true,
+        },
+    };
+    // Add the account to the registry
+    this.registry.set(account);
+    return account;
+}, _SimpleKeyringV2_getPrivateKeys = 
+/**
+ * Get all private keys from the inner SimpleKeyring.
+ *
+ * @returns An array of private keys in hexadecimal format.
+ */
+async function _SimpleKeyringV2_getPrivateKeys() {
+    return await this.inner.serialize();
+}, _SimpleKeyringV2_setPrivateKeys = 
+/**
+ * Set private keys in the inner SimpleKeyring.
+ *
+ * @param privateKeys - An array of private keys in hexadecimal format.
+ */
+async function _SimpleKeyringV2_setPrivateKeys(privateKeys) {
+    await this.inner.deserialize(privateKeys);
+}, _SimpleKeyringV2_withRollback = 
+/**
+ * Executes a transactional update on the inner keyring state.
+ * If the callback throws, the state is automatically rolled back.
+ *
+ * @param callback - A function that receives the current private keys and performs the update.
+ * Should return the result on success, or throw to trigger rollback.
+ * @returns The result of the callback.
+ * @throws Error if the callback throws (after rollback).
+ */
+async function _SimpleKeyringV2_withRollback(callback) {
+    const originalPrivateKeys = await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_getPrivateKeys).call(this);
+    try {
+        return await callback(originalPrivateKeys);
+    }
+    catch (error) {
+        // Rollback on error
+        await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_setPrivateKeys).call(this, originalPrivateKeys);
+        throw error;
+    }
+}, _SimpleKeyringV2_importPrivateKeyOrRollback = 
+/**
+ * Import a private key and return the new address.
+ * If the import fails (no new address added), rolls back to the original state.
+ *
+ * @param privateKey - The private key to import in hexadecimal format.
+ * @returns The address of the newly imported account.
+ * @throws Error if the import fails or no new address is added.
+ */
+async function _SimpleKeyringV2_importPrivateKeyOrRollback(privateKey) {
+    return __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_withRollback).call(this, async (currentPrivateKeys) => {
+        // Get current addresses before import
+        const addressesBefore = new Set(await this.inner.getAccounts());
+        // Import the new private key
+        await __classPrivateFieldGet(this, _SimpleKeyringV2_instances, "m", _SimpleKeyringV2_setPrivateKeys).call(this, [...currentPrivateKeys, privateKey]);
+        // Get addresses after import and find the newly added one
+        const addressesAfter = await this.inner.getAccounts();
+        // Find the new address by diffing the two sets
+        const newAddresses = addressesAfter.filter((addr) => !addressesBefore.has(addr));
+        if (newAddresses.length !== 1 || !newAddresses[0]) {
+            throw new Error('Failed to import private key');
+        }
+        return newAddresses[0];
+    });
+};
+//# sourceMappingURL=simple-keyring-v2.mjs.map

package/dist/simple-keyring-v2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-keyring-v2.mjs","sourceRoot":"","sources":["../src/simple-keyring-v2.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAEL,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,SAAS,EACT,QAAQ,EAIR,+BAA+B,EAG/B,WAAW,EACX,kBAAkB,EACnB,8BAA8B;AAE/B,OAAO,EAAE,KAAK,EAAY,wBAAwB;AAKlD;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,SAAS,CAAC,eAAe;IACzB,SAAS,CAAC,IAAI;IACd,SAAS,CAAC,YAAY;IACtB,SAAS,CAAC,eAAe;IACzB,SAAS,CAAC,eAAe;IACzB,SAAS,CAAC,eAAe;IACzB,gBAAgB,CAAC,OAAO;IACxB,gBAAgB,CAAC,sBAAsB;IACvC,gBAAgB,CAAC,gBAAgB;IACjC,gBAAgB,CAAC,wBAAwB;CAC1C,CAAC;AAEF,MAAM,2BAA2B,GAAwB;IACvD,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;IACtB,UAAU,EAAE;QACV,aAAa,EAAE;YACb,EAAE,QAAQ,EAAE,kBAAkB,CAAC,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,EAAE;SACvE;QACD,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,kBAAkB,CAAC,WAAW,EAAE,CAAC;KAC9D;CACF,CAAC;AAYF,MAAM,OAAO,eACX,SAAQ,iBAAgC;IAGxC,YAAY,OAA+B;QACzC,KAAK,CAAC;YACJ,IAAI,EAAE,WAAW,CAAC,UAAU;YAC5B,KAAK,EAAE,OAAO,CAAC,aAAa;YAC5B,YAAY,EAAE,2BAA2B;SAC1C,CAAC,CAAC;;IACL,CAAC;IAwGD,KAAK,CAAC,WAAW;QACf,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEjD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,wDAAwD;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC7C,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YAED,wDAAwD;YACxD,OAAO,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC9B,wDAAwD;YACxD,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,CAAC,IAAI,EAAE,CACvE,CAAC;YACJ,CAAC;YAED,wBAAwB;YACxB,IAAI,OAAO,CAAC,WAAW,KAAK,cAAc,CAAC,GAAG,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CACb,+CAA+C,OAAO,CAAC,WAAW,WAAW,cAAc,CAAC,GAAG,iBAAiB,CACjH,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;YAEzC,oBAAoB;YACpB,IAAI,QAAQ,KAAK,kBAAkB,CAAC,WAAW,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CACb,2CAA2C,QAAQ,WAAW,kBAAkB,CAAC,WAAW,iBAAiB,CAC9G,CAAC;YACJ,CAAC;YAED,8DAA8D;YAC9D,MAAM,UAAU,GAAG,MAAM,uBAAA,IAAI,+EAA4B,MAAhC,IAAI,EAA6B,UAAU,CAAC,CAAC;YAEtE,2CAA2C;YAC3C,MAAM,UAAU,GAAG,uBAAA,IAAI,yEAAsB,MAA1B,IAAI,EAAuB,UAAU,CAAC,CAAC;YAC1D,OAAO,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,SAAoB;QACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAC7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAEjD,iCAAiC;YACjC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAE1C,2BAA2B;YAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CACjB,SAAoB,EACpB,OAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,iBAAiB,GACrB,OAAO,EAAE,QAAQ,IAAI,kBAAkB,CAAC,WAAW,CAAC;QAEtD,IAAI,iBAAiB,KAAK,kBAAkB,CAAC,WAAW,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,2CAA2C,iBAAiB,WAAW,kBAAkB,CAAC,WAAW,iBAAiB,CACvH,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAClD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CACnC,CAAC;QACF,8BAA8B;QAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAoB;YAChC,IAAI,EAAE,aAAa;YACnB,UAAU;YACV,QAAQ,EAAE,kBAAkB,CAAC,WAAW;SACzC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;mIA3MuB,OAAY;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE3C,MAAM,OAAO,GAAmB;QAC9B,EAAE;QACF,IAAI,EAAE,cAAc,CAAC,GAAG;QACxB,OAAO;QACP,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACrC,OAAO,EAAE,CAAC,GAAG,sBAAsB,CAAC;QACpC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,IAAI,EAAE,+BAA+B,CAAC,UAAU;aACjD;YACD,UAAU,EAAE,IAAI;SACjB;KACF,CAAC;IAEF,kCAAkC;IAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,KAAK,0CAAiB,WAAqB;IACzC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,wCACH,QAA2D;IAE3D,MAAM,mBAAmB,GAAG,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,CAAkB,CAAC;IAEzD,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,oBAAoB;QACpB,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,EAAiB,mBAAmB,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,sDAA6B,UAAkB;IAClD,OAAO,uBAAA,IAAI,iEAAc,MAAlB,IAAI,EAAe,KAAK,EAAE,kBAAkB,EAAE,EAAE;QACrD,sCAAsC;QACtC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAEhE,6BAA6B;QAC7B,MAAM,uBAAA,IAAI,mEAAgB,MAApB,IAAI,EAAiB,CAAC,GAAG,kBAAkB,EAAE,UAAU,CAAC,CAAC,CAAC;QAEhE,0DAA0D;QAC1D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAEtD,+CAA+C;QAC/C,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,CACxC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CACrC,CAAC;QAEF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {\n  type CreateAccountOptions,\n  EthAccountType,\n  EthKeyringMethod,\n  EthKeyringWrapper,\n  EthMethod,\n  EthScope,\n  type ExportAccountOptions,\n  type ExportedAccount,\n  type KeyringAccount,\n  KeyringAccountEntropyTypeOption,\n  type KeyringCapabilities,\n  type KeyringV2,\n  KeyringType,\n  PrivateKeyEncoding,\n} from '@metamask/keyring-api';\nimport type { AccountId } from '@metamask/keyring-utils';\nimport { add0x, type Hex } from '@metamask/utils';\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nimport type SimpleKeyring from './simple-keyring';\n\n/**\n * Methods supported by SimpleKeyring EOA accounts.\n * SimpleKeyring supports all standard signing methods plus encryption and app keys.\n */\nconst SIMPLE_KEYRING_METHODS = [\n  EthMethod.SignTransaction,\n  EthMethod.Sign,\n  EthMethod.PersonalSign,\n  EthMethod.SignTypedDataV1,\n  EthMethod.SignTypedDataV3,\n  EthMethod.SignTypedDataV4,\n  EthKeyringMethod.Decrypt,\n  EthKeyringMethod.GetEncryptionPublicKey,\n  EthKeyringMethod.GetAppKeyAddress,\n  EthKeyringMethod.SignEip7702Authorization,\n];\n\nconst simpleKeyringV2Capabilities: KeyringCapabilities = {\n  scopes: [EthScope.Eoa],\n  privateKey: {\n    importFormats: [\n      { encoding: PrivateKeyEncoding.Hexadecimal, type: EthAccountType.Eoa },\n    ],\n    exportFormats: [{ encoding: PrivateKeyEncoding.Hexadecimal }],\n  },\n};\n\n/**\n * Concrete {@link KeyringV2} adapter for {@link SimpleKeyring}.\n *\n * This wrapper exposes the accounts and signing capabilities of the legacy\n * SimpleKeyring via the unified V2 interface.\n */\nexport type SimpleKeyringV2Options = {\n  legacyKeyring: SimpleKeyring;\n};\n\nexport class SimpleKeyringV2\n  extends EthKeyringWrapper<SimpleKeyring>\n  implements KeyringV2\n{\n  constructor(options: SimpleKeyringV2Options) {\n    super({\n      type: KeyringType.PrivateKey,\n      inner: options.legacyKeyring,\n      capabilities: simpleKeyringV2Capabilities,\n    });\n  }\n\n  /**\n   * Creates a KeyringAccount object for the given address and index.\n   *\n   * @param address - The account address.\n   * @returns The created KeyringAccount.\n   */\n  #createKeyringAccount(address: Hex): KeyringAccount {\n    const id = this.registry.register(address);\n\n    const account: KeyringAccount = {\n      id,\n      type: EthAccountType.Eoa,\n      address,\n      scopes: [...this.capabilities.scopes],\n      methods: [...SIMPLE_KEYRING_METHODS],\n      options: {\n        entropy: {\n          type: KeyringAccountEntropyTypeOption.PrivateKey,\n        },\n        exportable: true,\n      },\n    };\n\n    // Add the account to the registry\n    this.registry.set(account);\n\n    return account;\n  }\n\n  /**\n   * Get all private keys from the inner SimpleKeyring.\n   *\n   * @returns An array of private keys in hexadecimal format.\n   */\n  async #getPrivateKeys(): Promise<string[]> {\n    return await this.inner.serialize();\n  }\n\n  /**\n   * Set private keys in the inner SimpleKeyring.\n   *\n   * @param privateKeys - An array of private keys in hexadecimal format.\n   */\n  async #setPrivateKeys(privateKeys: string[]): Promise<void> {\n    await this.inner.deserialize(privateKeys);\n  }\n\n  /**\n   * Executes a transactional update on the inner keyring state.\n   * If the callback throws, the state is automatically rolled back.\n   *\n   * @param callback - A function that receives the current private keys and performs the update.\n   * Should return the result on success, or throw to trigger rollback.\n   * @returns The result of the callback.\n   * @throws Error if the callback throws (after rollback).\n   */\n  async #withRollback<Result>(\n    callback: (currentPrivateKeys: string[]) => Promise<Result>,\n  ): Promise<Result> {\n    const originalPrivateKeys = await this.#getPrivateKeys();\n\n    try {\n      return await callback(originalPrivateKeys);\n    } catch (error) {\n      // Rollback on error\n      await this.#setPrivateKeys(originalPrivateKeys);\n      throw error;\n    }\n  }\n\n  /**\n   * Import a private key and return the new address.\n   * If the import fails (no new address added), rolls back to the original state.\n   *\n   * @param privateKey - The private key to import in hexadecimal format.\n   * @returns The address of the newly imported account.\n   * @throws Error if the import fails or no new address is added.\n   */\n  async #importPrivateKeyOrRollback(privateKey: string): Promise<Hex> {\n    return this.#withRollback(async (currentPrivateKeys) => {\n      // Get current addresses before import\n      const addressesBefore = new Set(await this.inner.getAccounts());\n\n      // Import the new private key\n      await this.#setPrivateKeys([...currentPrivateKeys, privateKey]);\n\n      // Get addresses after import and find the newly added one\n      const addressesAfter = await this.inner.getAccounts();\n\n      // Find the new address by diffing the two sets\n      const newAddresses = addressesAfter.filter(\n        (addr) => !addressesBefore.has(addr),\n      );\n\n      if (newAddresses.length !== 1 || !newAddresses[0]) {\n        throw new Error('Failed to import private key');\n      }\n\n      return newAddresses[0];\n    });\n  }\n\n  async getAccounts(): Promise<KeyringAccount[]> {\n    const addresses = await this.inner.getAccounts();\n\n    return addresses.map((address) => {\n      // Check if we already have this account in the registry\n      const existingId = this.registry.getAccountId(address);\n      if (existingId) {\n        const cached = this.registry.get(existingId);\n        if (cached) {\n          return cached;\n        }\n      }\n\n      // Create and register the account if not already cached\n      return this.#createKeyringAccount(address);\n    });\n  }\n\n  async createAccounts(\n    options: CreateAccountOptions,\n  ): Promise<KeyringAccount[]> {\n    return this.withLock(async () => {\n      // For SimpleKeyring, we only support private key import\n      if (options.type !== 'private-key:import') {\n        throw new Error(\n          `Unsupported account creation type for SimpleKeyring: ${options.type}`,\n        );\n      }\n\n      // Validate account type\n      if (options.accountType !== EthAccountType.Eoa) {\n        throw new Error(\n          `Unsupported account type for SimpleKeyring: ${options.accountType}. Only '${EthAccountType.Eoa}' is supported.`,\n        );\n      }\n\n      const { encoding, privateKey } = options;\n\n      // Validate encoding\n      if (encoding !== PrivateKeyEncoding.Hexadecimal) {\n        throw new Error(\n          `Unsupported encoding for SimpleKeyring: ${encoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`,\n        );\n      }\n\n      // Import the private key (with automatic rollback on failure)\n      const newAddress = await this.#importPrivateKeyOrRollback(privateKey);\n\n      // Create and return the new KeyringAccount\n      const newAccount = this.#createKeyringAccount(newAddress);\n      return [newAccount];\n    });\n  }\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * @param accountId - The account ID to delete.\n   */\n  async deleteAccount(accountId: AccountId): Promise<void> {\n    await this.withLock(async () => {\n      const account = await this.getAccount(accountId);\n\n      // Remove from the legacy keyring\n      this.inner.removeAccount(account.address);\n\n      // Remove from the registry\n      this.registry.delete(accountId);\n    });\n  }\n\n  /**\n   * Export the private key for an account in hexadecimal format.\n   *\n   * @param accountId - The ID of the account to export.\n   * @param options - Export options (only hexadecimal encoding is supported).\n   * @returns The exported account with private key.\n   */\n  async exportAccount(\n    accountId: AccountId,\n    options?: ExportAccountOptions,\n  ): Promise<ExportedAccount> {\n    const account = await this.getAccount(accountId);\n\n    const requestedEncoding =\n      options?.encoding ?? PrivateKeyEncoding.Hexadecimal;\n\n    if (requestedEncoding !== PrivateKeyEncoding.Hexadecimal) {\n      throw new Error(\n        `Unsupported encoding for SimpleKeyring: ${requestedEncoding}. Only '${PrivateKeyEncoding.Hexadecimal}' is supported.`,\n      );\n    }\n\n    const privateKeyHex = await this.inner.exportAccount(\n      this.toHexAddress(account.address),\n    );\n    // Sanitize private key format\n    const privateKey = add0x(privateKeyHex);\n\n    const exported: ExportedAccount = {\n      type: 'private-key',\n      privateKey,\n      encoding: PrivateKeyEncoding.Hexadecimal,\n    };\n\n    return exported;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/eth-simple-keyring",
-  "version": "11.0.0-855692d",
+  "version": "11.0.0-ca02a28",
   "description": "A simple standard interface for a series of Ethereum private keys.",
   "keywords": [
     "ethereum",
@@ -46,6 +46,7 @@
   "dependencies": {
     "@ethereumjs/util": "^9.1.0",
     "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/keyring-api": "21.3.0",
     "@metamask/utils": "^11.1.0",
     "ethereum-cryptography": "^2.1.2",
     "randombytes": "^2.1.0"