WIP: refactor: Migrate create-network-client

Author: rekmarks

packages/network-controller/src/create-network-client.ts

@@ -17,14 +17,16 @@ import {
   providerFromEngine,
   providerFromMiddleware,
 } from '@metamask/eth-json-rpc-provider';
+import { asV2Middleware, JsonRpcEngine } from '@metamask/json-rpc-engine';
 import {
-  createAsyncMiddleware,
   createScaffoldMiddleware,
-  JsonRpcEngine,
-  mergeMiddleware,
-} from '@metamask/json-rpc-engine';
-import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
-import type { Hex, Json, JsonRpcParams } from '@metamask/utils';
+  JsonRpcEngineV2,
+} from '@metamask/json-rpc-engine/v2';
+import type {
+  JsonRpcMiddleware,
+  MiddlewareContext,
+} from '@metamask/json-rpc-engine/v2';
+import type { Hex, Json, JsonRpcRequest } from '@metamask/utils';
 import type { Logger } from 'loglevel';
 
 import type { NetworkControllerMessenger } from './NetworkController';
@@ -50,6 +52,12 @@ export type NetworkClient = {
   destroy: () => void;
 };
 
+type RpcApiMiddleware = JsonRpcMiddleware<
+  JsonRpcRequest,
+  Json,
+  MiddlewareContext<{ origin: string }>
+>;
+
 /**
  * Create a JSON RPC network client for a specific network.
  *
@@ -137,16 +145,23 @@ export function createNetworkClient({
     });
   });
 
-  const rpcApiMiddleware =
-    configuration.type === NetworkClientType.Infura
-      ? createInfuraMiddleware({
-          rpcService: rpcServiceChain,
-          options: {
-            source: 'metamask',
-          },
-        })
-      : createFetchMiddleware({ rpcService: rpcServiceChain });
+  let rpcApiMiddleware: RpcApiMiddleware;
+  if (configuration.type === NetworkClientType.Infura) {
+    const infuraEngine = new JsonRpcEngine();
+    infuraEngine.push(
+      createInfuraMiddleware({
+        rpcService: rpcServiceChain,
+        options: {
+          source: 'metamask',
+        },
+      }),
+    );
+    rpcApiMiddleware = asV2Middleware(infuraEngine) as RpcApiMiddleware;
+  } else {
+    rpcApiMiddleware = createFetchMiddleware({ rpcService: rpcServiceChain });
+  }
 
+  // TODO:next Need eth-json-rpc-provider V2 migration
   const rpcProvider = providerFromMiddleware(rpcApiMiddleware);
 
   const blockTracker = createBlockTracker({
@@ -170,10 +185,11 @@ export function createNetworkClient({
           rpcApiMiddleware,
         });
 
-  const engine = new JsonRpcEngine();
-
-  engine.push(networkMiddleware);
+  const engine = JsonRpcEngineV2.create({
+    middleware: [networkMiddleware],
+  });
 
+  // TODO:next Need eth-json-rpc-provider V2 migration
   const provider = providerFromEngine(engine);
 
   const destroy = () => {
@@ -241,17 +257,19 @@ function createInfuraNetworkMiddleware({
   blockTracker: PollingBlockTracker;
   network: InfuraNetworkType;
   rpcProvider: SafeEventEmitterProvider;
-  rpcApiMiddleware: JsonRpcMiddleware<JsonRpcParams, Json>;
+  rpcApiMiddleware: RpcApiMiddleware;
 }) {
-  return mergeMiddleware([
-    createNetworkAndChainIdMiddleware({ network }),
-    createBlockCacheMiddleware({ blockTracker }),
-    createInflightCacheMiddleware(),
-    createBlockRefMiddleware({ blockTracker, provider: rpcProvider }),
-    createRetryOnEmptyMiddleware({ blockTracker, provider: rpcProvider }),
-    createBlockTrackerInspectorMiddleware({ blockTracker }),
-    rpcApiMiddleware,
-  ]);
+  return JsonRpcEngineV2.create({
+    middleware: [
+      createNetworkAndChainIdMiddleware({ network }),
+      createBlockCacheMiddleware({ blockTracker }),
+      createInflightCacheMiddleware(),
+      createBlockRefMiddleware({ blockTracker, provider: rpcProvider }),
+      createRetryOnEmptyMiddleware({ blockTracker, provider: rpcProvider }),
+      createBlockTrackerInspectorMiddleware({ blockTracker }),
+      rpcApiMiddleware,
+    ],
+  }).asMiddleware();
 }
 
 /**
@@ -275,11 +293,10 @@ function createNetworkAndChainIdMiddleware({
 
 const createChainIdMiddleware = (
   chainId: Hex,
-): JsonRpcMiddleware<JsonRpcParams, Json> => {
-  return (req, res, next, end) => {
-    if (req.method === 'eth_chainId') {
-      res.result = chainId;
-      return end();
+): JsonRpcMiddleware<JsonRpcRequest, Json> => {
+  return ({ request, next }) => {
+    if (request.method === 'eth_chainId') {
+      return chainId;
     }
     return next();
   };
@@ -301,21 +318,23 @@ function createCustomNetworkMiddleware({
 }: {
   blockTracker: PollingBlockTracker;
   chainId: Hex;
-  rpcApiMiddleware: JsonRpcMiddleware<JsonRpcParams, Json>;
-}): JsonRpcMiddleware<JsonRpcParams, Json> {
+  rpcApiMiddleware: RpcApiMiddleware;
+}) {
   const testMiddlewares = process.env.IN_TEST
     ? [createEstimateGasDelayTestMiddleware()]
     : [];
 
-  return mergeMiddleware([
-    ...testMiddlewares,
-    createChainIdMiddleware(chainId),
-    createBlockRefRewriteMiddleware({ blockTracker }),
-    createBlockCacheMiddleware({ blockTracker }),
-    createInflightCacheMiddleware(),
-    createBlockTrackerInspectorMiddleware({ blockTracker }),
-    rpcApiMiddleware,
-  ]);
+  return JsonRpcEngineV2.create({
+    middleware: [
+      ...testMiddlewares,
+      createChainIdMiddleware(chainId),
+      createBlockRefRewriteMiddleware({ blockTracker }),
+      createBlockCacheMiddleware({ blockTracker }),
+      createInflightCacheMiddleware(),
+      createBlockTrackerInspectorMiddleware({ blockTracker }),
+      rpcApiMiddleware,
+    ],
+  }).asMiddleware();
 }
 
 /**
@@ -324,11 +343,14 @@ function createCustomNetworkMiddleware({
  *
  * @returns The middleware for delaying gas estimation calls by 2 seconds when in test.
  */
-function createEstimateGasDelayTestMiddleware() {
-  return createAsyncMiddleware(async (req, _, next) => {
-    if (req.method === 'eth_estimateGas') {
+function createEstimateGasDelayTestMiddleware(): JsonRpcMiddleware<
+  JsonRpcRequest,
+  Json
+> {
+  return async ({ request, next }) => {
+    if (request.method === 'eth_estimateGas') {
       await new Promise((resolve) => setTimeout(resolve, SECOND * 2));
     }
     return next();
-  });
+  };
 }