@metamask-previews/account-tree-controller 1.5.0-preview-3fb593f6 → 1.5.0-preview-53e28985

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Bump `@metamask/base-controller` from `^8.4.1` to `^8.4.2` ([#6917](https://github.com/MetaMask/core/pull/6917))
+
 ## [1.5.0]
 
 ### Changed

package/dist/AccountTreeController.cjs

@@ -10,10 +10,11 @@ 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 _AccountTreeController_instances, _AccountTreeController_accountIdToContext, _AccountTreeController_groupIdToWalletId, _AccountTreeController_backupAndSyncService, _AccountTreeController_rules, _AccountTreeController_trace, _AccountTreeController_backupAndSyncConfig, _AccountTreeController_initialized, _AccountTreeController_getEntropyRule, _AccountTreeController_getSnapRule, _AccountTreeController_getKeyringRule, _AccountTreeController_applyAccountWalletMetadata, _AccountTreeController_getRuleForWallet, _AccountTreeController_getComputedAccountGroupName, _AccountTreeController_getDefaultAccountGroupName, _AccountTreeController_applyAccountGroupMetadata, _AccountTreeController_handleAccountAdded, _AccountTreeController_handleAccountRemoved, _AccountTreeController_pruneEmptyGroupAndWallet, _AccountTreeController_insert, _AccountTreeController_listAccounts, _AccountTreeController_assertAccountGroupExists, _AccountTreeController_assertAccountWalletExists, _AccountTreeController_assertAccountGroupNameIsUnique, _AccountTreeController_getDefaultSelectedAccountGroup, _AccountTreeController_handleSelectedAccountChange, _AccountTreeController_handleMultichainAccountWalletStatusChange, _AccountTreeController_getAccountGroup, _AccountTreeController_getDefaultAccountFromAccountGroupId, _AccountTreeController_getDefaultAccountGroupId, _AccountTreeController_registerMessageHandlers, _AccountTreeController_createBackupAndSyncContext;
+var _AccountTreeController_instances, _AccountTreeController_accountIdToContext, _AccountTreeController_groupIdToWalletId, _AccountTreeController_backupAndSyncService, _AccountTreeController_rules, _AccountTreeController_trace, _AccountTreeController_backupAndSyncConfig, _AccountTreeController_initialized, _AccountTreeController_getEntropyRule, _AccountTreeController_getSnapRule, _AccountTreeController_getKeyringRule, _AccountTreeController_applyAccountWalletMetadata, _AccountTreeController_getRuleForWallet, _AccountTreeController_getComputedAccountGroupName, _AccountTreeController_getDefaultAccountGroupName, _AccountTreeController_applyAccountGroupMetadata, _AccountTreeController_handleAccountAdded, _AccountTreeController_handleAccountRemoved, _AccountTreeController_pruneEmptyGroupAndWallet, _AccountTreeController_sortAccountsOfGroup, _AccountTreeController_insertAccount, _AccountTreeController_insertOrUpdateMultichainAccountWalletAndGroup, _AccountTreeController_getMultichainAccountWallets, _AccountTreeController_listAccounts, _AccountTreeController_assertAccountGroupExists, _AccountTreeController_assertAccountWalletExists, _AccountTreeController_assertAccountGroupNameIsUnique, _AccountTreeController_getDefaultSelectedAccountGroup, _AccountTreeController_handleSelectedAccountChange, _AccountTreeController_handleMultichainAccountGroupCreatedOrUpdated, _AccountTreeController_handleMultichainAccountWalletStatusChange, _AccountTreeController_getAccountGroup, _AccountTreeController_getDefaultAccountFromAccountGroupId, _AccountTreeController_getDefaultAccountGroupId, _AccountTreeController_registerMessageHandlers, _AccountTreeController_createBackupAndSyncContext;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountTreeController = exports.getDefaultAccountTreeControllerState = exports.controllerName = void 0;
 const account_api_1 = require("@metamask/account-api");
+const account_api_2 = require("@metamask/account-api");
 const base_controller_1 = require("@metamask/base-controller");
 const keyring_api_1 = require("@metamask/keyring-api");
 const utils_1 = require("@metamask/utils");
@@ -143,6 +144,12 @@ class AccountTreeController extends base_controller_1.BaseController {
         this.messagingSystem.subscribe('UserStorageController:stateChange', (userStorageControllerState) => {
             __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").handleUserStorageStateChange(userStorageControllerState);
         });
+        this.messagingSystem.subscribe('MultichainAccountService:multichainAccountGroupCreated', (group) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleMultichainAccountGroupCreatedOrUpdated).call(this, group);
+        });
+        this.messagingSystem.subscribe('MultichainAccountService:multichainAccountGroupUpdated', (group) => {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleMultichainAccountGroupCreatedOrUpdated).call(this, group);
+        });
         this.messagingSystem.subscribe('MultichainAccountService:walletStatusChange', (walletId, status) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleMultichainAccountWalletStatusChange).call(this, walletId, status);
         });
