feat: auto-enable networks from config-registry

README.md

@@ -487,6 +487,7 @@ linkStyle default opacity:0.5
   network_connection_banner_controller --> network_enablement_controller;
   network_controller --> analytics_controller;
   network_controller --> base_controller;
+  network_controller --> config_registry_controller;
   network_controller --> connectivity_controller;
   network_controller --> controller_utils;
   network_controller --> eth_block_tracker;

package.json

@@ -137,7 +137,9 @@
       "eslint-plugin-import-x>unrs-resolver": false,
       "simple-git-hooks": false,
       "tsx>esbuild": false,
-      "jest>@jest/core>jest-resolve>unrs-resolver": false
+      "jest>@jest/core>jest-resolve>unrs-resolver": false,
+      "@metamask/network-controller>@metamask/config-registry-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>keccak": false,
+      "@metamask/network-controller>@metamask/config-registry-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>secp256k1": false
     }
   }
 }

packages/assets-controllers/src/AssetsContractController.test.ts

@@ -111,6 +111,15 @@ async function setupAssetContractControllers({
     }),
   );
 
+  messenger.registerActionHandler('ConfigRegistryController:getState', () => ({
+    configs: {
+      networks: {},
+    },
+    lastFetched: 0,
+    etag: '',
+    version: '1',
+  }));
+
   const networkControllerMessenger: NetworkControllerMessenger = new Messenger({
     namespace: 'NetworkController',
     parent: messenger,
@@ -119,6 +128,8 @@ async function setupAssetContractControllers({
   messenger.delegate({
     messenger: networkControllerMessenger,
     actions: [
+      'ConfigRegistryController:getNetworkConfigByCaip2ChainId',
+      'ConfigRegistryController:getState',
       'ConnectivityController:getState',
       'RemoteFeatureFlagController:getState',
     ],

packages/config-registry-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add optional `isAutoEnabled?: boolean` property to `RegistryNetworkConfig.config` ([#9879](https://github.com/MetaMask/core/pull/9879))
+
 ## [3.0.0]
 
 ### Added

packages/config-registry-controller/src/config-registry-api-service/types.ts

@@ -48,6 +48,7 @@ const ChainConfigSchema = type({
   isFeatured: boolean(),
   isDeprecated: boolean(),
   isDeletable: boolean(),
+  isAutoEnabled: optional(boolean()),
   priority: number(),
 });
 

packages/config-registry-controller/src/index.ts

@@ -3,6 +3,7 @@ export type {
   ConfigRegistryControllerOptions,
   ConfigRegistryControllerActions,
   ConfigRegistryControllerGetStateAction,
+  ConfigRegistryControllerStateChangedEvent,
   ConfigRegistryControllerEvents,
   ConfigRegistryControllerMessenger,
 } from './ConfigRegistryController.js';

packages/gas-fee-controller/src/GasFeeController.test.ts

@@ -79,6 +79,16 @@ const getRootMessenger = (): RootMessenger => {
     }),
   );
 
+  rootMessenger.registerActionHandler(
+    'ConfigRegistryController:getState',
+    () => ({
+      configs: { networks: {} },
+      lastFetched: 0,
+      etag: '',
+      version: '1',
+    }),
+  );
+
   return rootMessenger;
 };
 
@@ -105,6 +115,7 @@ const setupNetworkController = async ({
   rootMessenger.delegate({
     messenger: networkControllerMessenger,
     actions: [
+      'ConfigRegistryController:getState',
       'ConnectivityController:getState',
       'RemoteFeatureFlagController:getState',
     ],

packages/network-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** `NetworkControllerMessenger` now requires the `ConfigRegistryController:stateChanged` event and `ConfigRegistryController:getNetworkConfigByCaip2ChainId` action to be delegated from the root messenger ([#9879](https://github.com/MetaMask/core/pull/9879))
+  - `NetworkController` now depends on the `ConfigRegistryController` to auto-enable default networks from the registry.
+
 ## [35.0.1]
 
 ### Changed

packages/network-controller/jest.config.js

@@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 93.42,
-      functions: 98,
-      lines: 97.67,
-      statements: 97.56,
+      branches: 94.04,
+      functions: 98.17,
+      lines: 97.94,
+      statements: 97.83,
     },
   },
 

packages/network-controller/package.json

@@ -57,6 +57,7 @@
   "dependencies": {
     "@metamask/analytics-controller": "^2.0.0",
     "@metamask/base-controller": "^9.1.0",
+    "@metamask/config-registry-controller": "^3.0.0",
     "@metamask/connectivity-controller": "^0.3.0",
     "@metamask/controller-utils": "^12.3.0",
     "@metamask/eth-block-tracker": "^15.0.1",

packages/network-controller/src/NetworkController.ts

@@ -7,6 +7,11 @@ import type {
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
+import type {
+  ConfigRegistryControllerStateChangedEvent,
+  ConfigRegistryControllerGetNetworkConfigByCaip2ChainIdAction,
+  ConfigRegistryControllerGetStateAction,
+} from '@metamask/config-registry-controller';
 import type { ConnectivityControllerGetStateAction } from '@metamask/connectivity-controller';
 import type { Partialize } from '@metamask/controller-utils';
 import {
@@ -35,8 +40,14 @@ import {
   createSwappableProxy,
 } from '@metamask/swappable-obj-proxy';
 import type { SwappableProxy } from '@metamask/swappable-obj-proxy';
-import type { Hex } from '@metamask/utils';
-import { hasProperty, isPlainObject, isStrictHexString } from '@metamask/utils';
+import type { CaipChainId, Hex } from '@metamask/utils';
+import {
+  hasProperty,
+  isPlainObject,
+  isStrictHexString,
+  numberToHex,
+  parseCaipChainId,
+} from '@metamask/utils';
 import deepEqual from 'fast-deep-equal';
 import type { Draft } from 'immer';
 import { produce } from 'immer';
@@ -71,7 +82,10 @@ import type {
   ResolvedNetworkControllerAnalyticsOptions,
 } from './rpc-service-analytics.js';
 import type { RpcServiceOptionsWithDefaults } from './rpc-service/rpc-service.js';
-import { getRpcFailoverMode } from './selectors.js';
+import {
+  getConfigRegistryEvmAutoEnabledChains,
+  getRpcFailoverMode,
+} from './selectors.js';
 import type { RpcFailoverMode } from './selectors.js';
 import { NetworkClientType } from './types.js';
 import type {
@@ -680,7 +694,9 @@ export type NetworkControllerEvents =
 /**
  * All events that {@link NetworkController} calls internally.
  */
-type AllowedEvents = RemoteFeatureFlagControllerStateChangeEvent;
+type AllowedEvents =
+  | RemoteFeatureFlagControllerStateChangeEvent
+  | ConfigRegistryControllerStateChangedEvent;
 
 const MESSENGER_EXPOSED_METHODS = [
   'addNetwork',
@@ -723,6 +739,8 @@ export type NetworkControllerActions =
  * All actions that {@link NetworkController} calls internally.
  */
 type AllowedActions =
+  | ConfigRegistryControllerGetNetworkConfigByCaip2ChainIdAction
+  | ConfigRegistryControllerGetStateAction
   | ConnectivityControllerGetStateAction
   | RemoteFeatureFlagControllerGetStateAction
   | AnalyticsControllerGetStateAction
@@ -1418,6 +1436,12 @@ export class NetworkController extends BaseController<
       },
       getRpcFailoverMode,
     );
+
+    this.messenger.subscribe(
+      'ConfigRegistryController:stateChanged',
+      (autoEnabledChains) => this.#autoEnableChains(autoEnabledChains),
+      getConfigRegistryEvmAutoEnabledChains,
+    );
   }
 
   /**
@@ -1617,15 +1641,22 @@ export class NetworkController extends BaseController<
   }
 
   /**
-   * Initialize the NetworkController, applying the RPC failover mode from the
-   * `corePlatformRpcFailoverMode` remote feature flag and applying the network
-   * selection.
+   * Initialize the NetworkController:
+   *   - Apply the RPC failover mode from the `corePlatformRpcFailoverMode` remote feature flag;
+   *   - Apply the network selection.
+   *   - Auto-enable any chains that are configured to be auto-enabled in ConfigRegistryController.
    */
   init(): void {
     const state = this.messenger.call('RemoteFeatureFlagController:getState');
     this.#updateRpcFailover(getRpcFailoverMode(state));
 
     this.#applyNetworkSelection(this.state.selectedNetworkClientId);
+
+    this.#autoEnableChains(
+      getConfigRegistryEvmAutoEnabledChains(
+        this.messenger.call('ConfigRegistryController:getState'),
+      ),
+    );
   }
 
   /**
@@ -3133,4 +3164,54 @@ export class NetworkController extends BaseController<
 
     this.#ethQuery = new EthQuery(this.#providerProxy);
   }
+
+  /**
+   * Enables networks for the given CAIP-2 chain IDs by adding
+   * them to state if they are not already present. Configurations for
+   * these networks are retrieved from ConfigRegistryController.
+   *
+   * @param chainIds - The CAIP-2 chain IDs of the networks to enable.
+   */
+  #autoEnableChains(chainIds: CaipChainId[]): void {
+    for (const chainId of chainIds) {
+      const networkConfiguration = this.messenger.call(
+        'ConfigRegistryController:getNetworkConfigByCaip2ChainId',
+        chainId,
+      );
+      const hexChainId = numberToHex(
+        Number(parseCaipChainId(chainId).reference),
+      );
+
+      if (
+        !networkConfiguration ||
+        this.state.networkConfigurationsByChainId[hexChainId]
+      ) {
+        continue;
+      }
+
+      const rpcEndpoint: InfuraRpcEndpoint | AddNetworkCustomRpcEndpointFields =
+        networkConfiguration.rpcProviders.default.type === 'infura'
+          ? {
+              type: RpcEndpointType.Infura,
+              networkClientId:
+                networkConfiguration.rpcProviders.default.networkClientId,
+              url: networkConfiguration.rpcProviders.default
+                .url as InfuraRpcEndpoint['url'],
+            }
+          : {
+              type: RpcEndpointType.Custom,
+              url: networkConfiguration.rpcProviders.default.url,
+            };
+
+      this.addNetwork({
+        chainId: hexChainId,
+        name: networkConfiguration.name,
+        nativeCurrency: networkConfiguration.assets.native.symbol,
+        rpcEndpoints: [rpcEndpoint],
+        defaultRpcEndpointIndex: 0,
+        blockExplorerUrls: [networkConfiguration.blockExplorerUrls.default],
+        defaultBlockExplorerUrlIndex: 0,
+      });
+    }
+  }
 }

packages/network-controller/src/selectors.test.ts

@@ -1,4 +1,7 @@
-import { getRpcFailoverMode } from './selectors.js';
+import {
+  getConfigRegistryEvmAutoEnabledChains,
+  getRpcFailoverMode,
+} from './selectors.js';
 
 /**
  * Builds a remote feature flag controller state with the given failover mode.
@@ -40,3 +43,61 @@ describe('getRpcFailoverMode', () => {
     expect(getRpcFailoverMode(buildState('yes') as never)).toBe('disabled');
   });
 });
+
+describe('getConfigRegistryEvmAutoEnabledChains', () => {
+  it('returns the list of CAIP-2 chain IDs for auto-enabled EVM networks', () => {
+    const state = {
+      configs: {
+        networks: {
+          'eip155:1': {
+            chainId: 'eip155:1',
+            config: {
+              isAutoEnabled: true,
+              isActive: true,
+              isDeprecated: false,
+            },
+          },
+          'eip155:3': {
+            chainId: 'eip155:3',
+            config: {
+              isAutoEnabled: false,
+              isActive: true,
+              isDeprecated: false,
+            },
+          },
+          'eip155:4': {
+            chainId: 'eip155:4',
+            config: {
+              isAutoEnabled: true,
+              isActive: false,
+              isDeprecated: false,
+            },
+          },
+          'eip155:5': {
+            chainId: 'eip155:5',
+            config: { isAutoEnabled: true, isActive: true, isDeprecated: true },
+          },
+          'eip155:6': {
+            chainId: 'eip155:6',
+            config: {
+              isAutoEnabled: true,
+              isActive: true,
+              isDeprecated: false,
+            },
+          },
+          'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp': {
+            chainId: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+            config: {
+              isAutoEnabled: true,
+              isActive: true,
+              isDeprecated: false,
+            },
+          },
+        },
+      },
+    };
+
+    const result = getConfigRegistryEvmAutoEnabledChains(state);
+    expect(result).toStrictEqual(['eip155:1', 'eip155:6']);
+  });
+});

packages/network-controller/src/selectors.ts

@@ -1,4 +1,6 @@
+import { ConfigRegistryControllerState } from '@metamask/config-registry-controller';
 import { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';
+import { CaipChainId, KnownCaipNamespace } from '@metamask/utils';
 
 /**
  * The RPC failover behavior for Infura networks, controlled by the
@@ -26,3 +28,24 @@ export function getRpcFailoverMode(
   const mode = state.remoteFeatureFlags.corePlatformRpcFailoverMode;
   return mode === 'enabled' || mode === 'forced' ? mode : 'disabled';
 }
+
+/**
+ * Returns the list of CAIP-2 chain IDs for networks that are auto-enabled in the
+ * config registry.
+ *
+ * @param state - The config registry controller state.
+ * @returns The list of CAIP-2 chain IDs for auto-enabled networks.
+ */
+export function getConfigRegistryEvmAutoEnabledChains(
+  state: ConfigRegistryControllerState,
+): CaipChainId[] {
+  return Object.values(state.configs.networks)
+    .filter(
+      ({ chainId, config }) =>
+        chainId.startsWith(KnownCaipNamespace.Eip155) &&
+        config.isAutoEnabled &&
+        config.isActive &&
+        !config.isDeprecated,
+    )
+    .map((config) => config.chainId);
+}