@metamask-previews/account-tree-controller 7.3.0-preview-c7e584108 → 7.3.0-preview-337abd924

package/CHANGELOG.md

@@ -7,9 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `AccountTreeController:accountGroup{Created,Updated,Removed}` events ([#8766](https://github.com/MetaMask/core/pull/8766))
+  - None of these events fire during `init`/`reinit`, consumers should bootstrap from `:getState` or `:accountTreeChange`.
+
 ### Changed
 
-- Bump `@metamask/accounts-controller` from `^38.0.0` to `^38.1.0` ([#8755](https://github.com/MetaMask/core/pull/8755))
+- Bump `@metamask/accounts-controller` from `^38.0.0` to `^38.1.1` ([#8755](https://github.com/MetaMask/core/pull/8755), [#8774](https://github.com/MetaMask/core/pull/8774))
 
 ## [7.3.0]
 

package/dist/AccountTreeController.cjs

@@ -10,7 +10,7 @@ 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_accountOrderCallbacks, _AccountTreeController_initialized, _AccountTreeController_initTreeContext, _AccountTreeController_getEntropyRule, _AccountTreeController_getSnapRule, _AccountTreeController_getKeyringRule, _AccountTreeController_applyAccountWalletMetadata, _AccountTreeController_getRuleForWallet, _AccountTreeController_getComputedAccountGroupName, _AccountTreeController_getDefaultAccountGroupName, _AccountTreeController_applyAccountGroupMetadata, _AccountTreeController_handleAccountsAdded, _AccountTreeController_handleAccountsRemoved, _AccountTreeController_pruneEmptyGroupAndWallet, _AccountTreeController_insert, _AccountTreeController_listAccounts, _AccountTreeController_assertAccountGroupExists, _AccountTreeController_assertAccountWalletExists, _AccountTreeController_assertAccountGroupNameIsUnique, _AccountTreeController_setSelectedAccountGroup, _AccountTreeController_getDefaultSelectedAccountGroup, _AccountTreeController_handleSelectedAccountChange, _AccountTreeController_handleMultichainAccountWalletStatusChange, _AccountTreeController_getAccountGroup, _AccountTreeController_getDefaultAccountFromAccountGroupId, _AccountTreeController_getDefaultAccountGroupId, _AccountTreeController_hasEvmAccount, _AccountTreeController_resolveNameConflict, _AccountTreeController_createBackupAndSyncContext;
+var _AccountTreeController_instances, _AccountTreeController_accountIdToContext, _AccountTreeController_groupIdToWalletId, _AccountTreeController_backupAndSyncService, _AccountTreeController_rules, _AccountTreeController_trace, _AccountTreeController_backupAndSyncConfig, _AccountTreeController_accountOrderCallbacks, _AccountTreeController_initialized, _AccountTreeController_initTreeContext, _AccountTreeController_getEntropyRule, _AccountTreeController_getSnapRule, _AccountTreeController_getKeyringRule, _AccountTreeController_applyAccountWalletMetadata, _AccountTreeController_getRuleForWallet, _AccountTreeController_getComputedAccountGroupName, _AccountTreeController_getDefaultAccountGroupName, _AccountTreeController_applyAccountGroupMetadata, _AccountTreeController_handleAccountsAdded, _AccountTreeController_handleAccountsRemoved, _AccountTreeController_pruneEmptyGroupAndWallet, _AccountTreeController_publishAccountGroupCreated, _AccountTreeController_publishAccountGroupUpdated, _AccountTreeController_publishAccountGroupRemoved, _AccountTreeController_insert, _AccountTreeController_listAccounts, _AccountTreeController_assertAccountGroupExists, _AccountTreeController_assertAccountWalletExists, _AccountTreeController_assertAccountGroupNameIsUnique, _AccountTreeController_setSelectedAccountGroup, _AccountTreeController_getDefaultSelectedAccountGroup, _AccountTreeController_handleSelectedAccountChange, _AccountTreeController_handleMultichainAccountWalletStatusChange, _AccountTreeController_getAccountGroup, _AccountTreeController_getDefaultAccountFromAccountGroupId, _AccountTreeController_getDefaultAccountGroupId, _AccountTreeController_hasEvmAccount, _AccountTreeController_resolveNameConflict, _AccountTreeController_createBackupAndSyncContext;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountTreeController = exports.getDefaultAccountTreeControllerState = exports.controllerName = void 0;
 const account_api_1 = require("@metamask/account-api");
@@ -410,6 +410,7 @@ class AccountTreeController extends base_controller_1.BaseController {
             state.accountTree.wallets[walletId].groups[groupId].metadata.name =
                 finalName;
         });
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupUpdated).call(this, walletId, groupId);
         // Trigger atomic sync for group rename (only for groups from entropy wallets)
         if (wallet.type === account_api_1.AccountWalletType.Entropy) {
             __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").enqueueSingleGroupSync(groupId);
@@ -469,6 +470,9 @@ class AccountTreeController extends base_controller_1.BaseController {
                     pinned;
             }
         });
+        if (walletId) {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupUpdated).call(this, walletId, groupId);
+        }
         // Trigger atomic sync for group pinning (only for groups from entropy wallets)
         if (walletId &&
             this.state.accountTree.wallets[walletId].type ===
@@ -503,6 +507,9 @@ class AccountTreeController extends base_controller_1.BaseController {
                     hidden;
             }
         });
+        if (walletId) {
+            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupUpdated).call(this, walletId, groupId);
+        }
         // Trigger atomic sync for group hiding (only for groups from entropy wallets)
         if (walletId &&
             this.state.accountTree.wallets[walletId].type ===
@@ -786,21 +793,37 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     if (newAccounts.length === 0) {
         return;
     }
+    const createdGroups = new Map();
+    const updatedGroups = new Map();
     this.update((state) => {
         for (const account of newAccounts) {
-            __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, state.accountTree.wallets, account);
-            const context = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(account.id);
-            if (context) {
-                const { walletId, groupId } = context;
-                const wallet = state.accountTree.wallets[walletId];
-                if (wallet) {
-                    __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountWalletMetadata).call(this, state, walletId);
-                    __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountGroupMetadata).call(this, state, walletId, groupId);
-                }
+            const { walletId, groupId, created } = __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_insert).call(this, state.accountTree.wallets, account);
+            if (created) {
+                createdGroups.set(groupId, walletId);
+            }
+            else if (!createdGroups.has(groupId)) {
+                // ^ We check that the group has not been created in this same batch before adding it to the `updatedGroups`
+                // map, to avoid sending both created and updated events for the same group:
+                // - Account 1 + Account 2 + Account 3
+                // - Account 1 and 3 belong to the same group
+                // - Account 1 will create the group
+                // - Account 3 will update the group (but we only want to send a created event, not an updated one)
+                updatedGroups.set(groupId, walletId);
+            }
+            const wallet = state.accountTree.wallets[walletId];
+            if (wallet) {
+                __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountWalletMetadata).call(this, state, walletId);
+                __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_applyAccountGroupMetadata).call(this, state, walletId, groupId);
             }
         }
     });
     this.messenger.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
