refactor!: Add consolidated legacy method middleware

eslint-suppressions.json

@@ -1334,7 +1334,7 @@
   },
   "packages/multichain-api-middleware/src/handlers/wallet-createSession.ts": {
     "@typescript-eslint/explicit-function-return-type": {
-      "count": 2
+      "count": 1
     },
     "@typescript-eslint/prefer-nullish-coalescing": {
       "count": 2

packages/eip1193-permission-middleware/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** Consolidate method handlers into a single `methodHandlers` export ([#8583](https://github.com/MetaMask/core/pull/8583))
+  - The individual handler exports have been removed. They can still be accessed as properties on the `methodHandlers` export.
+  - The new handlers follow the format expected by `createMethodMiddleware` from `@metamask/json-rpc-engine@10.3.0`.
 - Bump `@metamask/chain-agnostic-permission` from `^1.4.0` to `^1.5.0` ([#8290](https://github.com/MetaMask/core/pull/8290))
 - Bump `@metamask/json-rpc-engine` from `^10.2.0` to `^10.2.4` ([#7642](https://github.com/MetaMask/core/pull/7642), [#7856](https://github.com/MetaMask/core/pull/7856), [#8078](https://github.com/MetaMask/core/pull/8078), [#8317](https://github.com/MetaMask/core/pull/8317))
 - Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))

packages/eip1193-permission-middleware/src/index.test.ts

@@ -1,13 +1,40 @@
+import { createMethodMiddleware } from '@metamask/json-rpc-engine';
+
 import * as allExports from '.';
+import type { GetPermissionsHooks } from './wallet-getPermissions';
+import type { RequestPermissionsHooks } from './wallet-requestPermissions';
+import type { RevokePermissionsHooks } from './wallet-revokePermissions';
+
+type Hooks = GetPermissionsHooks &
+  RequestPermissionsHooks &
+  RevokePermissionsHooks;
+
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+const makeMockHooks = () =>
+  ({
+    getPermissionsForOrigin: (() => ({})) as Hooks['getPermissionsForOrigin'],
+    getAccounts: () => ['0x123'],
+    requestPermissionsForOrigin: (() =>
+      Promise.resolve([{}])) as Hooks['requestPermissionsForOrigin'],
+    revokePermissionsForOrigin: () => undefined,
+    getCaip25PermissionFromLegacyPermissionsForOrigin: () => ({}),
+  }) satisfies Hooks;
+/* eslint-enable @typescript-eslint/explicit-function-return-type */
 
 describe('@metamask/eip1193-permission-middleware', () => {
   it('has expected JavaScript exports', () => {
     expect(Object.keys(allExports)).toMatchInlineSnapshot(`
       [
-        "getPermissionsHandler",
-        "requestPermissionsHandler",
-        "revokePermissionsHandler",
+        "methodHandlers",
       ]
     `);
   });
+
+  it('constructs a method middleware from the handlers', () => {
+    const middleware = createMethodMiddleware({
+      handlers: allExports.methodHandlers,
+      hooks: makeMockHooks(),
+    });
+    expect(middleware).toBeDefined();
+  });
 });

packages/eip1193-permission-middleware/src/index.ts

@@ -1,3 +1,17 @@
-export { getPermissionsHandler } from './wallet-getPermissions';
-export { requestPermissionsHandler } from './wallet-requestPermissions';
-export { revokePermissionsHandler } from './wallet-revokePermissions';
+import { MethodNames } from '@metamask/permission-controller';
+
+import { getPermissionsHandler } from './wallet-getPermissions';
+import { requestPermissionsHandler } from './wallet-requestPermissions';
+import { revokePermissionsHandler } from './wallet-revokePermissions';
+
+type MethodHandlers = {
+  [MethodNames.GetPermissions]: typeof getPermissionsHandler;
+  [MethodNames.RequestPermissions]: typeof requestPermissionsHandler;
+  [MethodNames.RevokePermissions]: typeof revokePermissionsHandler;
+};
+
+export const methodHandlers: Readonly<MethodHandlers> = {
+  [MethodNames.GetPermissions]: getPermissionsHandler,
+  [MethodNames.RequestPermissions]: requestPermissionsHandler,
+  [MethodNames.RevokePermissions]: revokePermissionsHandler,
+};

packages/eip1193-permission-middleware/src/wallet-getPermissions.ts

@@ -5,10 +5,10 @@ import {
   getPermittedEthChainIds,
 } from '@metamask/chain-agnostic-permission';
 import type {
-  AsyncJsonRpcEngineNextCallback,
   JsonRpcEngineEndCallback,
+  JsonRpcEngineNextCallback,
+  MethodHandler,
 } from '@metamask/json-rpc-engine';
-import { MethodNames } from '@metamask/permission-controller';
 import type {
   CaveatSpecificationConstraint,
   PermissionController,
@@ -22,14 +22,31 @@ import type {
 
 import { CaveatTypes, EndowmentTypes, RestrictedMethods } from './types';
 
+export type GetPermissionsHooks = {
+  getPermissionsForOrigin: () => ReturnType<
+    PermissionController<
+      PermissionSpecificationConstraint,
+      CaveatSpecificationConstraint
+    >['getPermissions']
+  >;
+  getAccounts: (options?: { ignoreLock?: boolean }) => string[];
+};
+
+export type GetPermissionsHandler = MethodHandler<
+  GetPermissionsHooks,
+  never,
+  Json[],
+  Json,
+  { origin: string }
+>;
+
 export const getPermissionsHandler = {
-  methodNames: [MethodNames.GetPermissions],
   implementation: getPermissionsImplementation,
   hookNames: {
     getPermissionsForOrigin: true,
     getAccounts: true,
   },
-};
+} satisfies GetPermissionsHandler;
 
 /**
  * Get Permissions implementation to be used in JsonRpcEngine middleware, specifically for `wallet_getPermissions` RPC method.
@@ -47,20 +64,9 @@ export const getPermissionsHandler = {
 async function getPermissionsImplementation(
   _req: JsonRpcRequest<Json[]>,
   res: PendingJsonRpcResponse,
-  _next: AsyncJsonRpcEngineNextCallback,
+  _next: JsonRpcEngineNextCallback,
   end: JsonRpcEngineEndCallback,
-  {
-    getPermissionsForOrigin,
-    getAccounts,
-  }: {
-    getPermissionsForOrigin: () => ReturnType<
-      PermissionController<
-        PermissionSpecificationConstraint,
-        CaveatSpecificationConstraint
-      >['getPermissions']
-    >;
-    getAccounts: (options?: { ignoreLock?: boolean }) => string[];
-  },
+  { getPermissionsForOrigin, getAccounts }: GetPermissionsHooks,
 ) {
   const permissions = { ...getPermissionsForOrigin() };
   const caip25Endowment = permissions[Caip25EndowmentPermissionName];

packages/eip1193-permission-middleware/src/wallet-requestPermissions.ts

@@ -6,10 +6,11 @@ import {
 } from '@metamask/chain-agnostic-permission';
 import { isPlainObject } from '@metamask/controller-utils';
 import type {
-  AsyncJsonRpcEngineNextCallback,
+  JsonRpcEngineNextCallback,
   JsonRpcEngineEndCallback,
+  MethodHandler,
 } from '@metamask/json-rpc-engine';
-import { invalidParams, MethodNames } from '@metamask/permission-controller';
+import { invalidParams } from '@metamask/permission-controller';
 import type {
   Caveat,
   CaveatSpecificationConstraint,
@@ -27,15 +28,32 @@ import { pick } from 'lodash';
 
 import { CaveatTypes, EndowmentTypes, RestrictedMethods } from './types';
 
+export type RequestPermissionsHooks = {
+  getAccounts: () => string[];
+  requestPermissionsForOrigin: (
+    requestedPermissions: RequestedPermissions,
+  ) => Promise<[GrantedPermissions]>;
+  getCaip25PermissionFromLegacyPermissionsForOrigin: (
+    requestedPermissions?: RequestedPermissions,
+  ) => RequestedPermissions;
+};
+
+export type RequestPermissionsHandler = MethodHandler<
+  RequestPermissionsHooks,
+  never,
+  [RequestedPermissions],
+  Json,
+  { origin: string }
+>;
+
 export const requestPermissionsHandler = {
-  methodNames: [MethodNames.RequestPermissions],
   implementation: requestPermissionsImplementation,
   hookNames: {
     getAccounts: true,
     requestPermissionsForOrigin: true,
     getCaip25PermissionFromLegacyPermissionsForOrigin: true,
   },
-};
+} satisfies RequestPermissionsHandler;
 
 type AbstractPermissionController = PermissionController<
   PermissionSpecificationConstraint,
@@ -63,21 +81,13 @@ type GrantedPermissions = Awaited<
 async function requestPermissionsImplementation(
   req: JsonRpcRequest<[RequestedPermissions]> & { origin: string },
   res: PendingJsonRpcResponse,
-  _next: AsyncJsonRpcEngineNextCallback,
+  _next: JsonRpcEngineNextCallback,
   end: JsonRpcEngineEndCallback,
   {
     getAccounts,
     requestPermissionsForOrigin,
     getCaip25PermissionFromLegacyPermissionsForOrigin,
-  }: {
-    getAccounts: () => string[];
-    requestPermissionsForOrigin: (
-      requestedPermissions: RequestedPermissions,
-    ) => Promise<[GrantedPermissions]>;
-    getCaip25PermissionFromLegacyPermissionsForOrigin: (
-      requestedPermissions?: RequestedPermissions,
-    ) => RequestedPermissions;
-  },
+  }: RequestPermissionsHooks,
 ) {
   const { params } = req;
 

packages/eip1193-permission-middleware/src/wallet-revokePermissions.ts

@@ -1,9 +1,10 @@
 import { Caip25EndowmentPermissionName } from '@metamask/chain-agnostic-permission';
 import type {
-  AsyncJsonRpcEngineNextCallback,
+  JsonRpcEngineNextCallback,
   JsonRpcEngineEndCallback,
+  MethodHandler,
 } from '@metamask/json-rpc-engine';
-import { invalidParams, MethodNames } from '@metamask/permission-controller';
+import { invalidParams } from '@metamask/permission-controller';
 import { isNonEmptyArray } from '@metamask/utils';
 import type {
   Json,
@@ -13,14 +14,24 @@ import type {
 
 import { EndowmentTypes, RestrictedMethods } from './types';
 
+export type RevokePermissionsHooks = {
+  revokePermissionsForOrigin: (permissionKeys: string[]) => void;
+};
+
+export type RevokePermissionsHandler = MethodHandler<
+  RevokePermissionsHooks,
+  never,
+  Json[],
+  Json,
+  { origin: string }
+>;
+
 export const revokePermissionsHandler = {
-  methodNames: [MethodNames.RevokePermissions],
   implementation: revokePermissionsImplementation,
   hookNames: {
     revokePermissionsForOrigin: true,
-    updateCaveat: true,
   },
-};
+} satisfies RevokePermissionsHandler;
 
 /**
  * Revoke Permissions implementation to be used in JsonRpcEngine middleware.
@@ -36,7 +47,7 @@ export const revokePermissionsHandler = {
 function revokePermissionsImplementation(
   req: JsonRpcRequest<Json[]>,
   res: PendingJsonRpcResponse,
-  _next: AsyncJsonRpcEngineNextCallback,
+  _next: JsonRpcEngineNextCallback,
   end: JsonRpcEngineEndCallback,
   {
     revokePermissionsForOrigin,

packages/json-rpc-engine/CHANGELOG.md

@@ -10,8 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add `createOriginMiddleware` utility to `v2` ([#8522](https://github.com/MetaMask/core/pull/8522))
-- Add `createMethodMiddleware` utility to `v2` ([#8506](https://github.com/MetaMask/core/pull/8506))
+- Add `createMethodMiddleware` utility to `v2` ([#8506](https://github.com/MetaMask/core/pull/8506), [#8583](https://github.com/MetaMask/core/pull/8583))
   - This utility allows JSON-RPC method implementations to use both the hooks pattern and the messenger.
+- Add legacy `createMethodMiddleware` ([#8583](https://github.com/MetaMask/core/pull/8583))
+  - Consolidates bespoke `makeMethodMiddlewareMaker` implementations from the MetaMask extension and mobile clients.
+  - Handlers may now declare `actionNames` and receive a delegated messenger as the sixth argument to `implementation`, mirroring the v2 `createMethodMiddleware`.
+  - Deprecated in favor of the v2 `createMethodMiddleware`.
 
 ## [10.2.4]