@@ -162,6 +169,7 @@ class AccountTreeController extends base_controller_1.BaseController {
             return;
         }
         (0, logger_1.projectLogger)('Initializing...');
+        // For now, we always re-compute all wallets, we do not re-use the existing state.
         const wallets = {};
         // Clear mappings for fresh rebuild.
         __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").clear();
@@ -169,6 +177,12 @@ class AccountTreeController extends base_controller_1.BaseController {
         // Keep the current selected group to check if it's still part of the tree
         // after rebuilding it.
         const previousSelectedAccountGroup = this.state.accountTree.selectedAccountGroup;
+        // Insert all multichain account wallet/groups.
+        for (const wallet of __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getMultichainAccountWallets).call(this)) {
+            for (const group of wallet.getMultichainAccountGroups()) {
+                __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insertOrUpdateMultichainAccountWalletAndGroup).call(this, wallets, wallet, group);
+            }
+        }
         // There's no guarantee that accounts would be sorted by their import time
         // with `listMultichainAccounts`. We have to sort them here before constructing
         // the tree.
@@ -181,9 +195,9 @@ class AccountTreeController extends base_controller_1.BaseController {
         // won't be enough and we would have to use group properties instead (like group
         // index or maybe introduce a `importTime` at group level).
         const accounts = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_listAccounts).call(this).sort((a, b) => a.metadata.importTime - b.metadata.importTime);
-        // For now, we always re-compute all wallets, we do not re-use the existing state.
+        // Insert all other kind of accounts (private keys, HW, other Snap accounts, etc.).
         for (const account of accounts) {
-            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, wallets, account);
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insertAccount).call(this, wallets, account);
         }
         // Once we have the account tree, we can apply persisted metadata (names + UI states).
         let previousSelectedAccountGroupStillExists = false;
@@ -721,10 +735,15 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     if (!__classPrivateFieldGet(this, _AccountTreeController_initialized, "f")) {
         return;
     }
+    if ((0, account_api_1.isBip44Account)(account)) {
+        // We're skipping BIP-44 accounts since we rely on the `MultichainAccountService` to do
+        // the grouping of wallets/groups directly.
+        return;
+    }
     // Check if this account is already known by the tree to avoid double-insertion.
     if (!__classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").has(account.id)) {
         this.update((state) => {
-            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, state.accountTree.wallets, account);
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insertAccount).call(this, state.accountTree.wallets, account);
             const context = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(account.id);
             if (context) {
                 const { walletId, groupId } = context;
@@ -747,33 +766,39 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     const context = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(accountId);
     if (context) {
         const { walletId, groupId } = context;
-        const previousSelectedAccountGroup = this.state.accountTree.selectedAccountGroup;
-        let selectedAccountGroupChanged = false;
-        this.update((state) => {
-            const accounts = state.accountTree.wallets[walletId]?.groups[groupId]?.accounts;
-            if (accounts) {
-                const index = accounts.indexOf(accountId);
-                if (index !== -1) {
+        // If it's in the context, then `group` should be defined.
+        const group = this.state.accountTree.wallets[walletId]?.groups[groupId];
+        // We're only considering non-BIP-44 accounts for single account events.
+        if (group.type !== account_api_2.AccountGroupType.MultichainAccount) {
+            const index = group.accounts.indexOf(accountId);
+            if (index !== -1) {
+                let selectedAccountGroupChanged = false;
+                const previousSelectedAccountGroup = this.state.accountTree.selectedAccountGroup;
+                this.update((state) => {
+                    const accounts = state.accountTree.wallets[walletId]?.groups[groupId].accounts;
+                    // Effectively remove account from the group and state.
                     accounts.splice(index, 1);
-                    // Check if we need to update selectedAccountGroup after removal
-                    if (state.accountTree.selectedAccountGroup === groupId &&
-                        accounts.length === 0) {
-                        // The currently selected group is now empty, find a new group to select
-                        const newSelectedAccountGroup = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getDefaultAccountGroupId).call(this, state.accountTree.wallets);
-                        state.accountTree.selectedAccountGroup = newSelectedAccountGroup;
-                        selectedAccountGroupChanged =
-                            newSelectedAccountGroup !== previousSelectedAccountGroup;
+                    // If there's no more account, we have to prune the group and maybe select
+                    // a new account group too.
+                    if (accounts.length === 0) {
+                        // Check if we need to update selectedAccountGroup after removal
+                        if (state.accountTree.selectedAccountGroup === groupId) {
+                            // The currently selected group is now empty, find a new group to select
+                            const newSelectedAccountGroup = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getDefaultAccountGroupId).call(this, state.accountTree.wallets);
+                            state.accountTree.selectedAccountGroup =
+                                newSelectedAccountGroup;
+                            selectedAccountGroupChanged =
+                                newSelectedAccountGroup !== previousSelectedAccountGroup;
+                        }
+                        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_pruneEmptyGroupAndWallet).call(this, state, walletId, groupId);
                     }
-                }
-                if (accounts.length === 0) {
-                    __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_pruneEmptyGroupAndWallet).call(this, state, walletId, groupId);
+                });
+                this.messagingSystem.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
+                // Emit selectedAccountGroupChange event if the selected group changed
+                if (selectedAccountGroupChanged) {
+                    this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, this.state.accountTree.selectedAccountGroup, previousSelectedAccountGroup);
                 }
             }
-        });
-        this.messagingSystem.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
-        // Emit selectedAccountGroupChange event if the selected group changed
-        if (selectedAccountGroupChanged) {
-            this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, this.state.accountTree.selectedAccountGroup, previousSelectedAccountGroup);
         }
         // Clear reverse-mapping for that account.
         __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").delete(accountId);
@@ -790,9 +815,25 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         delete state.accountWalletsMetadata[walletId];
     }
     return state;