+    for (const [groupId, walletId] of createdGroups) {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupCreated).call(this, walletId, groupId);
+    }
+    for (const [groupId, walletId] of updatedGroups) {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupUpdated).call(this, walletId, groupId);
+    }
 }, _AccountTreeController_handleAccountsRemoved = function _AccountTreeController_handleAccountsRemoved(accountIds) {
     // We wait for the first `init` to be called to actually build up the tree and
     // mutate it. We expect the caller to first update the `AccountsController` state
@@ -819,6 +842,8 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         return;
     }
     const previousSelectedAccountGroup = this.state.selectedAccountGroup;
+    const updatedGroups = new Map();
+    const removedGroups = new Set();
     this.update((state) => {
         for (const { id: accountId, context } of knownAccounts) {
             const { walletId, groupId } = context;
@@ -834,6 +859,12 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
                 }
                 if (accounts.length === 0) {
                     __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_pruneEmptyGroupAndWallet).call(this, state, walletId, groupId);
+                    // If the group gets pruned, we should not consider it as updated.
+                    updatedGroups.delete(groupId);
+                    removedGroups.add(groupId);
+                }
+                else {
+                    updatedGroups.set(groupId, walletId);
                 }
             }
         }
@@ -843,6 +874,12 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").delete(id);
     }
     this.messenger.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
+    for (const [groupId, walletId] of updatedGroups) {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupUpdated).call(this, walletId, groupId);
+    }
+    for (const groupId of removedGroups) {
+        __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_publishAccountGroupRemoved).call(this, groupId);
+    }
     const newSelectedAccountGroup = this.state.selectedAccountGroup;
     if (newSelectedAccountGroup !== previousSelectedAccountGroup) {
         this.messenger.publish(`${exports.controllerName}:selectedAccountGroupChange`, newSelectedAccountGroup, previousSelectedAccountGroup);
@@ -859,6 +896,18 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         delete state.accountWalletsMetadata[walletId];
     }
     return state;
+}, _AccountTreeController_publishAccountGroupCreated = function _AccountTreeController_publishAccountGroupCreated(walletId, groupId) {
+    const group = this.state.accountTree.wallets[walletId]?.groups[groupId];
+    if (group) {
+        this.messenger.publish(`${exports.controllerName}:accountGroupCreated`, group);
+    }
+}, _AccountTreeController_publishAccountGroupUpdated = function _AccountTreeController_publishAccountGroupUpdated(walletId, groupId) {
+    const group = this.state.accountTree.wallets[walletId]?.groups[groupId];
+    if (group) {
+        this.messenger.publish(`${exports.controllerName}:accountGroupUpdated`, group);
+    }
+}, _AccountTreeController_publishAccountGroupRemoved = function _AccountTreeController_publishAccountGroupRemoved(groupId) {
+    this.messenger.publish(`${exports.controllerName}:accountGroupRemoved`, groupId);
 }, _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) ??
@@ -889,6 +938,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     let group = wallet.groups[groupId];
     const { type, id } = account;
     const sortOrder = group_1.ACCOUNT_TYPE_TO_SORT_ORDER[type];
+    const created = !group;
     if (!group) {
         (0, logger_1.projectLogger)(`[${walletId}] Add new group: [${groupId}]`);
         wallet.groups[groupId] = {
@@ -936,6 +986,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         groupId: group.id,
         sortOrder,
     });
+    return { walletId: wallet.id, groupId: group.id, created };
 }, _AccountTreeController_listAccounts = function _AccountTreeController_listAccounts() {
     return this.messenger.call('AccountsController:listMultichainAccounts');
 }, _AccountTreeController_assertAccountGroupExists = function _AccountTreeController_assertAccountGroupExists(groupId) {