feat(accounts-controller): Add entropySource to new InternalAccount (#5841)

## Explanation

`AccountsController:accountAdded` events were missing the
`.options.entropySource` property, causing account syncing to misbehave,
registering new accounts to the primary SRP instead of the actual SRP
used to add the account.

We now add the `entropySource` to these new `InternalAccount`s based on
the `keyring` that was used to create them.

## References
Relates to #5618
Relates to #5725
Relates to #5753

Author: mirceanis

packages/accounts-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Populate `.options.entropySource` for new `InternalAccount`s before publishing `:accountAdded` ([#5841](https://github.com/MetaMask/core/pull/5841))
+
 ## [29.0.0]
 
 ### Changed

packages/accounts-controller/src/AccountsController.test.ts

@@ -7,18 +7,18 @@ import type {
 } from '@metamask/keyring-api';
 import {
   BtcAccountType,
+  BtcScope,
   EthAccountType,
   EthScope,
-  BtcScope,
 } from '@metamask/keyring-api';
 import { KeyringTypes } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
 import type { NetworkClientId } from '@metamask/network-controller';
 import type { SnapControllerState } from '@metamask/snaps-controllers';
 import { SnapStatus } from '@metamask/snaps-utils';
 import type { CaipChainId } from '@metamask/utils';
-import * as uuid from 'uuid';
 import type { V4Options } from 'uuid';
+import * as uuid from 'uuid';
 
 import type {
   AccountsControllerActions,
@@ -180,6 +180,29 @@ function setLastSelectedAsAny(account: InternalAccount): InternalAccount {
   return deepClonedAccount;
 }
 
+/**
+ * Sets the `entropySource` property of the given `account` to the specified
+ * keyringId value.
+ *
+ * @param account - The account to modify.
+ * @param keyringId - The keyring ID to set as entropySource.
+ * @returns The modified account.
+ */
+function populateEntropySource(
+  account: InternalAccount,
+  keyringId: string,
+): InternalAccount {
+  return JSON.parse(
+    JSON.stringify({
+      ...account,
+      options: {
+        ...account.options,
+        entropySource: keyringId,
+      },
+    }),
+  ) as InternalAccount;
+}
+
 /**
  * Builds a new instance of the Messenger class for the AccountsController.
  *
@@ -621,7 +644,7 @@ describe('AccountsController', () => {
 
         expect(accounts).toStrictEqual([
           mockAccount,
-          setLastSelectedAsAny(mockAccount2),
+          setLastSelectedAsAny(populateEntropySource(mockAccount2, 'mock-id')),
         ]);
       });
 
@@ -876,6 +899,9 @@ describe('AccountsController', () => {
               name: 'Account 3',
               address: mockAccount3.address,
               keyringType: KeyringTypes.hd,
+              options: {
+                entropySource: 'mock-id',
+              },
             }),
           ),
         ]);
@@ -941,7 +967,9 @@ describe('AccountsController', () => {
             name: 'Account 3',
             address: mockAccount3.address,
             keyringType: KeyringTypes.hd,
-            options: {},
+            options: {
+              entropySource: 'mock-id',
+            },
           }),
         ]);
       });
@@ -1044,7 +1072,7 @@ describe('AccountsController', () => {
 
         expect(accounts).toStrictEqual([
           mockAccount,
-          setLastSelectedAsAny(mockAccount2),
+          setLastSelectedAsAny(populateEntropySource(mockAccount2, 'mock-id')),
         ]);
         expect(accountsController.getSelectedAccount().id).toBe(mockAccount.id);
       });
@@ -1093,7 +1121,7 @@ describe('AccountsController', () => {
           // 2. AccountsController:stateChange
           3,
           'AccountsController:accountAdded',
-          setLastSelectedAsAny(mockAccount2),
+          setLastSelectedAsAny(populateEntropySource(mockAccount2, 'mock-id')),
         );
       });
     });
@@ -1407,6 +1435,9 @@ describe('AccountsController', () => {
         name: 'Account 1',
         address: '0x456',
         keyringType: KeyringTypes.hd,
+        options: {
+          entropySource: 'mock-id',
+        },
       });
 
       mockUUIDWithNormalAccounts([

packages/accounts-controller/src/AccountsController.ts

@@ -791,6 +791,7 @@ export class AccountsController extends BaseController<
         added: [] as {
           address: string;
           type: string;
+          options: InternalAccount['options'];
         }[],
         updated: [] as InternalAccount[],
         removed: [] as InternalAccount[],
@@ -836,6 +837,11 @@ export class AccountsController extends BaseController<
           patch.added.push({
             address,
             type: keyring.type,
+            // Automatically injects `entropySource` for HD accounts only.
+            options:
+              keyring.type === KeyringTypes.hd
+                ? { entropySource: keyring.metadata.id }
+                : {},
           });
         }
 
@@ -902,6 +908,10 @@ export class AccountsController extends BaseController<
                 importTime: Date.now(),
                 lastSelected,
               },
+              options: {
+                ...account.options,
+                ...added.options,
+              },
             };
 
             diff.added.push(internalAccounts.accounts[account.id]);