Remove networkId from NetworkController

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

@@ -519,7 +519,6 @@ function buildNetworkControllerStateWithProviderConfig(
   return {
     selectedNetworkClientId,
     providerConfig,
-    networkId: '1',
     networksMetadata: {
       [selectedNetworkClientId]: {
         EIPS: {},

packages/controller-utils/src/constants.ts

@@ -1,4 +1,9 @@
-import { NetworkType, NetworksTicker, ChainId, NetworkId } from './types';
+import {
+  NetworkType,
+  NetworksTicker,
+  ChainId,
+  BuiltInNetworkName,
+} from './types';
 
 export const RPC = 'rpc';
 export const FALL_BACK_VS_CURRENCY = 'ETH';
@@ -125,13 +130,14 @@ export enum ApprovalType {
   WatchAsset = 'wallet_watchAsset',
 }
 
-export const NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP: Record<
-  NetworkId,
-  NetworkType
+export const CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP: Record<
+  ChainId,
+  BuiltInNetworkName
 > = {
-  [NetworkId.goerli]: NetworkType.goerli,
-  [NetworkId.sepolia]: NetworkType.sepolia,
-  [NetworkId.mainnet]: NetworkType.mainnet,
-  [NetworkId['linea-goerli']]: NetworkType['linea-goerli'],
-  [NetworkId['linea-mainnet']]: NetworkType['linea-mainnet'],
+  [ChainId.goerli]: BuiltInNetworkName.Goerli,
+  [ChainId.sepolia]: BuiltInNetworkName.Sepolia,
+  [ChainId.mainnet]: BuiltInNetworkName.Mainnet,
+  [ChainId['linea-goerli']]: BuiltInNetworkName.LineaGoerli,
+  [ChainId['linea-mainnet']]: BuiltInNetworkName.LineaMainnet,
+  [ChainId.aurora]: BuiltInNetworkName.Aurora,
 };

packages/controller-utils/src/types.ts

@@ -61,18 +61,6 @@ export const ChainId = {
 } as const;
 export type ChainId = (typeof ChainId)[keyof typeof ChainId];
 
-/**
- * Decimal string network IDs of built-in Infura networks, by name.
- */
-export const NetworkId = {
-  [InfuraNetworkType.mainnet]: '1',
-  [InfuraNetworkType.goerli]: '5',
-  [InfuraNetworkType.sepolia]: '11155111',
-  [InfuraNetworkType['linea-goerli']]: '59140',
-  [InfuraNetworkType['linea-mainnet']]: '59144',
-} as const;
-export type NetworkId = (typeof NetworkId)[keyof typeof NetworkId];
-
 export enum NetworksTicker {
   mainnet = 'ETH',
   goerli = 'GoerliETH',

packages/ens-controller/src/EnsController.test.ts

@@ -119,7 +119,6 @@ describe('EnsController', () => {
       provider: getProvider(),
       onNetworkStateChange: (listener) => {
         listener({
-          networkId: '1',
           providerConfig: {
             chainId: toHex(1),
             type: NetworkType.mainnet,
@@ -445,7 +444,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: null,
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -464,9 +462,8 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1544',
             providerConfig: {
-              chainId: toHex(1),
+              chainId: toHex(0),
               type: NetworkType.mainnet,
               ticker: NetworksTicker.mainnet,
             },
@@ -490,7 +487,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -514,7 +510,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -537,7 +532,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -563,7 +557,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -589,7 +582,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -617,7 +609,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -644,7 +635,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,

packages/ens-controller/src/EnsController.ts

@@ -5,36 +5,22 @@ import type {
 import { Web3Provider } from '@ethersproject/providers';
 import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseControllerV2 } from '@metamask/base-controller';
+import type { ChainId } from '@metamask/controller-utils';
 import {
   normalizeEnsName,
   isValidHexAddress,
   toChecksumHexAddress,
-  NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP,
+  CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,
   convertHexToDecimal,
 } from '@metamask/controller-utils';
 import type { NetworkState } from '@metamask/network-controller';
 import type { Hex } from '@metamask/utils';
-import { createProjectLogger, hasProperty } from '@metamask/utils';
+import { createProjectLogger } from '@metamask/utils';
 import ensNetworkMap from 'ethereum-ens-network-map';
 import { toASCII } from 'punycode/';
 
 const log = createProjectLogger('ens-controller');
 
-/**
- * Checks whether the given string is a known network ID.
- *
- * @param networkId - Network id.
- * @returns Boolean indicating if the network ID is recognized.
- */
-function isKnownNetworkId(
-  networkId: string | null,
-): networkId is keyof typeof NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP {
-  return (
-    networkId !== null &&
-    hasProperty(NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId)
-  );
-}
-
 const name = 'EnsController';
 
 /**
@@ -118,9 +104,7 @@ export class EnsController extends BaseControllerV2<
     state?: Partial<EnsControllerState>;
     provider?: ExternalProvider | JsonRpcFetchFunc;
     onNetworkStateChange?: (
-      listener: (
-        networkState: Pick<NetworkState, 'networkId' | 'providerConfig'>,
-      ) => void,
+      listener: (networkState: Pick<NetworkState, 'providerConfig'>) => void,
     ) => void;
   }) {
     super({
@@ -136,15 +120,14 @@ export class EnsController extends BaseControllerV2<
     if (provider && onNetworkStateChange) {
       onNetworkStateChange((networkState) => {
         this.resetState();
-        const currentNetwork = networkState.networkId;
-        if (
-          isKnownNetworkId(currentNetwork) &&
-          this.#getNetworkEnsSupport(currentNetwork)
-        ) {
+        const currentChainId = networkState.providerConfig.chainId;
+        if (this.#getChainEnsSupport(currentChainId)) {
           this.#ethProvider = new Web3Provider(provider, {
-            chainId: convertHexToDecimal(networkState.providerConfig.chainId),
-            name: NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],
-            ensAddress: ensNetworkMap[currentNetwork],
+            chainId: convertHexToDecimal(currentChainId),
+            name: CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[
+              currentChainId as ChainId
+            ],
+            ensAddress: ensNetworkMap[parseInt(currentChainId, 16)],
           });
         } else {
           this.#ethProvider = null;
@@ -269,13 +252,13 @@ export class EnsController extends BaseControllerV2<
   }
 
   /**
-   * Check if network supports ENS.
+   * Check if the chain supports ENS.
    *
-   * @param networkId - Network id.
-   * @returns Boolean indicating if the network supports ENS.
+   * @param chainId - chain id.
+   * @returns Boolean indicating if the chain supports ENS.
    */
-  #getNetworkEnsSupport(networkId: string) {
-    return Boolean(ensNetworkMap[networkId]);
+  #getChainEnsSupport(chainId: string) {
+    return Boolean(ensNetworkMap[parseInt(chainId, 16)]);
   }
 
   /**

packages/network-controller/src/NetworkController.ts

@@ -2,7 +2,6 @@ import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseControllerV2 } from '@metamask/base-controller';
 import {
   BUILT_IN_NETWORKS,
-  convertHexToDecimal,
   NetworksTicker,
   ChainId,
   InfuraNetworkType,
@@ -17,7 +16,6 @@ import {
   assertIsStrictHexString,
   hasProperty,
   isPlainObject,
-  isStrictHexString,
 } from '@metamask/utils';
 import { strict as assert } from 'assert';
 import { errorCodes } from 'eth-rpc-errors';
@@ -174,25 +172,6 @@ function pick<Obj extends Record<any, any>, Keys extends keyof Obj>(
   return pickedObject;
 }
 
-/**
- * Convert the given value into a valid network ID. The ID is accepted
- * as either a number, a decimal string, or a 0x-prefixed hex string.
- *
- * @param value - The network ID to convert, in an unknown format.
- * @returns A valid network ID (as a decimal string)
- * @throws If the given value cannot be safely parsed.
- */
-function convertNetworkId(value: unknown): NetworkId {
-  if (typeof value === 'number' && !Number.isNaN(value)) {
-    return `${value}`;
-  } else if (isStrictHexString(value)) {
-    return `${convertHexToDecimal(value)}`;
-  } else if (typeof value === 'string' && /^\d+$/u.test(value)) {
-    return value as NetworkId;
-  }
-  throw new Error(`Cannot parse as a valid network ID: '${value}'`);
-}
-
 /**
  * Type guard for determining whether the given value is an error object with a
  * `code` property, such as an instance of Error.
@@ -343,11 +322,6 @@ export type NetworksMetadata = {
   [networkClientId: NetworkClientId]: NetworkMetadata;
 };
 
-/**
- * The network ID of a network.
- */
-export type NetworkId = `${number}`;
-
 /**
  * @type NetworkState
  *
@@ -359,7 +333,6 @@ export type NetworkId = `${number}`;
  */
 export type NetworkState = {
   selectedNetworkClientId: NetworkClientId;
-  networkId: NetworkId | null;
   providerConfig: ProviderConfig;
   networkConfigurations: NetworkConfigurations;
   networksMetadata: NetworksMetadata;
@@ -475,7 +448,6 @@ export type NetworkControllerOptions = {
 
 export const defaultState: NetworkState = {
   selectedNetworkClientId: NetworkType.mainnet,
-  networkId: null,
   providerConfig: {
     type: NetworkType.mainnet,
     chainId: ChainId.mainnet,
@@ -562,10 +534,6 @@ export class NetworkController extends BaseControllerV2<
           persist: true,
           anonymous: false,
         },
-        networkId: {
-          persist: true,
-          anonymous: false,
-        },
         networksMetadata: {
           persist: true,
           anonymous: false,
@@ -708,9 +676,6 @@ export class NetworkController extends BaseControllerV2<
    */
   async #refreshNetwork() {
     this.messagingSystem.publish('NetworkController:networkWillChange');
-    this.update((state) => {
-      state.networkId = null;
-    });
     this.#applyNetworkSelection();
     this.messagingSystem.publish('NetworkController:networkDidChange');
     await this.lookupNetwork();
@@ -727,35 +692,6 @@ export class NetworkController extends BaseControllerV2<
     await this.lookupNetwork();
   }
 
-  /**
-   * Fetches the network ID for the network, ensuring that it is a hex string.
-   *
-   * @returns A promise that either resolves to the network ID, or rejects with
-   * an error.
-   * @throws If the network ID of the network is not a valid hex string.
-   */
-  async #getNetworkId(): Promise<NetworkId> {
-    const possibleNetworkId = await new Promise<string>((resolve, reject) => {
-      if (!this.#ethQuery) {
-        throw new Error('Provider has not been initialized');
-      }
-
-      this.#ethQuery.sendAsync(
-        { method: 'net_version' },
-        (error: unknown, result?: unknown) => {
-          if (error) {
-            reject(error);
-          } else {
-            // TODO: Validate this type
-            resolve(result as string);
-          }
-        },
-      );
-    });
-
-    return convertNetworkId(possibleNetworkId);
-  }
-
   /**
    * Performs side effects after switching to a network. If the network is
    * available, updates the network state with the network ID of the network and
@@ -788,16 +724,11 @@ export class NetworkController extends BaseControllerV2<
     );
 
     let updatedNetworkStatus: NetworkStatus;
-    let updatedNetworkId: NetworkId | null = null;
     let updatedIsEIP1559Compatible: boolean | undefined;
 
     try {
-      const [networkId, isEIP1559Compatible] = await Promise.all([
-        this.#getNetworkId(),
-        this.#determineEIP1559Compatibility(),
-      ]);
+      const isEIP1559Compatible = await this.#determineEIP1559Compatibility();
       updatedNetworkStatus = NetworkStatus.Available;
-      updatedNetworkId = networkId;
       updatedIsEIP1559Compatible = isEIP1559Compatible;
     } catch (error) {
       if (isErrorWithCode(error)) {
@@ -841,7 +772,6 @@ export class NetworkController extends BaseControllerV2<
     );
 
     this.update((state) => {
-      state.networkId = updatedNetworkId;
       const meta = state.networksMetadata[state.selectedNetworkClientId];
       meta.status = updatedNetworkStatus;
       if (updatedIsEIP1559Compatible === undefined) {