-}, _AccountTreeController_insert = function _AccountTreeController_insert(wallets, account) {
-    const result = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getEntropyRule).call(this).match(account) ??
-        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getSnapRule).call(this).match(account) ??
+}, _AccountTreeController_sortAccountsOfGroup = function _AccountTreeController_sortAccountsOfGroup(group) {
+    group.accounts.sort(
+    /* istanbul ignore next: Comparator branch execution (a===id vs b===id)
+     * and return attribution vary across engines; final ordering is covered
+     * by behavior tests. Ignoring the entire comparator avoids flaky line
+     * coverage without reducing scenario coverage.
+     */
+    (a, b) => {
+        const aSortOrder = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(a)?.sortOrder;
+        const bSortOrder = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(b)?.sortOrder;
+        return (aSortOrder ?? group_1.MAX_SORT_ORDER) - (bSortOrder ?? group_1.MAX_SORT_ORDER);
+    });
+}, _AccountTreeController_insertAccount = function _AccountTreeController_insertAccount(wallets, account) {
+    if ((0, account_api_1.isBip44Account)(account)) {
+        // We're skipping BIP-44 accounts since we rely on the `MultichainAccountService` to do
+        // the grouping of wallets/groups directly.
+        return;
+    }
+    const result = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getSnapRule).call(this).match(account) ??
         __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_getKeyringRule).call(this).match(account); // This one cannot fail.
     // Update controller's state.
     const walletId = result.wallet.id;
@@ -811,10 +852,6 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
             // the union tag `result.wallet.type`.
         };
         wallet = wallets[walletId];
-        // Trigger atomic sync for new wallet (only for entropy wallets)
-        if (wallet.type === account_api_1.AccountWalletType.Entropy) {
-            __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").enqueueSingleWalletSync(walletId);
-        }
     }
     const groupId = result.group.id;
     let group = wallet.groups[groupId];
@@ -837,28 +874,9 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         group = wallet.groups[groupId];
         // Map group ID to its containing wallet ID for efficient direct access
         __classPrivateFieldGet(this, _AccountTreeController_groupIdToWalletId, "f").set(groupId, walletId);
-        // Trigger atomic sync for new group (only for entropy wallets)
-        if (wallet.type === account_api_1.AccountWalletType.Entropy) {
-            __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").enqueueSingleGroupSync(groupId);
-        }
     }
     else {
         group.accounts.push(id);
-        // We need to do this at every insertion because race conditions can happen
-        // during the account creation process where one provider completes before the other.
-        // The discovery process in the service can also lead to some accounts being created "out of order".
-        const { accounts } = group;
-        accounts.sort(
-        /* istanbul ignore next: Comparator branch execution (a===id vs b===id)
-         * and return attribution vary across engines; final ordering is covered
-         * by behavior tests. Ignoring the entire comparator avoids flaky line
-         * coverage without reducing scenario coverage.
-         */
-        (a, b) => {
-            const aSortOrder = a === id ? sortOrder : __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(a)?.sortOrder;
-            const bSortOrder = b === id ? sortOrder : __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(b)?.sortOrder;
-            return ((aSortOrder ?? group_1.MAX_SORT_ORDER) - (bSortOrder ?? group_1.MAX_SORT_ORDER));
-        });
     }
     (0, logger_1.projectLogger)(`[${groupId}] Add new account: { id: "${account.id}", type: "${account.type}", address: "${account.address}"`);
     // Update the reverse mapping for this account.
@@ -867,6 +885,88 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         groupId: group.id,
         sortOrder,
     });
