Use metamask/json-rpc-engine and metamask/rpc-errors

Author: FrederikBolding

package.json

@@ -37,14 +37,15 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
+    "@metamask/json-rpc-engine": "^7.0.0",
     "@metamask/object-multiplex": "^1.1.0",
     "@metamask/rpc-errors": "^5.1.1",
     "@metamask/safe-event-emitter": "^3.0.0",
+    "@metamask/utils": "^6.2.0",
     "detect-browser": "^5.2.0",
     "extension-port-stream": "^2.0.1",
     "fast-deep-equal": "^3.1.3",
     "is-stream": "^2.0.0",
-    "json-rpc-engine": "^6.1.0",
     "json-rpc-middleware-stream": "^4.2.1",
     "pump": "^3.0.0",
     "webextension-polyfill": "^0.10.0"

src/BaseProvider.ts

@@ -1,14 +1,15 @@
+import { JsonRpcEngine, JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import { rpcErrors, JsonRpcError } from '@metamask/rpc-errors';
 import SafeEventEmitter from '@metamask/safe-event-emitter';
-import { ethErrors, EthereumRpcError } from 'eth-rpc-errors';
-import dequal from 'fast-deep-equal';
 import {
-  JsonRpcEngine,
   JsonRpcRequest,
   JsonRpcId,
-  JsonRpcVersion,
+  JsonRpcVersion2,
   JsonRpcSuccess,
-  JsonRpcMiddleware,
-} from 'json-rpc-engine';
+  JsonRpcParams,
+  Json,
+} from '@metamask/utils';
+import dequal from 'fast-deep-equal';
 
 import messages from './messages';
 import {
@@ -20,7 +21,7 @@ import {
 
 export type UnvalidatedJsonRpcRequest = {
   id?: JsonRpcId;
-  jsonrpc?: JsonRpcVersion;
+  jsonrpc?: JsonRpcVersion2;
   method: string;
   params?: unknown;
 };
@@ -37,10 +38,10 @@ export type BaseProviderOptions = {
   maxEventListeners?: number;
 
   /**
-   * `json-rpc-engine` middleware. The middleware will be inserted in the given
+   * `@metamask/json-rpc-engine` middleware. The middleware will be inserted in the given
    * order immediately after engine initialization.
    */
-  rpcMiddleware?: JsonRpcMiddleware<unknown, unknown>[];
+  rpcMiddleware?: JsonRpcMiddleware<JsonRpcParams, Json>[];
 };
 
 export type RequestArguments = {
@@ -169,7 +170,7 @@ export abstract class BaseProvider extends SafeEventEmitter {
    */
   async request<T>(args: RequestArguments): Promise<Maybe<T>> {
     if (!args || typeof args !== 'object' || Array.isArray(args)) {
-      throw ethErrors.rpc.invalidRequest({
+      throw rpcErrors.invalidRequest({
         message: messages.errors.invalidRequestArgs(),
         data: args,
       });
@@ -178,7 +179,7 @@ export abstract class BaseProvider extends SafeEventEmitter {
     const { method, params } = args;
 
     if (typeof method !== 'string' || method.length === 0) {
-      throw ethErrors.rpc.invalidRequest({
+      throw rpcErrors.invalidRequest({
         message: messages.errors.invalidRequestMethod(),
         data: args,
       });
@@ -189,7 +190,7 @@ export abstract class BaseProvider extends SafeEventEmitter {
       !Array.isArray(params) &&
       (typeof params !== 'object' || params === null)
     ) {
-      throw ethErrors.rpc.invalidRequest({
+      throw rpcErrors.invalidRequest({
         message: messages.errors.invalidRequestParams(),
         data: args,
       });
@@ -285,15 +286,9 @@ export abstract class BaseProvider extends SafeEventEmitter {
           callback(error, response);
         };
       }
-      return this._rpcEngine.handle(
-        payload as JsonRpcRequest<unknown>,
-        callbackWrapper,
-      );
+      return this._rpcEngine.handle(payload as JsonRpcRequest, callbackWrapper);
     }
-    return this._rpcEngine.handle(
-      payload as JsonRpcRequest<unknown>[],
-      callbackWrapper,
-    );
+    return this._rpcEngine.handle(payload as JsonRpcRequest[], callbackWrapper);
   }
 
   /**
@@ -331,13 +326,13 @@ export abstract class BaseProvider extends SafeEventEmitter {
 
       let error;
       if (isRecoverable) {
-        error = new EthereumRpcError(
+        error = new JsonRpcError(
           1013, // Try again later
           errorMessage ?? messages.errors.disconnected(),
         );
         this._log.debug(error);
       } else {
-        error = new EthereumRpcError(
+        error = new JsonRpcError(
           1011, // Internal error
           errorMessage ?? messages.errors.permanentlyDisconnected(),
         );

src/MetaMaskInpageProvider.test.ts

@@ -1,4 +1,4 @@
-import { JsonRpcRequest } from 'json-rpc-engine';
+import { JsonRpcRequest } from '@metamask/utils';
 
 import messages from './messages';
 import {
@@ -58,7 +58,7 @@ async function getInitializedProvider({
   onMethodCalled?: {
     substream: string;
     method: string;
-    callback: (data: JsonRpcRequest<unknown>) => void;
+    callback: (data: JsonRpcRequest) => void;
   }[];
 } = {}): Promise<InitializedProviderDetails> {
   const onWrite = jest.fn();

src/MetaMaskInpageProvider.ts

@@ -1,8 +1,8 @@
-import { ethErrors } from 'eth-rpc-errors';
-import type { JsonRpcRequest, JsonRpcResponse } from 'json-rpc-engine';
+import { rpcErrors } from '@metamask/rpc-errors';
+import type { Json, JsonRpcRequest, JsonRpcResponse } from '@metamask/utils';
 import type { Duplex } from 'stream';
 
-import type { UnvalidatedJsonRpcRequest } from './BaseProvider';
+import { UnvalidatedJsonRpcRequest } from './BaseProvider';
 import messages from './messages';
 import { sendSiteMetadata } from './siteMetadata';
 import {
@@ -22,7 +22,7 @@ export type SendSyncJsonRpcRequest = {
     | 'eth_coinbase'
     | 'eth_uninstallFilter'
     | 'net_version';
-} & JsonRpcRequest<unknown>;
+} & JsonRpcRequest;
 
 type WarningEventName = keyof SentWarningsState['events'];
 
@@ -171,8 +171,8 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
    * @param callback - The callback function.
    */
   sendAsync(
-    payload: JsonRpcRequest<unknown>,
-    callback: (error: Error | null, result?: JsonRpcResponse<unknown>) => void,
+    payload: JsonRpcRequest,
+    callback: (error: Error | null, result?: JsonRpcResponse<Json>) => void,
   ): void {
     this._rpcRequest(payload, callback);
   }
@@ -283,7 +283,10 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
    * @returns A Promise that resolves with the JSON-RPC response object for the
    * request.
    */
-  send<T>(method: string, params?: T[]): Promise<JsonRpcResponse<T>>;
+  send<T extends Json>(
+    method: string,
+    params?: T[],
+  ): Promise<JsonRpcResponse<T>>;
 
   /**
    * Submits an RPC request per the given JSON-RPC request object.
@@ -293,8 +296,8 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
    * @param callback - An error-first callback that will receive the JSON-RPC
    * response object.
    */
-  send<T>(
-    payload: JsonRpcRequest<unknown>,
+  send<T extends Json>(
+    payload: JsonRpcRequest,
     callback: (error: Error | null, result?: JsonRpcResponse<T>) => void,
   ): void;
 
@@ -306,7 +309,7 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
    * @param payload - A JSON-RPC request object.
    * @returns A JSON-RPC response object.
    */
-  send<T>(payload: SendSyncJsonRpcRequest): JsonRpcResponse<T>;
+  send<T extends Json>(payload: SendSyncJsonRpcRequest): JsonRpcResponse<T>;
 
   // eslint-disable-next-line @typescript-eslint/promise-function-async
   send(methodOrPayload: unknown, callbackOrArgs?: unknown): unknown {
@@ -335,7 +338,7 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
       typeof callbackOrArgs === 'function'
     ) {
       return this._rpcRequest(
-        methodOrPayload as JsonRpcRequest<unknown>,
+        methodOrPayload as JsonRpcRequest,
         callbackOrArgs as (...args: unknown[]) => void,
       );
     }
@@ -412,7 +415,7 @@ export class MetaMaskInpageProvider extends AbstractStreamProvider {
          */
         requestBatch: async (requests: UnvalidatedJsonRpcRequest[]) => {
           if (!Array.isArray(requests)) {
-            throw ethErrors.rpc.invalidRequest({
+            throw rpcErrors.invalidRequest({
               message:
                 'Batch requests must be made with an array of request objects.',
               data: requests,

src/StreamProvider.test.ts

@@ -1,4 +1,5 @@
-import type { JsonRpcMiddleware } from 'json-rpc-engine';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import { Json, JsonRpcParams } from '@metamask/utils';
 
 import messages from './messages';
 import { StreamProvider } from './StreamProvider';
@@ -15,7 +16,7 @@ const mockStreamName = 'mock-stream';
  * @returns A tuple containing the StreamProvider instance and the mock stream.
  */
 function getStreamProvider(
-  rpcMiddleware: JsonRpcMiddleware<unknown, unknown>[] = [],
+  rpcMiddleware: JsonRpcMiddleware<JsonRpcParams, Json>[] = [],
 ) {
   const mockStream = new MockConnectionStream();
   const streamProvider = new StreamProvider(mockStream, {

src/StreamProvider.ts

@@ -1,7 +1,8 @@
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 import ObjectMultiplex from '@metamask/object-multiplex';
 import SafeEventEmitter from '@metamask/safe-event-emitter';
+import { Json, JsonRpcParams } from '@metamask/utils';
 import { duplex as isDuplex } from 'is-stream';
-import type { JsonRpcMiddleware } from 'json-rpc-engine';
 import { createStreamMiddleware } from 'json-rpc-middleware-stream';
 import pump from 'pump';
 import type { Duplex } from 'stream';
@@ -23,7 +24,7 @@ export type StreamProviderOptions = {
 
 export type JsonRpcConnection = {
   events: SafeEventEmitter;
-  middleware: JsonRpcMiddleware<unknown, unknown>;
+  middleware: JsonRpcMiddleware<JsonRpcParams, Json>;
   stream: Duplex;
 };
 

src/extension-provider/createExternalExtensionProvider.test.ts

@@ -1,4 +1,4 @@
-import type { JsonRpcRequest } from 'json-rpc-engine';
+import type { JsonRpcRequest } from '@metamask/utils';
 
 import { createExternalExtensionProvider } from './createExternalExtensionProvider';
 import config from './external-extension-config.json';
@@ -49,7 +49,7 @@ async function getInitializedProvider({
   onMethodCalled?: {
     substream: string;
     method: string;
-    callback: (data: JsonRpcRequest<unknown>) => void;
+    callback: (data: JsonRpcRequest) => void;
   }[];
 } = {}): Promise<InitializedExtensionProviderDetails> {
   const onWrite = jest.fn();

src/middleware/createRpcWarningMiddleware.test.ts

@@ -1,4 +1,5 @@
-import { JsonRpcEngine, JsonRpcFailure, JsonRpcSuccess } from 'json-rpc-engine';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import { Json, JsonRpcFailure, JsonRpcSuccess } from '@metamask/utils';
 
 import { createRpcWarningMiddleware } from './createRpcWarningMiddleware';
 import messages from '../messages';
@@ -89,7 +90,7 @@ describe('createRpcWarningMiddleware', () => {
         jsonrpc: '2.0',
         id: 1,
         method,
-      })) as JsonRpcSuccess<unknown>;
+      })) as JsonRpcSuccess<Json>;
 
       expect(response.result).toBe('success!');
     });
@@ -138,7 +139,7 @@ describe('createRpcWarningMiddleware', () => {
         id: 1,
         method,
         params,
-      })) as JsonRpcSuccess<unknown>;
+      })) as JsonRpcSuccess<Json>;
 
       expect(response.result).toBe('success!');
     });

src/middleware/createRpcWarningMiddleware.ts

@@ -1,4 +1,5 @@
-import type { JsonRpcMiddleware, JsonRpcRequest } from 'json-rpc-engine';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
 
 import { ERC1155, ERC721 } from '../constants';
 import messages from '../messages';
@@ -12,7 +13,7 @@ import type { ConsoleLike } from '../utils';
  */
 export function createRpcWarningMiddleware(
   log: ConsoleLike,
-): JsonRpcMiddleware<unknown, unknown> {
+): JsonRpcMiddleware<JsonRpcParams, Json> {
   const sentWarnings = {
     ethDecryptDeprecation: false,
     ethGetEncryptionPublicKeyDeprecation: false,

src/siteMetadata.ts

@@ -1,4 +1,4 @@
-import { JsonRpcEngine } from 'json-rpc-engine';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 
 import messages from './messages';
 import { ConsoleLike, NOOP } from './utils';