refactor: Rewrite wallet

Author: rekmarks

eslint-warning-thresholds.json

@@ -154,7 +154,6 @@
     "@typescript-eslint/no-explicit-any": 1
   },
   "packages/eth-json-rpc-middleware/src/block-cache.ts": {
-    "@typescript-eslint/no-explicit-any": 1,
     "jsdoc/require-jsdoc": 1,
     "no-restricted-syntax": 1
   },
@@ -180,13 +179,13 @@
     "jsdoc/match-description": 4
   },
   "packages/eth-json-rpc-middleware/src/methods/wallet-request-execution-permissions.ts": {
-    "jsdoc/require-jsdoc": 2
+    "jsdoc/require-jsdoc": 1
   },
   "packages/eth-json-rpc-middleware/src/methods/wallet-revoke-execution-permission.ts": {
     "jsdoc/require-jsdoc": 1
   },
   "packages/eth-json-rpc-middleware/src/providerAsMiddleware.ts": {
-    "jsdoc/require-jsdoc": 1
+    "jsdoc/require-jsdoc": 2
   },
   "packages/eth-json-rpc-middleware/src/retryOnEmpty.test.ts": {
     "jsdoc/match-description": 3
@@ -213,7 +212,6 @@
     "jsdoc/require-jsdoc": 4
   },
   "packages/eth-json-rpc-middleware/src/wallet.ts": {
-    "@typescript-eslint/no-explicit-any": 2,
     "@typescript-eslint/prefer-nullish-coalescing": 5,
     "jsdoc/match-description": 3,
     "jsdoc/require-jsdoc": 12
@@ -224,7 +222,7 @@
   },
   "packages/eth-json-rpc-middleware/test/util/helpers.ts": {
     "@typescript-eslint/no-explicit-any": 5,
-    "jsdoc/match-description": 11
+    "jsdoc/match-description": 10
   },
   "packages/eth-json-rpc-provider/src/safe-event-emitter-provider.test.ts": {
     "import-x/namespace": 1

packages/eth-json-rpc-middleware/src/block-cache.ts

@@ -3,7 +3,7 @@ import type {
   JsonRpcMiddleware,
   MiddlewareContext,
 } from '@metamask/json-rpc-engine/v2';
-import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
+import type { Json, JsonRpcRequest } from '@metamask/utils';
 
 import { projectLogger, createModuleLogger } from './logging-utils';
 import type {

packages/eth-json-rpc-middleware/src/block-ref.test.ts

@@ -1,4 +1,5 @@
 import { MiddlewareContext } from '@metamask/json-rpc-engine/v2';
+
 import { createBlockRefMiddleware } from '.';
 import {
   createMockParamsWithBlockParamAt,

packages/eth-json-rpc-middleware/src/methods/wallet-request-execution-permissions.test.ts

@@ -1,12 +1,13 @@
-import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';
+import type { MiddlewareParams } from '@metamask/json-rpc-engine/v2';
+import type { JsonRpcRequest } from '@metamask/utils';
 import { klona } from 'klona';
 
 import type {
   ProcessRequestExecutionPermissionsHook,
   RequestExecutionPermissionsRequestParams,
   RequestExecutionPermissionsResult,
 } from './wallet-request-execution-permissions';
-import { walletRequestExecutionPermissions } from './wallet-request-execution-permissions';
+import { createWalletRequestExecutionPermissionsHandler } from './wallet-request-execution-permissions';
 
 const ADDRESS_MOCK = '0x123abc123abc123abc123abc123abc123abc123a';
 const CHAIN_ID_MOCK = '0x1';
@@ -66,22 +67,21 @@ const RESULT_MOCK: RequestExecutionPermissionsResult = [
 describe('wallet_requestExecutionPermissions', () => {
   let request: JsonRpcRequest;
   let params: RequestExecutionPermissionsRequestParams;
-  let response: PendingJsonRpcResponse;
   let processRequestExecutionPermissionsMock: jest.MockedFunction<ProcessRequestExecutionPermissionsHook>;
 
   const callMethod = async () => {
-    return walletRequestExecutionPermissions(request, response, {
+    const handler = createWalletRequestExecutionPermissionsHandler({
       processRequestExecutionPermissions:
         processRequestExecutionPermissionsMock,
     });
+    return handler({ request } as MiddlewareParams<JsonRpcRequest>);
   };
 
   beforeEach(() => {
     jest.resetAllMocks();
 
     request = klona(REQUEST_MOCK);
     params = request.params as RequestExecutionPermissionsRequestParams;
-    response = {} as PendingJsonRpcResponse;
 
     processRequestExecutionPermissionsMock = jest.fn();
     processRequestExecutionPermissionsMock.mockResolvedValue(RESULT_MOCK);
@@ -96,8 +96,8 @@ describe('wallet_requestExecutionPermissions', () => {
   });
 
   it('returns result from hook', async () => {
-    await callMethod();
-    expect(response.result).toStrictEqual(RESULT_MOCK);
+    const result = await callMethod();
+    expect(result).toStrictEqual(RESULT_MOCK);
   });
 
   it('supports null rules', async () => {
@@ -124,7 +124,9 @@ describe('wallet_requestExecutionPermissions', () => {
 
   it('throws if no hook', async () => {
     await expect(
-      walletRequestExecutionPermissions(request, response, {}),
+      createWalletRequestExecutionPermissionsHandler({})({
+        request,
+      } as MiddlewareParams<JsonRpcRequest>),
     ).rejects.toThrow(
       `wallet_requestExecutionPermissions - no middleware configured`,
     );

packages/eth-json-rpc-middleware/src/methods/wallet-request-execution-permissions.ts

@@ -1,3 +1,4 @@
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { Infer } from '@metamask/superstruct';
 import {
@@ -16,7 +17,6 @@ import {
   type Hex,
   type Json,
   type JsonRpcRequest,
-  type PendingJsonRpcResponse,
   StrictHexStruct,
 } from '@metamask/utils';
 
@@ -66,24 +66,22 @@ export type ProcessRequestExecutionPermissionsHook = (
   req: JsonRpcRequest,
 ) => Promise<RequestExecutionPermissionsResult>;
 
-export async function walletRequestExecutionPermissions(
-  req: JsonRpcRequest,
-  res: PendingJsonRpcResponse,
-  {
-    processRequestExecutionPermissions,
-  }: {
-    processRequestExecutionPermissions?: ProcessRequestExecutionPermissionsHook;
-  },
-): Promise<void> {
-  if (!processRequestExecutionPermissions) {
-    throw rpcErrors.methodNotSupported(
-      'wallet_requestExecutionPermissions - no middleware configured',
-    );
-  }
+export function createWalletRequestExecutionPermissionsHandler({
+  processRequestExecutionPermissions,
+}: {
+  processRequestExecutionPermissions?: ProcessRequestExecutionPermissionsHook;
+}): JsonRpcMiddleware<JsonRpcRequest, Json> {
+  return async ({ request }) => {
+    if (!processRequestExecutionPermissions) {
+      throw rpcErrors.methodNotSupported(
+        'wallet_requestExecutionPermissions - no middleware configured',
+      );
+    }
 
-  const { params } = req;
+    const { params } = request;
 
-  validateParams(params, RequestExecutionPermissionsStruct);
+    validateParams(params, RequestExecutionPermissionsStruct);
 
-  res.result = await processRequestExecutionPermissions(params, req);
+    return await processRequestExecutionPermissions(params, request);
+  };
 }

packages/eth-json-rpc-middleware/src/methods/wallet-revoke-execution-permission.test.ts

@@ -1,11 +1,12 @@
-import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';
+import type { MiddlewareParams } from '@metamask/json-rpc-engine/v2';
+import type { JsonRpcRequest } from '@metamask/utils';
 import { klona } from 'klona';
 
 import type {
   ProcessRevokeExecutionPermissionHook,
   RevokeExecutionPermissionRequestParams,
 } from './wallet-revoke-execution-permission';
-import { walletRevokeExecutionPermission } from './wallet-revoke-execution-permission';
+import { createWalletRevokeExecutionPermissionHandler } from './wallet-revoke-execution-permission';
 
 const HEX_MOCK = '0x123abc';
 
@@ -18,21 +19,20 @@ const REQUEST_MOCK = {
 describe('wallet_revokeExecutionPermission', () => {
   let request: JsonRpcRequest<RevokeExecutionPermissionRequestParams>;
   let params: RevokeExecutionPermissionRequestParams;
-  let response: PendingJsonRpcResponse;
   let processRevokeExecutionPermissionMock: jest.MockedFunction<ProcessRevokeExecutionPermissionHook>;
 
   const callMethod = async () => {
-    return walletRevokeExecutionPermission(request, response, {
+    const handler = createWalletRevokeExecutionPermissionHandler({
       processRevokeExecutionPermission: processRevokeExecutionPermissionMock,
     });
+    return handler({ request } as MiddlewareParams<JsonRpcRequest>);
   };
 
   beforeEach(() => {
     jest.resetAllMocks();
 
     request = klona(REQUEST_MOCK);
     params = request.params as RevokeExecutionPermissionRequestParams;
-    response = {} as PendingJsonRpcResponse;
 
     processRevokeExecutionPermissionMock = jest.fn();
     processRevokeExecutionPermissionMock.mockResolvedValue({});
@@ -47,13 +47,15 @@ describe('wallet_revokeExecutionPermission', () => {
   });
 
   it('returns result from hook', async () => {
-    await callMethod();
-    expect(response.result).toStrictEqual({});
+    const result = await callMethod();
+    expect(result).toStrictEqual({});
   });
 
   it('throws if no hook', async () => {
     await expect(
-      walletRevokeExecutionPermission(request, response, {}),
+      createWalletRevokeExecutionPermissionHandler({})({
+        request,
+      } as MiddlewareParams<JsonRpcRequest>),
     ).rejects.toThrow(
       'wallet_revokeExecutionPermission - no middleware configured',
     );

packages/eth-json-rpc-middleware/src/methods/wallet-revoke-execution-permission.ts

@@ -1,11 +1,9 @@
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { Infer } from '@metamask/superstruct';
-import {
-  type JsonRpcRequest,
-  object,
-  type PendingJsonRpcResponse,
-  StrictHexStruct,
-} from '@metamask/utils';
+import { object } from '@metamask/superstruct';
+import type { Json } from '@metamask/utils';
+import { type JsonRpcRequest, StrictHexStruct } from '@metamask/utils';
 
 import { validateParams } from '../utils/validation';
 
@@ -28,24 +26,22 @@ export type ProcessRevokeExecutionPermissionHook = (
   req: JsonRpcRequest,
 ) => Promise<RevokeExecutionPermissionResult>;
 
-export async function walletRevokeExecutionPermission(
-  req: JsonRpcRequest,
-  res: PendingJsonRpcResponse,
-  {
-    processRevokeExecutionPermission,
-  }: {
-    processRevokeExecutionPermission?: ProcessRevokeExecutionPermissionHook;
-  },
-): Promise<void> {
-  if (!processRevokeExecutionPermission) {
-    throw rpcErrors.methodNotSupported(
-      'wallet_revokeExecutionPermission - no middleware configured',
-    );
-  }
-
-  const { params } = req;
-
-  validateParams(params, RevokeExecutionPermissionRequestParamsStruct);
-
-  res.result = await processRevokeExecutionPermission(params, req);
+export function createWalletRevokeExecutionPermissionHandler({
+  processRevokeExecutionPermission,
+}: {
+  processRevokeExecutionPermission?: ProcessRevokeExecutionPermissionHook;
+}): JsonRpcMiddleware<JsonRpcRequest, Json> {
+  return async ({ request }) => {
+    if (!processRevokeExecutionPermission) {
+      throw rpcErrors.methodNotSupported(
+        'wallet_revokeExecutionPermission - no middleware configured',
+      );
+    }
+
+    const { params } = request;
+
+    validateParams(params, RevokeExecutionPermissionRequestParamsStruct);
+
+    return await processRevokeExecutionPermission(params, request);
+  };
 }

packages/eth-json-rpc-middleware/src/providerAsMiddleware.test.ts

@@ -1,15 +1,19 @@
 import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
 import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import { JsonRpcEngineV2 } from '@metamask/json-rpc-engine/v2';
-import { assertIsJsonRpcSuccess, Json } from '@metamask/utils';
+import type { Json } from '@metamask/utils';
+import { assertIsJsonRpcSuccess } from '@metamask/utils';
 
-import { providerAsMiddleware, providerAsMiddlewareV2 } from './providerAsMiddleware';
+import {
+  providerAsMiddleware,
+  providerAsMiddlewareV2,
+} from './providerAsMiddleware';
 import { createRequest } from '../test/util/helpers';
 
 const createMockProvider = (result: Json): SafeEventEmitterProvider =>
   ({
     request: jest.fn().mockResolvedValue(result),
-  } as unknown as SafeEventEmitterProvider);
+  }) as unknown as SafeEventEmitterProvider;
 
 describe('providerAsMiddleware', () => {
   it('forwards requests to the provider and returns the result', async () => {
@@ -29,7 +33,7 @@ describe('providerAsMiddleware', () => {
         expect(error).toBeNull();
         expect(response).toBeDefined();
         assertIsJsonRpcSuccess(response);
-        expect(response.result).toEqual(mockResult);
+        expect(response.result).toStrictEqual(mockResult);
         expect(mockProvider.request).toHaveBeenCalledWith(request);
         resolve();
       });
@@ -53,7 +57,7 @@ describe('providerAsMiddlewareV2', () => {
 
     const result = await engine.handle(request);
 
-    expect(result).toEqual(mockResult);
+    expect(result).toStrictEqual(mockResult);
     expect(mockProvider.request).toHaveBeenCalledWith(request);
   });
 });

packages/eth-json-rpc-middleware/src/types.ts

@@ -1,4 +1,3 @@
-import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 import type {
   Json,
   JsonRpcParams,