+    // We need to do this at every insertion because race conditions can happen
+    // during the account creation process where one provider completes before the other.
+    // The discovery process in the service can also lead to some accounts being created "out of order".
+    __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_sortAccountsOfGroup).call(this, group);
+}, _AccountTreeController_insertOrUpdateMultichainAccountWalletAndGroup = function _AccountTreeController_insertOrUpdateMultichainAccountWalletAndGroup(wallets, multichainAccountWallet, multichainAccountGroup) {
+    const walletId = multichainAccountWallet.id;
+    const groupId = multichainAccountGroup.id;
+    let wallet = null;
+    let group = null;
+    // Check type, mainly to infer proper wallet object type.
+    const walletObject = wallets[walletId];
+    if (walletObject && walletObject.type === account_api_1.AccountWalletType.Entropy) {
+        wallet = walletObject;
+        group = wallet.groups[groupId];
+    }
+    // We always re-use the account list from the group (if accounts get
+    // added/removed/re-ordered within the group).
+    const accounts = multichainAccountGroup.getAccounts();
+    const accountIds = accounts
+        // For now, we need this type-cast because `getAccounts` do not have the same
+        // type-constraint (uses string[] instead of [string; ...string])
+        .map((account) => account.id);
+    // Create the group object first, to inject it in the wallet in case this wallet is
+    // not part of the tree yet.
+    if (!group) {
+        group = {
+            id: multichainAccountGroup.id,
+            type: multichainAccountGroup.type,
+            accounts: accountIds,
+            metadata: {
+                entropy: {
+                    groupIndex: multichainAccountGroup.groupIndex,
+                },
+                name: '',
+                pinned: false,
+                hidden: false,
+            },
+        };
+    }
+    else {
+        group.accounts = accountIds;
+    }
+    if (!wallet) {
+        wallet = {
+            id: multichainAccountWallet.id,
+            type: multichainAccountWallet.type,
+            status: multichainAccountWallet.status,
+            groups: {
+                [group.id]: group,
+            },
+            metadata: {
+                entropy: {
+                    id: multichainAccountWallet.entropySource,
+                },
+                name: '', // Will get updated later.
+            },
+        };
+        wallets[walletId] = wallet;
+        // Trigger atomic sync for new wallet.
+        __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").enqueueSingleWalletSync(walletId);
+    }
+    else {
+        wallet.groups[group.id] = group;
+        // Trigger atomic sync for new group.
+        __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").enqueueSingleGroupSync(groupId);
+    }
+    // Map group ID to its containing wallet ID for efficient direct access
+    __classPrivateFieldGet(this, _AccountTreeController_groupIdToWalletId, "f").set(groupId, walletId);
+    // Update the reverse mapping for all accounts account.
+    for (const account of accounts) {
+        __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").set(account.id, {
+            walletId: wallet.id,
+            groupId: group.id,
+            sortOrder: group_1.ACCOUNT_TYPE_TO_SORT_ORDER[account.type] ?? group_1.MAX_SORT_ORDER,
+        });
+    }
+    // We need to do this at every insertion because race conditions can happen
+    // during the account creation process where one provider completes before the other.
+    // The discovery process in the service can also lead to some accounts being created "out of order".
+    __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_sortAccountsOfGroup).call(this, group);
+}, _AccountTreeController_getMultichainAccountWallets = function _AccountTreeController_getMultichainAccountWallets() {
+    return this.messagingSystem.call('MultichainAccountService:getMultichainAccountWallets');
 }, _AccountTreeController_listAccounts = function _AccountTreeController_listAccounts() {
     return this.messagingSystem.call('AccountsController:listMultichainAccounts');
 }, _AccountTreeController_assertAccountGroupExists = function _AccountTreeController_assertAccountGroupExists(groupId) {
@@ -911,6 +1011,19 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         state.accountTree.selectedAccountGroup = groupId;
     });
     this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, groupId, previousSelectedAccountGroup);
+}, _AccountTreeController_handleMultichainAccountGroupCreatedOrUpdated = function _AccountTreeController_handleMultichainAccountGroupCreatedOrUpdated(multichainAccountGroup) {
+    this.update((state) => {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insertOrUpdateMultichainAccountWalletAndGroup).call(this, state.accountTree.wallets, multichainAccountGroup.wallet, multichainAccountGroup);
+        const wallet = state.accountTree.wallets[multichainAccountGroup.wallet.id];
+        if (wallet) {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountWalletMetadata).call(this, state, wallet.id);
+            const group = wallet.groups[multichainAccountGroup.id];
+            if (group) {
+                __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountGroupMetadata).call(this, state, wallet.id, group.id);
+            }
+        }
+    });
+    this.messagingSystem.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
 }, _AccountTreeController_handleMultichainAccountWalletStatusChange = function _AccountTreeController_handleMultichainAccountWalletStatusChange(walletId, walletStatus) {
     this.update((state) => {
         const wallet = state.accountTree.wallets[walletId];