feat: add support for accountChanged for Tron network

Author: EdouardBougon

app/scripts/metamask-controller.js

@@ -1638,8 +1638,9 @@ export default class MetamaskController extends EventEmitter {
   setupControllerEventSubscriptions() {
     let lastSelectedAddress;
     let lastSelectedSolanaAccountAddress;
+    let lastSelectedTronAccountAddress;
 
-    // this throws if there is no solana account... perhaps we should handle this better at the controller level
+    // this throws if there is no solana or Tron account... perhaps we should handle this better at the controller level
     try {
       lastSelectedSolanaAccountAddress =
         this.accountsController.getSelectedMultichainAccount(
@@ -1648,6 +1649,14 @@ export default class MetamaskController extends EventEmitter {
     } catch {
       // noop
     }
+    try {
+      lastSelectedTronAccountAddress =
+        this.accountsController.getSelectedMultichainAccount(
+          MultichainNetworks.TRON,
+        )?.address;
+    } catch {
+      // noop
+    }
 
     this.controllerMessenger.subscribe(
       'PreferencesController:stateChange',
@@ -1943,6 +1952,193 @@ export default class MetamaskController extends EventEmitter {
       },
     );
 
+    // wallet_notify for tron accountChanged when permission changes
+    this.controllerMessenger.subscribe(
+      `${this.permissionController.name}:stateChange`,
+      async (currentValue, previousValue) => {
+        const origins = uniq([...previousValue.keys(), ...currentValue.keys()]);
+        origins.forEach((origin) => {
+          const previousCaveatValue = previousValue.get(origin);
+          const currentCaveatValue = currentValue.get(origin);
+
+          const previousTronAccountChangedNotificationsEnabled = Boolean(
+            previousCaveatValue?.sessionProperties?.[
+              KnownSessionProperties.TronAccountChangedNotifications
+            ],
+          );
+          const currentTronAccountChangedNotificationsEnabled = Boolean(
+            currentCaveatValue?.sessionProperties?.[
+              KnownSessionProperties.TronAccountChangedNotifications
+            ],
+          );
+
+          if (
+            !previousTronAccountChangedNotificationsEnabled &&
+            !currentTronAccountChangedNotificationsEnabled
+          ) {
+            return;
+          }
+
+          const previousTronCaipAccountIds = previousCaveatValue
+            ? getPermittedAccountsForScopes(previousCaveatValue, [
+                MultichainNetworks.TRON,
+                MultichainNetworks.TRON_SHASTA,
+                MultichainNetworks.TRON_NILE,
+              ])
+            : [];
+          const previousNonUniqueTronHexAccountAddresses =
+            previousTronCaipAccountIds.map((caipAccountId) => {
+              const { address } = parseCaipAccountId(caipAccountId);
+              return address;
+            });
+          const previousTronHexAccountAddresses = uniq(
+            previousNonUniqueTronHexAccountAddresses,
+          );
+          const [previousSelectedTronAccountAddress] =
+            this.sortMultichainAccountsByLastSelected(
+              previousTronHexAccountAddresses,
+            );
+
+          const currentTronCaipAccountIds = currentCaveatValue
+            ? getPermittedAccountsForScopes(currentCaveatValue, [
+                MultichainNetworks.TRON,
+                MultichainNetworks.TRON_SHASTA,
+                MultichainNetworks.TRON_NILE,
+              ])
+            : [];
+          const currentNonUniqueTronHexAccountAddresses =
+            currentTronCaipAccountIds.map((caipAccountId) => {
+              const { address } = parseCaipAccountId(caipAccountId);
+              return address;
+            });
+          const currentTronHexAccountAddresses = uniq(
+            currentNonUniqueTronHexAccountAddresses,
+          );
+          const [currentSelectedTronAccountAddress] =
+            this.sortMultichainAccountsByLastSelected(
+              currentTronHexAccountAddresses,
+            );
+
+          if (
+            previousSelectedTronAccountAddress !==
+            currentSelectedTronAccountAddress
+          ) {
+            this._notifyTronAccountChange(
+              origin,
+              currentSelectedTronAccountAddress
+                ? [currentSelectedTronAccountAddress]
+                : [],
+            );
+          }
+        });
+      },
+      getAuthorizedScopesByOrigin,
+    );
+
+    // TODO: To be removed when state 2 is fully transitioned.
+    // wallet_notify for tron accountChanged when selected account changes
+    this.controllerMessenger.subscribe(
+      `${this.accountsController.name}:selectedAccountChange`,
+      async (account) => {
+        if (
+          account.type === TrxAccountType.Eoa &&
+          account.address !== lastSelectedTronAccountAddress
+        ) {
+          lastSelectedTronAccountAddress = account.address;
+
+          const originsWithTronAccountChangedNotifications =
+            getOriginsWithSessionProperty(
+              this.permissionController.state,
+              KnownSessionProperties.TronAccountChangedNotifications,
+            );
+
+          // returns a map of origins to permitted tron accounts
+          const tronAccounts = getPermittedAccountsForScopesByOrigin(
+            this.permissionController.state,
+            [
+              MultichainNetworks.TRON,
+              MultichainNetworks.TRON_SHASTA,
+              MultichainNetworks.TRON_NILE,
+            ],
+          );
+
+          if (tronAccounts.size > 0) {
+            for (const [origin, accounts] of tronAccounts.entries()) {
+              const parsedTronAddresses = accounts.map((caipAccountId) => {
+                const { address } = parseCaipAccountId(caipAccountId);
+                return address;
+              });
+
+              if (
+                parsedTronAddresses.includes(account.address) &&
+                originsWithTronAccountChangedNotifications[origin]
+              ) {
+                this._notifyTronAccountChange(origin, [account.address]);
+              }
+            }
+          }
+        }
+      },
+    );
+
+    // wallet_notify for tron accountChanged when selected account group changes
+    this.controllerMessenger.subscribe(
+      `${this.accountTreeController.name}:selectedAccountGroupChange`,
+      (groupId) => {
+        // TODO: Move this logic to the SnapKeyring directly.
+        // Forward selected accounts to the Snap keyring, so each Snaps can fetch those accounts.
+        // eslint-disable-next-line no-void
+        void this.forwardSelectedAccountGroupToSnapKeyring(
+          this.getSnapKeyringIfAvailable(),
+          groupId,
+        );
+
+        const [account] =
+          this.accountTreeController.getAccountsFromSelectedAccountGroup({
+            scopes: [TrxScope.Mainnet],
+          });
+        if (
+          account &&
+          account.type === TrxAccountType.Eoa &&
+          account.address !== lastSelectedTronAccountAddress
+        ) {
+          lastSelectedTronAccountAddress = account.address;
+
+          const originsWithTronAccountChangedNotifications =
+            getOriginsWithSessionProperty(
+              this.permissionController.state,
+              KnownSessionProperties.TronAccountChangedNotifications,
+            );
+
+          // returns a map of origins to permitted tron accounts
+          const tronAccounts = getPermittedAccountsForScopesByOrigin(
+            this.permissionController.state,
+            [
+              MultichainNetworks.TRON,
+              MultichainNetworks.TRON_SHASTA,
+              MultichainNetworks.TRON_NILE,
+            ],
+          );
+
+          if (tronAccounts.size > 0) {
+            for (const [origin, accounts] of tronAccounts.entries()) {
+              const parsedTronAddresses = accounts.map((caipAccountId) => {
+                const { address } = parseCaipAccountId(caipAccountId);
+                return address;
+              });
+
+              if (
+                parsedTronAddresses.includes(account.address) &&
+                originsWithTronAccountChangedNotifications[origin]
+              ) {
+                this._notifyTronAccountChange(origin, [account.address]);
+              }
+            }
+          }
+        }
+      },
+    );
+
     // TODO: Move this logic to the SnapKeyring directly.
     // Forward selected accounts to the Snap keyring, so each Snaps can fetch those accounts.
     this.controllerMessenger.subscribe(
@@ -8677,6 +8873,23 @@ export default class MetamaskController extends EventEmitter {
     );
   }
 
+  async _notifyTronAccountChange(origin, accountAddressArray) {
+    this.notifyConnections(
+      origin,
+      {
+        method: MultichainApiNotifications.walletNotify,
+        params: {
+          scope: MultichainNetworks.TRON,
+          notification: {
+            method: NOTIFICATION_NAMES.accountsChanged,
+            params: accountAddressArray,
+          },
+        },
+      },
+      API_TYPE.CAIP_MULTICHAIN,
+    );
+  }
+
   async _notifyChainChange() {
     this.notifyAllConnections(
       async (origin) => ({