@metamask/accounts-controller 37.2.0 → 38.1.0

package/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [38.1.0]
+
+### Changed
+
+- Use `KeyringV1Adapter` for `SnapKeyring` v2 accounts ([#8703](https://github.com/MetaMask/core/pull/8703))
+  - `SnapKeyring` v2 instances will be adapted/wrapped by a v1 keyring adapter, making it compatible with the current `KeyringController` keyrings management.
+- Bump `@metamask/keyring-utils` from `^3.1.0` to `^3.2.1` ([#8703](https://github.com/MetaMask/core/pull/8703))
+- Bump `@metamask/keyring-controller` from `^25.4.0` to `^25.5.0` ([#8722](https://github.com/MetaMask/core/pull/8722))
+- Bump `@metamask/network-controller` from `^30.1.0` to `^31.0.0` ([#8755](https://github.com/MetaMask/core/pull/8755))
+
+## [38.0.0]
+
+### Added
+
+- Add support for `SnapKeyring` v2 accounts ([#8513](https://github.com/MetaMask/core/pull/8513))
+
+### Changed
+
+- Bump `@metamask/messenger` from `^1.0.0` to `^1.2.0` ([#8364](https://github.com/MetaMask/core/pull/8364), [#8373](https://github.com/MetaMask/core/pull/8373), [#8632](https://github.com/MetaMask/core/pull/8632))
+- Bump `@metamask/base-controller` from `^9.0.1` to `^9.1.0` ([#8457](https://github.com/MetaMask/core/pull/8457))
+- Bump `@metamask/eth-snap-keyring` from `^19.0.0` to `^22.0.1` ([#8464](https://github.com/MetaMask/core/pull/8464), [#8584](https://github.com/MetaMask/core/pull/8584), [#8647](https://github.com/MetaMask/core/pull/8647))
+- Bump `@metamask/keyring-api` from `^21.6.0` to `^23.1.0` ([#8464](https://github.com/MetaMask/core/pull/8464), [#8647](https://github.com/MetaMask/core/pull/8647))
+- Bump `@metamask/keyring-internal-api` from `^10.0.0` to `^11.0.1` ([#8464](https://github.com/MetaMask/core/pull/8464), [#8584](https://github.com/MetaMask/core/pull/8584), [#8647](https://github.com/MetaMask/core/pull/8647))
+- Bump `@metamask/keyring-controller` from `^25.2.0` to `^25.4.0` ([#8634](https://github.com/MetaMask/core/pull/8634), [#8665](https://github.com/MetaMask/core/pull/8665))
+- Bump `@metamask/network-controller` from `^30.0.1` to `^30.1.0` ([#8636](https://github.com/MetaMask/core/pull/8636))
+
+### Removed
+
+- **BREAKING:** `InternalAccount.metadata.snap.{enabled,name}` properties have been removed ([#8584](https://github.com/MetaMask/core/pull/8584))
+  - You now need to use `metadata.snap.id` and the `SnapController:<actions>` to get those information.
+- No longer depend on `SnapController:stateChange` event ([#8584](https://github.com/MetaMask/core/pull/8584))
+
 ## [37.2.0]
 
 ### Added
@@ -761,7 +793,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release ([#1637](https://github.com/MetaMask/core/pull/1637))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@37.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@38.1.0...HEAD
+[38.1.0]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@38.0.0...@metamask/accounts-controller@38.1.0
+[38.0.0]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@37.2.0...@metamask/accounts-controller@38.0.0
 [37.2.0]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@37.1.1...@metamask/accounts-controller@37.2.0
 [37.1.1]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@37.1.0...@metamask/accounts-controller@37.1.1
 [37.1.0]: https://github.com/MetaMask/core/compare/@metamask/accounts-controller@37.0.0...@metamask/accounts-controller@37.1.0

package/dist/AccountsController.cjs

@@ -4,12 +4,15 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _AccountsController_instances, _AccountsController_getAccountExpect, _AccountsController_assertAccountCanBeRenamed, _AccountsController_getInternalAccountForNonSnapAccount, _AccountsController_getSnapKeyring, _AccountsController_handleOnSnapKeyringAccountEvent, _AccountsController_handleOnKeyringStateChange, _AccountsController_update, _AccountsController_handleOnSnapStateChange, _AccountsController_getLastSelectedAccount, _AccountsController_getLastSelectedIndex, _AccountsController_getInternalAccountFromAddressAndType, _AccountsController_handleOnMultichainNetworkDidChange, _AccountsController_subscribeToMessageEvents;
+var _AccountsController_instances, _AccountsController_getAccountExpect, _AccountsController_assertAccountCanBeRenamed, _AccountsController_getInternalAccountForNonSnapAccount, _AccountsController_getSnapKeyring, _AccountsController_getAccountFromSnapKeyringV1, _AccountsController_getAccountFromSnapKeyringV2, _AccountsController_handleOnSnapKeyringAccountEvent, _AccountsController_handleOnKeyringStateChange, _AccountsController_update, _AccountsController_getLastSelectedAccount, _AccountsController_getLastSelectedIndex, _AccountsController_getInternalAccountFromAddressAndType, _AccountsController_handleOnMultichainNetworkDidChange, _AccountsController_subscribeToMessageEvents;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountsController = exports.EMPTY_ACCOUNT = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const eth_snap_keyring_1 = require("@metamask/eth-snap-keyring");
+const v2_1 = require("@metamask/eth-snap-keyring/v2");
 const keyring_api_1 = require("@metamask/keyring-api");
+const v2_2 = require("@metamask/keyring-api/v2");
+const v2_3 = require("@metamask/keyring-sdk/v2");
 const keyring_utils_1 = require("@metamask/keyring-utils");
 const utils_1 = require("@metamask/utils");
 const lodash_1 = require("lodash");
@@ -475,6 +478,50 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     // Snap keyring is not available until the first account is created in the keyring
     // controller, so this might be undefined.
     return snapKeyring;
+}, _AccountsController_getAccountFromSnapKeyringV1 = function _AccountsController_getAccountFromSnapKeyringV1(address) {
+    const snapKeyring = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getSnapKeyring).call(this);
+    // We need the Snap keyring to retrieve the account from its address.
+    if (!snapKeyring) {
+        return undefined;
+    }
+    // This might be undefined if the Snap deleted the account before
+    // reaching that point.
+    return snapKeyring.getAccountByAddress(address);
+}, _AccountsController_getAccountFromSnapKeyringV2 = function _AccountsController_getAccountFromSnapKeyringV2(address) {
+    const keyrings = this.messenger.call('KeyringController:getKeyringsByType', v2_2.KeyringType.Snap);
+    // Snap keyring v2 are "per-Snaps" (and can be accessed using their v1 adapter), so we need to
+    // iterate over all of them to find the account.
+    // NOTE: `:getKeyringsByType` will only return v1 instances, that's why we need to use their v1
+    // adapter + `unwrap` method to get the reference to their v2 instance.
+    for (const keyring of keyrings) {
+        if (keyring instanceof v2_3.KeyringV1Adapter) {
+            // NOTE: We already filtering by `KeyringType.Snap`, so we are sure that those adapters
+            // are wrapping a Snap keyring v2.
+            const adapter = keyring;
+            const keyringV2 = adapter.unwrap();
+            // We use the synchronous method here since this method is used during `:stateChange` that are
+            // use synchronous handlers.
+            const account = keyringV2.lookupByAddress(address);
+            if (account) {
+                return {
+                    ...account,
+                    // We still have to use internal account for now, so we inject some metadata.
+                    metadata: {
+                        name: '',
+                        importTime: Date.now(),
+                        lastSelected: 0,
+                        keyring: {
+                            type: v2_2.KeyringType.Snap,
+                        },
+                        snap: {
+                            id: keyringV2.snapId,
+                        },
+                    },
+                };
+            }
+        }
+    }
+    return undefined;
 }, _AccountsController_handleOnSnapKeyringAccountEvent = function _AccountsController_handleOnSnapKeyringAccountEvent(event, ...payload) {
     this.messenger.publish(event, ...payload);
 }, _AccountsController_handleOnKeyringStateChange = function _AccountsController_handleOnKeyringStateChange({ isUnlocked, keyrings, }) {
@@ -487,30 +534,15 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     }
     (0, logger_1.projectLogger)('Synchronizing accounts with keyrings (through :stateChange)...');
     // State patches.
-    const generatePatch = () => {
-        return {
-            previous: {},
-            added: [],
-            updated: [],
-            removed: [],
-        };
-    };
-    const patches = {
-        snap: generatePatch(),
-        normal: generatePatch(),
-    };
-    // Gets the patch object based on the keyring type (since Snap accounts and other accounts
-    // are handled differently).
-    const patchOf = (type) => {
-        if ((0, utils_2.isSnapKeyringType)(type)) {
-            return patches.snap;
-        }
-        return patches.normal;
+    const patch = {
+        previous: {},
+        added: [],
+        updated: [],
+        removed: [],
     };
     // Create a map (with lower-cased addresses) of all existing accounts.
     for (const account of this.listMultichainAccounts()) {
         const address = account.address.toLowerCase();
-        const patch = patchOf(account.metadata.keyring.type);
         patch.previous[address] = account;
     }
     // Go over all keyring changes and create patches out of it.
@@ -521,7 +553,6 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
         if ((0, utils_2.isMoneyKeyringType)(keyring.type)) {
             continue;
         }
-        const patch = patchOf(keyring.type);
         for (const accountAddress of keyring.accounts) {
             // Lower-case address to use it in the `previous` map.
             const address = accountAddress.toLowerCase();
@@ -543,12 +574,10 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     }
     // We might have accounts associated with removed keyrings, so we iterate
     // over all previous known accounts and check against the keyring addresses.
-    for (const patch of [patches.snap, patches.normal]) {
-        for (const [address, account] of Object.entries(patch.previous)) {
-            // If a previous address is not part of the new addesses, then it got removed.
-            if (!addresses.has(address)) {
-                patch.removed.push(account);
-            }
+    for (const [address, account] of Object.entries(patch.previous)) {
+        // If a previous address is not part of the new addesses, then it got removed.
+        if (!addresses.has(address)) {
+            patch.removed.push(account);
         }
     }
     // Diff that we will use to publish events afterward.
@@ -558,29 +587,27 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     };
     __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_update).call(this, (state) => {
         const { internalAccounts, accountIdByAddress } = state;
-        for (const patch of [patches.snap, patches.normal]) {
-            for (const account of patch.removed) {
-                delete internalAccounts.accounts[account.id];
-                delete accountIdByAddress[account.address];
-                diff.removed.push(account.id);
-            }
-            for (const added of patch.added) {
-                const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getInternalAccountFromAddressAndType).call(this, added.address, added.keyring);
-                if (account) {
-                    const accounts = Object.values(internalAccounts.accounts);
-                    // If it's the first account, we need to select it.
-                    const lastSelected = accounts.length === 0 ? __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getLastSelectedIndex).call(this) : 0;
-                    internalAccounts.accounts[account.id] = {
-                        ...account,
-                        metadata: {
-                            ...account.metadata,
-                            importTime: Date.now(),
-                            lastSelected,
-                        },
-                    };
-                    accountIdByAddress[account.address] = account.id;
-                    diff.added.push(internalAccounts.accounts[account.id]);
-                }
+        for (const account of patch.removed) {
+            delete internalAccounts.accounts[account.id];
+            delete accountIdByAddress[account.address];
+            diff.removed.push(account.id);
+        }
+        for (const added of patch.added) {
+            const account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getInternalAccountFromAddressAndType).call(this, added.address, added.keyring);
+            if (account) {
+                const accounts = Object.values(internalAccounts.accounts);
+                // If it's the first account, we need to select it.
+                const lastSelected = accounts.length === 0 ? __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getLastSelectedIndex).call(this) : 0;
+                internalAccounts.accounts[account.id] = {
+                    ...account,
+                    metadata: {
+                        ...account.metadata,
+                        importTime: Date.now(),
+                        lastSelected,
+                    },
+                };
+                accountIdByAddress[account.address] = account.id;
+                diff.added.push(internalAccounts.accounts[account.id]);
             }
         }
     }, 
@@ -641,36 +668,6 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
             this.messenger.publish('AccountsController:selectedAccountChange', account);
         }
     }
-}, _AccountsController_handleOnSnapStateChange = function _AccountsController_handleOnSnapStateChange(snapState) {
-    // Only check if Snaps changed in status.
-    const { snaps } = snapState;
-    const accounts = [];
-    for (const account of this.listMultichainAccounts()) {
-        if (account.metadata.snap) {
-            const snap = snaps[account.metadata.snap.id];
-            if (snap) {
-                const enabled = snap.enabled && !snap.blocked;
-                const metadata = account.metadata.snap;
-                if (metadata.enabled !== enabled) {
-                    accounts.push({ id: account.id, enabled });
-                }
-            }
-            else {
-                // If Snap could not be found on the state, we consider it disabled.
-                accounts.push({ id: account.id, enabled: false });
-            }
-        }
-    }
-    if (accounts.length > 0) {
-        this.update((state) => {
-            for (const { id, enabled } of accounts) {
-                const account = state.internalAccounts.accounts[id];
-                if (account.metadata.snap) {
-                    account.metadata.snap.enabled = enabled;
-                }
-            }
-        });
-    }
 }, _AccountsController_getLastSelectedAccount = function _AccountsController_getLastSelectedAccount(accounts) {
     const [accountToSelect] = accounts.sort((accountA, accountB) => {
         // sort by lastSelected descending
@@ -683,15 +680,16 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     // will always be higher than any already selected account index.
     return Date.now();
 }, _AccountsController_getInternalAccountFromAddressAndType = function _AccountsController_getInternalAccountFromAddressAndType(address, keyring) {
-    if ((0, utils_2.isSnapKeyringType)(keyring.type)) {
-        const snapKeyring = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getSnapKeyring).call(this);
-        // We need the Snap keyring to retrieve the account from its address.
-        if (!snapKeyring) {
-            return undefined;
+    const isSnapKeyringV1 = (0, utils_2.isSnapKeyringType)(keyring.type);
+    const isSnapKeyringV2 = (0, utils_2.isSnapKeyringV2Type)(keyring.type);
+    if (isSnapKeyringV1 || isSnapKeyringV2) {
+        let account;
+        if (isSnapKeyringV1) {
+            account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountFromSnapKeyringV1).call(this, address);
+        }
+        else {
+            account = __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_getAccountFromSnapKeyringV2).call(this, address);
         }
-        // This might be undefined if the Snap deleted the account before
-        // reaching that point.
-        let account = snapKeyring.getAccountByAddress(address);
         if (account) {
             // We force the copy here, to avoid mutating the reference returned by the Snap keyring.
             account = (0, lodash_1.cloneDeep)(account);
@@ -741,7 +739,6 @@ _AccountsController_instances = new WeakSet(), _AccountsController_getAccountExp
     });
     // DO NOT publish AccountsController:setSelectedAccount to prevent circular listener loops
 }, _AccountsController_subscribeToMessageEvents = function _AccountsController_subscribeToMessageEvents() {
-    this.messenger.subscribe('SnapController:stateChange', (snapStateState) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnSnapStateChange).call(this, snapStateState));
     this.messenger.subscribe('KeyringController:stateChange', (keyringState) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnKeyringStateChange).call(this, keyringState));
     this.messenger.subscribe('SnapKeyring:accountAssetListUpdated', (snapAccountEvent) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnSnapKeyringAccountEvent).call(this, 'AccountsController:accountAssetListUpdated', snapAccountEvent));
     this.messenger.subscribe('SnapKeyring:accountBalancesUpdated', (snapAccountEvent) => __classPrivateFieldGet(this, _AccountsController_instances, "m", _AccountsController_handleOnSnapKeyringAccountEvent).call(this, 'AccountsController:accountBalancesUpdated', snapAccountEvent));