NetworkController: Use the same middleware stack as the extension

.eslintrc.js

@@ -26,6 +26,7 @@ module.exports = {
         'jest/no-test-return-statement': 'off',
         // TODO: Re-enable this rule; we can accomodate this even in our test helpers
         'jest/expect-expect': 'off',
+        'jest/no-identical-title': 'off',
       },
     },
     {

package.json

@@ -39,6 +39,7 @@
     "@metamask/eslint-config-jest": "^9.0.0",
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
+    "@metamask/eth-json-rpc-provider": "^1.0.0",
     "@types/node": "^16.18.24",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
@@ -52,6 +53,7 @@
     "eslint-plugin-prettier": "^3.4.1",
     "execa": "^5.0.0",
     "isomorphic-fetch": "^3.0.0",
+    "json-rpc-engine": "^6.1.0",
     "prettier": "^2.6.2",
     "prettier-plugin-packagejson": "^2.2.17",
     "rimraf": "^3.0.2",

packages/controller-utils/src/types.ts

@@ -1,5 +1,6 @@
 /**
- * The names of built-in Infura networks
+ * The names of Infura-supported built-in networks that can be used to create an
+ * Infura-specific network client.
  */
 export const InfuraNetworkType = {
   mainnet: 'mainnet',
@@ -11,7 +12,9 @@ export type InfuraNetworkType =
   typeof InfuraNetworkType[keyof typeof InfuraNetworkType];
 
 /**
- * The "network type"; either the name of a built-in network, or "rpc" for custom networks.
+ * Symbols that can be used to create a network client: either a
+ * Infura-supported built-in network, "localhost" for a locally-operated custom
+ * network, or "rpc" for a remotely-operated custom network.
  */
 export const NetworkType = {
   ...InfuraNetworkType,

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

@@ -271,10 +271,8 @@ describe('GasFeeController', () => {
 
   afterEach(() => {
     gasFeeController.destroy();
-    const { provider } = networkController.getProviderAndBlockTracker();
-    if (provider) {
-      provider.stop();
-    }
+    const { blockTracker } = networkController.getProviderAndBlockTracker();
+    blockTracker?.destroy();
     sinon.restore();
     jest.clearAllMocks();
     nock.enableNetConnect();

packages/network-controller/package.json

@@ -31,27 +31,27 @@
   "dependencies": {
     "@metamask/base-controller": "workspace:^",
     "@metamask/controller-utils": "workspace:^",
+    "@metamask/eth-json-rpc-infura": "^8.0.0",
+    "@metamask/eth-json-rpc-middleware": "^11.0.0",
+    "@metamask/eth-json-rpc-provider": "^1.0.0",
     "@metamask/swappable-obj-proxy": "^2.1.0",
     "@metamask/utils": "^5.0.2",
     "async-mutex": "^0.2.6",
     "babel-runtime": "^6.26.0",
-    "eth-json-rpc-infura": "^5.1.0",
+    "eth-block-tracker": "^7.0.0",
     "eth-query": "^2.1.2",
     "eth-rpc-errors": "^4.0.2",
     "immer": "^9.0.6",
-    "uuid": "^8.3.2",
-    "web3-provider-engine": "^16.0.5"
+    "json-rpc-engine": "^6.1.0",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@json-rpc-specification/meta-schema": "^1.0.6",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eth-json-rpc-provider": "^1.0.0",
     "@types/jest": "^27.4.1",
     "@types/lodash": "^4.14.191",
     "deepmerge": "^4.2.2",
-    "eth-block-tracker": "^7.0.1",
     "jest": "^27.5.1",
-    "json-rpc-engine": "^6.1.0",
     "lodash": "^4.17.21",
     "nock": "^13.0.7",
     "sinon": "^9.2.4",

packages/network-controller/src/NetworkController.ts

@@ -17,8 +17,10 @@ import {
   NetworkType,
   isSafeChainId,
   isNetworkType,
+  toHex,
 } from '@metamask/controller-utils';
 import {
+  Hex,
   assertIsStrictHexString,
   hasProperty,
   isPlainObject,
@@ -257,8 +259,6 @@ export class NetworkController extends BaseControllerV2<
 
   #previousNetworkSpecifier: NetworkType | NetworkConfigurationId | null;
 
-  #provider: Provider | undefined;
-
   #providerProxy: ProviderProxy | undefined;
 
   #blockTrackerProxy: BlockTrackerProxy | undefined;
@@ -320,10 +320,8 @@ export class NetworkController extends BaseControllerV2<
 
   #configureProvider(
     type: NetworkType,
-    rpcTarget?: string,
-    chainId?: string,
-    ticker?: string,
-    nickname?: string,
+    rpcTarget: string | undefined,
+    chainId: string | undefined,
   ) {
     switch (type) {
       case NetworkType.mainnet:
@@ -332,11 +330,22 @@ export class NetworkController extends BaseControllerV2<
         this.#setupInfuraProvider(type);
         break;
       case NetworkType.localhost:
-        this.#setupStandardProvider(LOCALHOST_RPC_URL);
+        if (chainId === undefined) {
+          throw new Error('chainId must be provided for custom RPC endpoints');
+        }
+        this.#setupStandardProvider(LOCALHOST_RPC_URL, toHex(chainId));
         break;
       case NetworkType.rpc:
-        rpcTarget &&
-          this.#setupStandardProvider(rpcTarget, chainId, ticker, nickname);
+        if (chainId === undefined) {
+          throw new Error('chainId must be provided for custom RPC endpoints');
+        }
+
+        if (rpcTarget === undefined) {
+          throw new Error(
+            'rpcTarget must be provided for custom RPC endpoints',
+          );
+        }
+        this.#setupStandardProvider(rpcTarget, toHex(chainId));
         break;
       default:
         throw new Error(`Unrecognized network type: '${type}'`);
@@ -359,16 +368,15 @@ export class NetworkController extends BaseControllerV2<
       state.networkStatus = NetworkStatus.Unknown;
       state.networkDetails = {};
     });
-    const { rpcTarget, type, chainId, ticker } = this.state.providerConfig;
-    this.#configureProvider(type, rpcTarget, chainId, ticker);
+    const { rpcTarget, type, chainId } = this.state.providerConfig;
+    this.#configureProvider(type, rpcTarget, chainId);
     await this.lookupNetwork();
   }
 
   #registerProvider() {
     const { provider } = this.getProviderAndBlockTracker();
 
     if (provider) {
-      provider.on('error', this.#verifyNetwork.bind(this));
       this.#ethQuery = new EthQuery(provider);
     }
   }
@@ -383,54 +391,33 @@ export class NetworkController extends BaseControllerV2<
     this.#updateProvider(provider, blockTracker);
   }
 
-  #setupStandardProvider(
-    rpcTarget: string,
-    chainId?: string,
-    ticker?: string,
-    nickname?: string,
-  ) {
+  #setupStandardProvider(rpcTarget: string, chainId: Hex) {
     const { provider, blockTracker } = createNetworkClient({
       chainId,
-      nickname,
       rpcUrl: rpcTarget,
-      ticker,
       type: NetworkClientType.Custom,
     });
 
     this.#updateProvider(provider, blockTracker);
   }
 
-  #updateProvider(provider: Provider, blockTracker: any) {
-    this.#safelyStopProvider(this.#provider);
+  #updateProvider(provider: Provider, blockTracker: BlockTracker) {
     this.#setProviderAndBlockTracker({
       provider,
       blockTracker,
     });
     this.#registerProvider();
   }
 
-  #safelyStopProvider(provider: Provider | undefined) {
-    setTimeout(() => {
-      provider?.stop();
-    }, 500);
-  }
-
-  async #verifyNetwork() {
-    if (this.state.networkStatus !== NetworkStatus.Available) {
-      await this.lookupNetwork();
-    }
-  }
-
   /**
    * Method to inilialize the provider,
    * Creates the provider and block tracker for the configured network,
    * using the provider to gather details about the network.
    *
    */
   async initializeProvider() {
-    const { type, rpcTarget, chainId, ticker, nickname } =
-      this.state.providerConfig;
-    this.#configureProvider(type, rpcTarget, chainId, ticker, nickname);
+    const { type, rpcTarget, chainId } = this.state.providerConfig;
+    this.#configureProvider(type, rpcTarget, chainId);
     this.#registerProvider();
     await this.lookupNetwork();
   }
@@ -669,7 +656,6 @@ export class NetworkController extends BaseControllerV2<
     } else {
       this.#providerProxy = createEventEmitterProxy(provider);
     }
-    this.#provider = provider;
 
     if (this.#blockTrackerProxy) {
       this.#blockTrackerProxy.setTarget(blockTracker);