@metamask-previews/network-controller 25.0.0-preview-4419d7e4 → 25.0.0-preview-359767df

package/CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Providers accessible either via network clients or global proxies no longer emit events (or inherit from EventEmitter, for that matter).
 - Bump `@metamask/controller-utils` from `^11.14.1` to `^11.15.0` ([#7003](https://github.com/MetaMask/core/pull/7003))
 
+### Fixed
+
+- Ensure `networksMetadata` never references old network client IDs ([#7047](https://github.com/MetaMask/core/pull/7047))
+  - When removing a network configuration, ensure that metadata for all RPC endpoints in the network configuration are also removed from `networksMetadata`
+  - When initializing the controller, remove metadata for RPC endpoints in `networksMetadata` that are not present in a network configuration
+
 ## [25.0.0]
 
 ### Changed

package/dist/NetworkController.cjs

@@ -335,14 +335,21 @@ function validateInitialState(state) {
  */
 function correctInitialState(state, messenger) {
     const networkConfigurationsSortedByChainId = getNetworkConfigurations(state).sort((a, b) => a.chainId.localeCompare(b.chainId));
-    const networkClientIds = getAvailableNetworkClientIds(networkConfigurationsSortedByChainId);
+    const availableNetworkClientIds = getAvailableNetworkClientIds(networkConfigurationsSortedByChainId);
+    const invalidNetworkClientIdsWithMetadata = Object.keys(state.networksMetadata).filter((networkClientId) => !availableNetworkClientIds.includes(networkClientId));
     return (0, immer_1.produce)(state, (newState) => {
-        if (!networkClientIds.includes(state.selectedNetworkClientId)) {
+        if (!availableNetworkClientIds.includes(state.selectedNetworkClientId)) {
             const firstNetworkConfiguration = networkConfigurationsSortedByChainId[0];
             const newSelectedNetworkClientId = firstNetworkConfiguration.rpcEndpoints[firstNetworkConfiguration.defaultRpcEndpointIndex].networkClientId;
             messenger.call('ErrorReportingService:captureException', new Error(`\`selectedNetworkClientId\` '${state.selectedNetworkClientId}' does not refer to an RPC endpoint within a network configuration; correcting to '${newSelectedNetworkClientId}'`));
             newState.selectedNetworkClientId = newSelectedNetworkClientId;
         }
+        if (invalidNetworkClientIdsWithMetadata.length > 0) {
+            for (const invalidNetworkClientId of invalidNetworkClientIdsWithMetadata) {
+                delete newState.networksMetadata[invalidNetworkClientId];
+            }
+            messenger.call('ErrorReportingService:captureException', new Error('`networksMetadata` had invalid network client IDs, which have been removed'));
+        }
     });
 }
 /**
@@ -962,6 +969,9 @@ class NetworkController extends base_controller_1.BaseController {
                 mode: 'remove',
                 existingNetworkConfiguration,
             });
+            for (const rpcEndpoint of existingNetworkConfiguration.rpcEndpoints) {
+                delete state.networksMetadata[rpcEndpoint.networkClientId];
+            }
         });
         this.messenger.publish('NetworkController:networkRemoved', existingNetworkConfiguration);
     }
@@ -1236,6 +1246,8 @@ async function _NetworkController_lookupSelectedNetwork() {
     return new Promise((resolve, reject) => {
         ethQuery.sendAsync({ method: 'eth_getBlockByNumber', params: ['latest', false] }, (error, block) => {
             if (error) {
+                // This error comes from JsonRpcEngine, we don't control it.
+                // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
                 reject(error);
             }
             else {