Merge branch 'main' into feat/check-against-urls-with-path

Author: imblue-dabadee

README.md

@@ -100,7 +100,7 @@ linkStyle default opacity:0.5
   controller_utils(["@metamask/controller-utils"]);
   delegation_controller(["@metamask/delegation-controller"]);
   earn_controller(["@metamask/earn-controller"]);
-  eip-5792-middleware(["@metamask/eip-5792-middleware"])
+  eip_5792_middleware(["@metamask/eip-5792-middleware"]);
   eip1193_permission_middleware(["@metamask/eip1193-permission-middleware"]);
   ens_controller(["@metamask/ens-controller"]);
   error_reporting_service(["@metamask/error-reporting-service"]);
@@ -142,6 +142,8 @@ linkStyle default opacity:0.5
   account_tree_controller --> base_controller;
   account_tree_controller --> accounts_controller;
   account_tree_controller --> keyring_controller;
+  account_tree_controller --> multichain_account_service;
+  account_tree_controller --> profile_sync_controller;
   accounts_controller --> base_controller;
   accounts_controller --> controller_utils;
   accounts_controller --> keyring_controller;
@@ -154,14 +156,17 @@ linkStyle default opacity:0.5
   assets_controllers --> base_controller;
   assets_controllers --> controller_utils;
   assets_controllers --> polling_controller;
+  assets_controllers --> account_tree_controller;
   assets_controllers --> accounts_controller;
   assets_controllers --> approval_controller;
   assets_controllers --> keyring_controller;
+  assets_controllers --> multichain_account_service;
   assets_controllers --> network_controller;
   assets_controllers --> permission_controller;
   assets_controllers --> phishing_controller;
   assets_controllers --> preferences_controller;
   assets_controllers --> transaction_controller;
+  base_controller --> messenger;
   base_controller --> json_rpc_engine;
   bridge_controller --> base_controller;
   bridge_controller --> controller_utils;
@@ -192,9 +197,11 @@ linkStyle default opacity:0.5
   delegation_controller --> keyring_controller;
   earn_controller --> base_controller;
   earn_controller --> controller_utils;
-  earn_controller --> accounts_controller;
+  earn_controller --> account_tree_controller;
   earn_controller --> network_controller;
   earn_controller --> transaction_controller;
+  eip_5792_middleware --> transaction_controller;
+  eip_5792_middleware --> keyring_controller;
   eip1193_permission_middleware --> chain_agnostic_permission;
   eip1193_permission_middleware --> controller_utils;
   eip1193_permission_middleware --> json_rpc_engine;
@@ -244,6 +251,7 @@ linkStyle default opacity:0.5
   network_enablement_controller --> controller_utils;
   network_enablement_controller --> multichain_network_controller;
   network_enablement_controller --> network_controller;
+  network_enablement_controller --> transaction_controller;
   notification_services_controller --> base_controller;
   notification_services_controller --> controller_utils;
   notification_services_controller --> keyring_controller;
@@ -263,7 +271,7 @@ linkStyle default opacity:0.5
   preferences_controller --> controller_utils;
   preferences_controller --> keyring_controller;
   profile_sync_controller --> base_controller;
-  profile_sync_controller --> accounts_controller;
+  profile_sync_controller --> address_book_controller;
   profile_sync_controller --> keyring_controller;
   rate_limit_controller --> base_controller;
   remote_feature_flag_controller --> base_controller;
@@ -277,13 +285,19 @@ linkStyle default opacity:0.5
   selected_network_controller --> json_rpc_engine;
   selected_network_controller --> network_controller;
   selected_network_controller --> permission_controller;
+  shield_controller --> base_controller;
+  shield_controller --> signature_controller;
+  shield_controller --> transaction_controller;
   signature_controller --> base_controller;
   signature_controller --> controller_utils;
   signature_controller --> accounts_controller;
   signature_controller --> approval_controller;
   signature_controller --> keyring_controller;
   signature_controller --> logging_controller;
   signature_controller --> network_controller;
