@metamask-previews/account-tree-controller 1.5.0-preview-887b5d5c → 1.5.0-preview-35a5c8a7

package/CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6380](https://github.com/MetaMask/core/pull/6380))
+  - Previously, `AccountTreeController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
 - Use non-EVM account names for group names ([#6831](https://github.com/MetaMask/core/pull/6831))
   - EVM accounts still take precedence over non-EVM accounts.
   - Before accounts get re-aligned, it is possible that a group contains only non-EVM accounts, in which case, the first non-EVM account name will be used for that account group.

package/dist/AccountTreeController.cjs

@@ -10,11 +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_accountOrderCallbacks, _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_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;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountTreeController = exports.getDefaultAccountTreeControllerState = exports.controllerName = void 0;
 const account_api_1 = require("@metamask/account-api");
-const base_controller_1 = require("@metamask/base-controller");
+const next_1 = require("@metamask/base-controller/next");
 const keyring_api_1 = require("@metamask/keyring-api");
 const utils_1 = require("@metamask/utils");
 const analytics_1 = require("./backup-and-sync/analytics/index.cjs");
@@ -29,31 +29,31 @@ const accountTreeControllerMetadata = {
     accountTree: {
         includeInStateLogs: true,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     isAccountTreeSyncingInProgress: {
         includeInStateLogs: false,
         persist: false,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     hasAccountTreeSyncingSyncedAtLeastOnce: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     accountGroupsMetadata: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     accountWalletsMetadata: {
         includeInStateLogs: true,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
 };
@@ -75,7 +75,7 @@ function getDefaultAccountTreeControllerState() {
     };
 }
 exports.getDefaultAccountTreeControllerState = getDefaultAccountTreeControllerState;
-class AccountTreeController extends base_controller_1.BaseController {
+class AccountTreeController extends next_1.BaseController {
     /**
      * Constructor for AccountTreeController.
      *
@@ -104,10 +104,6 @@ class AccountTreeController extends base_controller_1.BaseController {
         _AccountTreeController_rules.set(this, void 0);
         _AccountTreeController_trace.set(this, void 0);
         _AccountTreeController_backupAndSyncConfig.set(this, void 0);
-        /**
-         * Callbacks to migrate hidden and pinned account information from the account order controller
-         */
-        _AccountTreeController_accountOrderCallbacks.set(this, void 0);
         _AccountTreeController_initialized.set(this, void 0);
         // This will be set to true upon the first `init` call.
         __classPrivateFieldSet(this, _AccountTreeController_initialized, false, "f");
@@ -118,11 +114,11 @@ class AccountTreeController extends base_controller_1.BaseController {
         // Rules to apply to construct the wallets tree.
         __classPrivateFieldSet(this, _AccountTreeController_rules, [
             // 1. We group by entropy-source
-            new entropy_1.EntropyRule(this.messagingSystem),
+            new entropy_1.EntropyRule(this.messenger),
             // 2. We group by Snap ID
-            new snap_1.SnapRule(this.messagingSystem),
+            new snap_1.SnapRule(this.messenger),
             // 3. We group by wallet type (this rule cannot fail and will group all non-matching accounts)
-            new keyring_1.KeyringRule(this.messagingSystem),
+            new keyring_1.KeyringRule(this.messenger),
         ], "f");
         // Initialize trace function
         __classPrivateFieldSet(this, _AccountTreeController_trace, config?.trace ?? analytics_1.traceFallback, "f");
@@ -133,22 +129,21 @@ class AccountTreeController extends base_controller_1.BaseController {
                     config.backupAndSync.onBackupAndSyncEvent((0, analytics_1.formatAnalyticsEvent)(event)));
             },
         }, "f");
-        __classPrivateFieldSet(this, _AccountTreeController_accountOrderCallbacks, config?.accountOrderCallbacks, "f");
         // Initialize the backup and sync service
         __classPrivateFieldSet(this, _AccountTreeController_backupAndSyncService, new service_1.BackupAndSyncService(__classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_createBackupAndSyncContext).call(this)), "f");
-        this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => {
+        this.messenger.subscribe('AccountsController:accountAdded', (account) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountAdded).call(this, account);
         });
-        this.messagingSystem.subscribe('AccountsController:accountRemoved', (accountId) => {
+        this.messenger.subscribe('AccountsController:accountRemoved', (accountId) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleAccountRemoved).call(this, accountId);
         });
-        this.messagingSystem.subscribe('AccountsController:selectedAccountChange', (account) => {
+        this.messenger.subscribe('AccountsController:selectedAccountChange', (account) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleSelectedAccountChange).call(this, account);
         });
-        this.messagingSystem.subscribe('UserStorageController:stateChange', (userStorageControllerState) => {
+        this.messenger.subscribe('UserStorageController:stateChange', (userStorageControllerState) => {
             __classPrivateFieldGet(this, _AccountTreeController_backupAndSyncService, "f").handleUserStorageStateChange(userStorageControllerState);
         });
-        this.messagingSystem.subscribe('MultichainAccountService:walletStatusChange', (walletId, status) => {
+        this.messenger.subscribe('MultichainAccountService:walletStatusChange', (walletId, status) => {
             __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_handleMultichainAccountWalletStatusChange).call(this, walletId, status);
         });
         __classPrivateFieldGet(this, _AccountTreeController_instances, "m", _AccountTreeController_registerMessageHandlers).call(this);
@@ -237,7 +232,7 @@ class AccountTreeController extends base_controller_1.BaseController {
         if (previousSelectedAccountGroup !==
             this.state.accountTree.selectedAccountGroup) {
             (0, logger_1.projectLogger)(`Selected (initial) group is: [${this.state.accountTree.selectedAccountGroup}]`);
-            this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, this.state.accountTree.selectedAccountGroup, previousSelectedAccountGroup);
+            this.messenger.publish(`${exports.controllerName}:selectedAccountGroupChange`, this.state.accountTree.selectedAccountGroup, previousSelectedAccountGroup);
         }
         (0, logger_1.projectLogger)('Initialized!');
         __classPrivateFieldSet(this, _AccountTreeController_initialized, true, "f");
@@ -298,7 +293,7 @@ class AccountTreeController extends base_controller_1.BaseController {
         }
         const accounts = [];
         for (const id of group.accounts) {
-            const account = this.messagingSystem.call('AccountsController:getAccount', id);
+            const account = this.messenger.call('AccountsController:getAccount', id);
             // For now, we're filtering undefined account, but I believe
             // throwing would be more appropriate here.
             if (account) {
@@ -350,10 +345,10 @@ class AccountTreeController extends base_controller_1.BaseController {
             state.accountTree.selectedAccountGroup = groupId;
         });
         (0, logger_1.projectLogger)(`Selected group is now: [${this.state.accountTree.selectedAccountGroup}]`);
-        this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, groupId, previousSelectedAccountGroup);
+        this.messenger.publish(`${exports.controllerName}:selectedAccountGroupChange`, groupId, previousSelectedAccountGroup);
         // Update AccountsController - this will trigger selectedAccountChange event,
         // but our handler is idempotent so it won't cause infinite loop
-        this.messagingSystem.call('AccountsController:setSelectedAccount', accountToSelect);
+        this.messenger.call('AccountsController:setSelectedAccount', accountToSelect);
     }
     /**
      * Resolves name conflicts by adding a suffix to make the name unique.
@@ -560,7 +555,7 @@ class AccountTreeController extends base_controller_1.BaseController {
     }
 }
 exports.AccountTreeController = AccountTreeController;
-_AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeController_groupIdToWalletId = new WeakMap(), _AccountTreeController_backupAndSyncService = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_trace = new WeakMap(), _AccountTreeController_backupAndSyncConfig = new WeakMap(), _AccountTreeController_accountOrderCallbacks = new WeakMap(), _AccountTreeController_initialized = new WeakMap(), _AccountTreeController_instances = new WeakSet(), _AccountTreeController_getEntropyRule = function _AccountTreeController_getEntropyRule() {
+_AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeController_groupIdToWalletId = new WeakMap(), _AccountTreeController_backupAndSyncService = new WeakMap(), _AccountTreeController_rules = new WeakMap(), _AccountTreeController_trace = new WeakMap(), _AccountTreeController_backupAndSyncConfig = new WeakMap(), _AccountTreeController_initialized = new WeakMap(), _AccountTreeController_instances = new WeakSet(), _AccountTreeController_getEntropyRule = function _AccountTreeController_getEntropyRule() {
     return __classPrivateFieldGet(this, _AccountTreeController_rules, "f")[0];
 }, _AccountTreeController_getSnapRule = function _AccountTreeController_getSnapRule() {
     return __classPrivateFieldGet(this, _AccountTreeController_rules, "f")[1];
@@ -601,7 +596,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
 }, _AccountTreeController_getComputedAccountGroupName = function _AccountTreeController_getComputedAccountGroupName(wallet, group) {
     let proposedName = ''; // Empty means there's no computed name for this group.
     for (const id of group.accounts) {
-        const account = this.messagingSystem.call('AccountsController:getAccount', id);
+        const account = this.messenger.call('AccountsController:getAccount', id);
         if (!account || !account.metadata.name.length) {
             continue;
         }
@@ -716,23 +711,9 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     if (persistedGroupMetadata?.pinned?.value !== undefined) {
         group.metadata.pinned = persistedGroupMetadata.pinned.value;
     }
-    else if (__classPrivateFieldGet(this, _AccountTreeController_accountOrderCallbacks, "f")?.isPinnedAccount) {
-        // If any accounts was previously pinned, then we consider the group to be pinned as well.
-        group.metadata.pinned = Object.values(group.accounts).some((account) => __classPrivateFieldGet(this, _AccountTreeController_accountOrderCallbacks, "f")?.isPinnedAccount?.(account));
-    }
-    else {
-        group.metadata.pinned = false;
-    }
     if (persistedGroupMetadata?.hidden?.value !== undefined) {
         group.metadata.hidden = persistedGroupMetadata.hidden.value;
     }
-    else if (__classPrivateFieldGet(this, _AccountTreeController_accountOrderCallbacks, "f")?.isHiddenAccount) {
-        // If any accounts was previously hidden, then we consider the group to be hidden as well.
-        group.metadata.hidden = Object.values(group.accounts).some((account) => __classPrivateFieldGet(this, _AccountTreeController_accountOrderCallbacks, "f")?.isHiddenAccount?.(account));
-    }
-    else {
-        group.metadata.hidden = false;
-    }
 }, _AccountTreeController_handleAccountAdded = function _AccountTreeController_handleAccountAdded(account) {
     // 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
@@ -754,7 +735,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
                 }
             }
         });
-        this.messagingSystem.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
+        this.messenger.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
     }
 }, _AccountTreeController_handleAccountRemoved = function _AccountTreeController_handleAccountRemoved(accountId) {
     // We wait for the first `init` to be called to actually build up the tree and
@@ -789,10 +770,10 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
                 }
             }
         });
-        this.messagingSystem.publish(`${exports.controllerName}:accountTreeChange`, this.state.accountTree);
+        this.messenger.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.messenger.publish(`${exports.controllerName}:selectedAccountGroupChange`, this.state.accountTree.selectedAccountGroup, previousSelectedAccountGroup);
         }
         // Clear reverse-mapping for that account.
         __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").delete(accountId);
@@ -887,7 +868,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         sortOrder,
     });
 }, _AccountTreeController_listAccounts = function _AccountTreeController_listAccounts() {
-    return this.messagingSystem.call('AccountsController:listMultichainAccounts');
+    return this.messenger.call('AccountsController:listMultichainAccounts');
 }, _AccountTreeController_assertAccountGroupExists = function _AccountTreeController_assertAccountGroupExists(groupId) {
     const exists = __classPrivateFieldGet(this, _AccountTreeController_groupIdToWalletId, "f").has(groupId);
     if (!exists) {
@@ -903,7 +884,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
         throw new Error('Account group name already exists');
     }
 }, _AccountTreeController_getDefaultSelectedAccountGroup = function _AccountTreeController_getDefaultSelectedAccountGroup(wallets) {
-    const selectedAccount = this.messagingSystem.call('AccountsController:getSelectedMultichainAccount');
+    const selectedAccount = this.messenger.call('AccountsController:getSelectedMultichainAccount');
     if (selectedAccount && selectedAccount.id) {
         const accountMapping = __classPrivateFieldGet(this, _AccountTreeController_accountIdToContext, "f").get(selectedAccount.id);
         if (accountMapping) {
@@ -929,7 +910,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     this.update((state) => {
         state.accountTree.selectedAccountGroup = groupId;
     });
-    this.messagingSystem.publish(`${exports.controllerName}:selectedAccountGroupChange`, groupId, previousSelectedAccountGroup);
+    this.messenger.publish(`${exports.controllerName}:selectedAccountGroupChange`, groupId, previousSelectedAccountGroup);
 }, _AccountTreeController_handleMultichainAccountWalletStatusChange = function _AccountTreeController_handleMultichainAccountWalletStatusChange(walletId, walletStatus) {
     this.update((state) => {
         const wallet = state.accountTree.wallets[walletId];
@@ -945,7 +926,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     if (group) {
         let candidate;
         for (const id of group.accounts) {
-            const account = this.messagingSystem.call('AccountsController:getAccount', id);
+            const account = this.messenger.call('AccountsController:getAccount', id);
             if (!candidate) {
                 candidate = id;
             }
@@ -969,7 +950,7 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
                 candidate = group.id;
             }
             for (const id of group.accounts) {
-                const account = this.messagingSystem.call('AccountsController:getAccount', id);
+                const account = this.messenger.call('AccountsController:getAccount', id);
                 if (account && (0, keyring_api_1.isEvmAccountType)(account.type)) {
                     // EVM accounts have a higher priority, so if we find any, we just
                     // use that group!
@@ -980,18 +961,18 @@ _AccountTreeController_accountIdToContext = new WeakMap(), _AccountTreeControlle
     }
     return candidate;
 }, _AccountTreeController_registerMessageHandlers = function _AccountTreeController_registerMessageHandlers() {
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:getSelectedAccountGroup`, this.getSelectedAccountGroup.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:setSelectedAccountGroup`, this.setSelectedAccountGroup.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:getAccountsFromSelectedAccountGroup`, this.getAccountsFromSelectedAccountGroup.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:setAccountWalletName`, this.setAccountWalletName.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:setAccountGroupName`, this.setAccountGroupName.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:setAccountGroupPinned`, this.setAccountGroupPinned.bind(this));
-    this.messagingSystem.registerActionHandler(`${exports.controllerName}:setAccountGroupHidden`, this.setAccountGroupHidden.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:getSelectedAccountGroup`, this.getSelectedAccountGroup.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:setSelectedAccountGroup`, this.setSelectedAccountGroup.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:getAccountsFromSelectedAccountGroup`, this.getAccountsFromSelectedAccountGroup.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:setAccountWalletName`, this.setAccountWalletName.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:setAccountGroupName`, this.setAccountGroupName.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:setAccountGroupPinned`, this.setAccountGroupPinned.bind(this));
+    this.messenger.registerActionHandler(`${exports.controllerName}:setAccountGroupHidden`, this.setAccountGroupHidden.bind(this));
 }, _AccountTreeController_createBackupAndSyncContext = function _AccountTreeController_createBackupAndSyncContext() {
     return {
         ...__classPrivateFieldGet(this, _AccountTreeController_backupAndSyncConfig, "f"),
         controller: this,
-        messenger: this.messagingSystem,
+        messenger: this.messenger,
         controllerStateUpdateFn: this.update.bind(this),
         traceFn: __classPrivateFieldGet(this, _AccountTreeController_trace, "f").bind(this),
         groupIdToWalletId: __classPrivateFieldGet(this, _AccountTreeController_groupIdToWalletId, "f"),