refactor: Update network client provider type

Author: rekmarks

package.json

@@ -63,6 +63,7 @@
     "@metamask/eth-block-tracker": "^14.0.0",
     "@metamask/eth-json-rpc-provider": "^5.0.1",
     "@metamask/json-rpc-engine": "^10.1.1",
+    "@metamask/network-controller": "^25.0.0",
     "@metamask/utils": "^11.8.1",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^27.4.1",

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

@@ -173,7 +173,7 @@ export function createNetworkClient({
 
   engine.push(networkMiddleware);
 
-  const provider = new InternalProvider({ engine });
+  const provider: Provider = new InternalProvider({ engine });
 
   const destroy = () => {
     // TODO: Either fix this lint violation or explain why it's necessary to ignore.

packages/network-controller/src/types.ts

@@ -1,9 +1,14 @@
 import type { InfuraNetworkType, ChainId } from '@metamask/controller-utils';
 import type { BlockTracker as BaseBlockTracker } from '@metamask/eth-block-tracker';
 import type { InternalProvider } from '@metamask/eth-json-rpc-provider';
+import type { MiddlewareContext } from '@metamask/json-rpc-engine/v2';
 import type { Hex } from '@metamask/utils';
 
-export type Provider = InternalProvider;
+export type Provider = InternalProvider<
+  MiddlewareContext<
+    { origin: string; skipCache: boolean } & Record<string, unknown>
+  >
+>;
 
 export type BlockTracker = BaseBlockTracker & {
   checkForLatestBlock(): Promise<string>;

packages/network-controller/tests/NetworkController.test.ts

@@ -13,6 +13,7 @@ import {
   NetworkType,
   toHex,
 } from '@metamask/controller-utils';
+import type { InternalProvider } from '@metamask/eth-json-rpc-provider';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { Hex } from '@metamask/utils';
 import assert from 'assert';
@@ -16639,7 +16640,9 @@ function buildFakeClient(
       rpcUrl: 'https://test.network',
     },
     provider,
-    blockTracker: new FakeBlockTracker({ provider }),
+    blockTracker: new FakeBlockTracker({
+      provider: provider as unknown as InternalProvider,
+    }),
     destroy: () => {
       // do nothing
     },

packages/network-controller/tests/helpers.ts

@@ -6,6 +6,7 @@ import {
   toHex,
 } from '@metamask/controller-utils';
 import type { ErrorReportingServiceCaptureExceptionAction } from '@metamask/error-reporting-service';
+import type { InternalProvider } from '@metamask/eth-json-rpc-provider';
 import {
   Messenger,
   type MockAnyNamespace,
@@ -154,7 +155,9 @@ function buildFakeNetworkClient({
   return {
     configuration,
     provider,
-    blockTracker: new FakeBlockTracker({ provider }),
+    blockTracker: new FakeBlockTracker({
+      provider: provider as unknown as InternalProvider,
+    }),
     destroy: () => {
       // do nothing
     },

packages/network-controller/tests/network-client/helpers.ts

@@ -2,7 +2,6 @@ import type { JSONRPCResponse } from '@json-rpc-specification/meta-schema';
 import type { InfuraNetworkType } from '@metamask/controller-utils';
 import { BUILT_IN_NETWORKS } from '@metamask/controller-utils';
 import type { BlockTracker } from '@metamask/eth-block-tracker';
-import type { InternalProvider } from '@metamask/eth-json-rpc-provider';
 import EthQuery from '@metamask/eth-query';
 import type { Hex } from '@metamask/utils';
 import nock, { isDone as nockIsDone } from 'nock';
@@ -11,7 +10,7 @@ import { useFakeTimers } from 'sinon';
 
 import { createNetworkClient } from '../../src/create-network-client';
 import type { NetworkControllerOptions } from '../../src/NetworkController';
-import type { NetworkClientConfiguration } from '../../src/types';
+import type { NetworkClientConfiguration, Provider } from '../../src/types';
 import { NetworkClientType } from '../../src/types';
 import type { RootMessenger } from '../helpers';
 import {
@@ -390,7 +389,7 @@ export async function withMockedCommunications(
 
 type MockNetworkClient = {
   blockTracker: BlockTracker;
-  provider: InternalProvider;
+  provider: Provider;
   clock: sinon.SinonFakeTimers;
   // TODO: Replace `any` with type
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

tests/fake-provider.ts

@@ -1,9 +1,16 @@
 import { InternalProvider } from '@metamask/eth-json-rpc-provider';
-import { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import {
+  JsonRpcEngineV2,
+  type JsonRpcMiddleware,
+  type MiddlewareContext,
+  type ResultConstraint,
+} from '@metamask/json-rpc-engine/v2';
+import type { Provider } from '@metamask/network-controller';
 import type {
   Json,
   JsonRpcId,
   JsonRpcParams,
+  JsonRpcRequest,
   JsonRpcResponse,
   JsonRpcVersion2,
 } from '@metamask/utils';
@@ -91,6 +98,15 @@ type FakeProviderEngineOptions = {
   stubs?: FakeProviderStub[];
 };
 
+type Context = MiddlewareContext<
+  { origin: string; skipCache: boolean } & Record<string, unknown>
+>;
+type Middleware = JsonRpcMiddleware<
+  JsonRpcRequest,
+  ResultConstraint<JsonRpcRequest>,
+  Context
+>;
+
 /**
  * An implementation of the provider that NetworkController exposes, which is
  * actually an instance of InternalProvider (from the
@@ -102,7 +118,10 @@ type FakeProviderEngineOptions = {
 // NOTE: We shouldn't need to extend from the "real" provider here, but
 // we'd need a `InternalProvider` _interface_ and that doesn't exist (at
 // least not yet).
-export class FakeProvider extends InternalProvider {
+export class FakeProvider
+  extends InternalProvider<Context>
+  implements Provider
+{
   calledStubs: FakeProviderStub[];
 
   #originalStubs: FakeProviderStub[];
@@ -117,7 +136,15 @@ export class FakeProvider extends InternalProvider {
    * of specific invocations of `request` matching a `method`.
    */
   constructor({ stubs = [] }: FakeProviderEngineOptions = {}) {
-    super({ engine: new JsonRpcEngine() });
+    super({
+      engine: JsonRpcEngineV2.create<Middleware>({
+        middleware: [
+          () => {
+            throw new Error('FakeProvider received unstubbed method call');
+          },
+        ],
+      }),
+    });
     this.#originalStubs = stubs;
     this.#stubs = this.#originalStubs.slice();
     this.calledStubs = [];

yarn.lock

@@ -3190,6 +3190,7 @@ __metadata:
     "@metamask/eth-block-tracker": "npm:^14.0.0"
     "@metamask/eth-json-rpc-provider": "npm:^5.0.1"
     "@metamask/json-rpc-engine": "npm:^10.1.1"
+    "@metamask/network-controller": "npm:^25.0.0"
     "@metamask/utils": "npm:^11.8.1"
     "@ts-bridge/cli": "npm:^0.6.4"
     "@types/jest": "npm:^27.4.1"