+  subscription_controller --> base_controller;
+  subscription_controller --> controller_utils;
+  subscription_controller --> profile_sync_controller;
   token_search_discovery_controller --> base_controller;
   transaction_controller --> base_controller;
   transaction_controller --> controller_utils;

docs/controller-guidelines.md

@@ -116,19 +116,27 @@ A variable named `${controllerName}Metadata` should be defined (there is no need
 ```typescript
 const keyringControllerMetadata = {
   vault: {
+    // We don't want to include this in state logs because it contains sensitive key material.
+    includeInStateLogs: false,
     // We want to persist this property so it's restored automatically, as we
     // cannot reconstruct it otherwise.
     persist: true,
     // This property can be used to identify a user, so we want to make sure we
     // do not include it in Sentry.
     anonymous: false,
+    // This property is only used in the controller, not in the UI.
+    usedInUi: false,
   },
   isUnlocked: {
+    // This value is not sensitive, and is useful for diagnosing errors reported through support.
+    includeInStateLogs: true
     // We do not need to persist this property in state, as we want to
     // initialize state with the wallet unlocked.
     persist: false,
     // This property has no PII, so it is safe to send to Sentry.
     anonymous: true,
+    // This is used in the UI
+    usedInUi: true,
   },
 };
 

eslint-warning-thresholds.json

@@ -107,10 +107,10 @@
     "jsdoc/tag-lines": 2
   },
   "packages/base-controller/src/BaseController.test.ts": {
-    "import-x/namespace": 18
+    "import-x/namespace": 15
   },
   "packages/base-controller/src/next/BaseController.test.ts": {
-    "import-x/namespace": 18
+    "import-x/namespace": 13
   },
   "packages/build-utils/src/transforms/remove-fenced-code.test.ts": {
     "import-x/order": 1
@@ -328,8 +328,7 @@
   },
   "packages/remote-feature-flag-controller/src/remote-feature-flag-controller.ts": {
     "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/check-tag-names": 2,
-    "prettier/prettier": 1
+    "jsdoc/check-tag-names": 2
   },
   "packages/remote-feature-flag-controller/src/utils/user-segmentation-utils.ts": {
     "jsdoc/tag-lines": 2

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/core-monorepo",
-  "version": "549.0.0",
+  "version": "564.0.0",
   "private": true,
   "description": "Monorepo for packages shared between MetaMask clients",
   "repository": {

packages/account-tree-controller/CHANGELOG.md

@@ -7,9 +7,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.17.0]
+
+### Changed
+
+- Single group sync events will not get enqueued anymore if a full sync is in progress ([#6651](https://github.com/MetaMask/core/pull/6651))
+  - This prevents too many unnecessary storage fetches (which would prevent being rate limited).
+  - This could rarely lead to inconsistencies until the next single updates or next full sync.
+
+## [0.16.1]
+
+### Added
+
+- Export user storage paths for account syncing ([#6643](https://github.com/MetaMask/core/pull/6643))
+
+### Changed
+
+- Swallow group creation errors in backup and sync `createMultichainAccountGroup` ([#6642](https://github.com/MetaMask/core/pull/6642))
+
+### Removed
+
+- Remove full sync triggers when single sync operations are enqueued and `hasSyncedAtLeastOnce` is `false` ([#6634](https://github.com/MetaMask/core/pull/6634))
+
+## [0.16.0]
+
 ### Changed
 
+- **BREAKING:** Use `:getSelectedMultichainAccount` instead of `:getSelectedAccount` to compute currently selected account group ([#6608](https://github.com/MetaMask/core/pull/6608))
+  - Coming from the old account model, a non-EVM account could have been selected and the lastly selected EVM account might not be using the same group index.
 - Bump `@metamask/utils` from `^11.4.2` to `^11.8.0` ([#6588](https://github.com/MetaMask/core/pull/6588))
+- Bump `@metamask/base-controller` from `^8.3.0` to `^8.4.0` ([#6632](https://github.com/MetaMask/core/pull/6632))
+
+### Removed
+
+- Remove use of `:getSelectedAccount` action ([#6608](https://github.com/MetaMask/core/pull/6608))
 
 ## [0.15.1]
 
@@ -232,7 +263,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial release ([#5847](https://github.com/MetaMask/core/pull/5847))
   - Grouping accounts into 3 main categories: Entropy source, Snap ID, keyring types.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
+[0.17.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
+[0.16.1]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
+[0.16.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.15.1]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.15.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
 [0.14.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]

packages/account-tree-controller/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/account-tree-controller",
-  "version": "0.15.1",
+  "version": "0.17.0",
   "description": "Controller to group account together based on some pre-defined rules",
   "keywords": [
     "MetaMask",
@@ -47,7 +47,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.3.0",
+    "@metamask/base-controller": "^8.4.0",
     "@metamask/snaps-sdk": "^9.0.0",
     "@metamask/snaps-utils": "^11.0.0",
     "@metamask/superstruct": "^3.1.0",
@@ -61,7 +61,7 @@
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/keyring-api": "^21.0.0",
     "@metamask/keyring-controller": "^23.1.0",
-    "@metamask/multichain-account-service": "^0.8.0",
+    "@metamask/multichain-account-service": "^0.10.0",
     "@metamask/profile-sync-controller": "^25.0.0",
     "@metamask/providers": "^22.1.0",
     "@metamask/snaps-controllers": "^14.0.1",

packages/account-tree-controller/src/AccountTreeController.test.ts

@@ -229,7 +229,7 @@ function getAccountTreeControllerMessenger(
     allowedActions: [
       'AccountsController:listMultichainAccounts',
       'AccountsController:getAccount',
-      'AccountsController:getSelectedAccount',
+      'AccountsController:getSelectedMultichainAccount',
       'AccountsController:setSelectedAccount',
       'UserStorageController:getState',
       'UserStorageController:performGetStorage',
@@ -305,7 +305,7 @@ function setup({
     AccountsController: {
       accounts: InternalAccount[];
       listMultichainAccounts: jest.Mock;
-      getSelectedAccount: jest.Mock;
+      getSelectedMultichainAccount: jest.Mock;
       getAccount: jest.Mock;
     };
     UserStorageController: {
@@ -329,7 +329,7 @@ function setup({
       accounts,
       listMultichainAccounts: jest.fn(),
       getAccount: jest.fn(),
-      getSelectedAccount: jest.fn(),
+      getSelectedMultichainAccount: jest.fn(),
     },
     UserStorageController: {
       getState: jest.fn(),
@@ -366,13 +366,13 @@ function setup({
       mocks.AccountsController.getAccount,
     );
 
-    // Mock AccountsController:getSelectedAccount to return the first account
-    mocks.AccountsController.getSelectedAccount.mockImplementation(
+    // Mock AccountsController:getSelectedMultichainAccount to return the first account
+    mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
       () => accounts[0] || MOCK_HD_ACCOUNT_1,
     );
     messenger.registerActionHandler(
-      'AccountsController:getSelectedAccount',
-      mocks.AccountsController.getSelectedAccount,
+      'AccountsController:getSelectedMultichainAccount',
+      mocks.AccountsController.getSelectedMultichainAccount,
     );
 
     // Mock AccountsController:setSelectedAccount
@@ -750,7 +750,7 @@ describe('AccountTreeController', () => {
         keyrings: [MOCK_HD_KEYRING_1],
       });
 
-      mocks.AccountsController.getSelectedAccount.mockImplementation(
+      mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
         () => MOCK_HD_ACCOUNT_1,
       );
 
@@ -767,7 +767,7 @@ describe('AccountTreeController', () => {
 
       mocks.AccountsController.accounts = [MOCK_HD_ACCOUNT_2];
       mocks.KeyringController.keyrings = [MOCK_HD_KEYRING_2];
-      mocks.AccountsController.getSelectedAccount.mockImplementation(
+      mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
         () => MOCK_HD_ACCOUNT_2,
       );
 
@@ -1554,10 +1554,10 @@ describe('AccountTreeController', () => {
 
       // Unregister existing handler and register new one BEFORE init
       messenger.unregisterActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
       );
       messenger.registerActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
         () => EMPTY_ACCOUNT_MOCK,
       );
 
@@ -1581,17 +1581,17 @@ describe('AccountTreeController', () => {
         keyrings: [MOCK_HD_KEYRING_1, MOCK_HD_KEYRING_2],
       });
 
-      // Mock getSelectedAccount to return an account not in the tree BEFORE init
+      // Mock getSelectedMultichainAccount to return an account not in the tree BEFORE init
       const unknownAccount: InternalAccount = {
         ...MOCK_HD_ACCOUNT_1,
         id: 'unknown-account-id',
       };
 
       messenger.unregisterActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
       );
       messenger.registerActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
         () => unknownAccount,
       );
 
@@ -1609,18 +1609,18 @@ describe('AccountTreeController', () => {
       expect(controller.getSelectedAccountGroup()).toBe(expectedGroupId1);
     });
 
-    it('returns empty string when no wallets exist and getSelectedAccount returns EMPTY_ACCOUNT', () => {
+    it('returns empty string when no wallets exist and getSelectedMultichainAccount returns EMPTY_ACCOUNT', () => {
       const { controller, messenger } = setup({
         accounts: [],
         keyrings: [],
       });
 
-      // Mock getSelectedAccount to return EMPTY_ACCOUNT_MOCK (id is '') BEFORE init
+      // Mock getSelectedMultichainAccount to return EMPTY_ACCOUNT_MOCK (id is '') BEFORE init
       messenger.unregisterActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
       );
       messenger.registerActionHandler(
-        'AccountsController:getSelectedAccount',
+        'AccountsController:getSelectedMultichainAccount',
         () => EMPTY_ACCOUNT_MOCK,
       );
 
@@ -2813,7 +2813,7 @@ describe('AccountTreeController', () => {
         keyrings: [MOCK_HD_KEYRING_1],
       });
 
-      mocks.AccountsController.getSelectedAccount.mockImplementation(
+      mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
         () => MOCK_HD_ACCOUNT_1,
       );
 
@@ -2842,7 +2842,7 @@ describe('AccountTreeController', () => {
         keyrings: [MOCK_HD_KEYRING_1],
       });
 
-      mocks.AccountsController.getSelectedAccount.mockImplementation(
+      mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
         () => MOCK_HD_ACCOUNT_1,
       );
 
@@ -2865,7 +2865,7 @@ describe('AccountTreeController', () => {
 
       mocks.AccountsController.accounts = [MOCK_HD_ACCOUNT_2];
       mocks.KeyringController.keyrings = [MOCK_HD_KEYRING_2];
-      mocks.AccountsController.getSelectedAccount.mockImplementation(
+      mocks.AccountsController.getSelectedMultichainAccount.mockImplementation(
         () => MOCK_HD_ACCOUNT_2,
       );
 

packages/account-tree-controller/src/AccountTreeController.ts

@@ -828,7 +828,7 @@ export class AccountTreeController extends BaseController<
     [walletId: AccountWalletId]: AccountWalletObject;
   }): AccountGroupId | '' {
     const selectedAccount = this.messagingSystem.call(
-      'AccountsController:getSelectedAccount',
+      'AccountsController:getSelectedMultichainAccount',
     );
     if (selectedAccount && selectedAccount.id) {
       const accountMapping = this.#accountIdToContext.get(selectedAccount.id);