refactor: fully extract middleware into EIP-5792 Middleware package (#6477)

## Explanation

The newly created EIP-5792 Middleware package ([PR
#6422](#6422)) currently contains
only the hooks required for the existing wallet middleware. To align
with the intended abstraction and reduce the monolithic nature of
wallet-middleware, we should fully extract the relevant middleware logic
from eth-json-rpc-middleware ([GitHub -
MetaMask/eth-json-rpc-middleware: Ethereum middleware for composing an
Ethereum provider using json-rpc-engine. Intended to replace
provider-engine](https://github.com/MetaMask/eth-json-rpc-middleware))
into this new package.

This PR moves the identified middleware into
@metamask/eip-5792-middleware.

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

* Fixes https://consensyssoftware.atlassian.net/browse/WAPI-691

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: ffmcgee725

eslint-warning-thresholds.json

@@ -153,7 +153,7 @@
   "packages/ens-controller/src/EnsController.ts": {
     "jsdoc/check-tag-names": 6
   },
-  "packages/eip-5792-middleware/src/methods/processSendCalls.ts": {
+  "packages/eip-5792-middleware/src/hooks/processSendCalls.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
   "packages/eth-json-rpc-provider/src/safe-event-emitter-provider.test.ts": {

packages/eip-5792-middleware/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add and export EIP-5792 RPC method handler middlewares and utility types ([#6477](https://github.com/MetaMask/core/pull/6477))
+
 ## [1.0.0]
 
 ### Added

packages/eip-5792-middleware/package.json

@@ -48,6 +48,7 @@
   },
   "dependencies": {
     "@metamask/eth-json-rpc-middleware": "^17.0.1",
+    "@metamask/superstruct": "^3.1.0",
     "@metamask/transaction-controller": "^60.2.0",
     "@metamask/utils": "^11.4.2",
     "uuid": "^8.3.2"
@@ -59,6 +60,7 @@
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
+    "klona": "^2.0.6",
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",

packages/eip-5792-middleware/src/constants.ts

@@ -18,3 +18,12 @@ export enum EIP5792ErrorCode {
   UnknownBundleId = 5730,
   RejectedUpgrade = 5750,
 }
+
+// wallet_getCallStatus
+export enum GetCallsStatusCode {
+  PENDING = 100,
+  CONFIRMED = 200,
+  FAILED_OFFCHAIN = 400,
+  REVERTED = 500,
+  REVERTED_PARTIAL = 600,
+}

packages/eip-5792-middleware/src/methods/getCallsStatus.test.ts renamed to packages/eip-5792-middleware/src/hooks/getCallsStatus.test.ts

@@ -1,12 +1,12 @@
 import { Messenger } from '@metamask/base-controller';
-import { GetCallsStatusCode } from '@metamask/eth-json-rpc-middleware';
 import { TransactionStatus } from '@metamask/transaction-controller';
 import type {
   TransactionControllerGetStateAction,
   TransactionControllerState,
 } from '@metamask/transaction-controller';
 
 import { getCallsStatus } from './getCallsStatus';
+import { GetCallsStatusCode } from '../constants';
 import type { EIP5792Messenger } from '../types';
 
 const CHAIN_ID_MOCK = '0x123';

packages/eip-5792-middleware/src/methods/getCallsStatus.ts renamed to packages/eip-5792-middleware/src/hooks/getCallsStatus.ts

@@ -1,5 +1,3 @@
-import type { GetCallsStatusResult } from '@metamask/eth-json-rpc-middleware';
-import { GetCallsStatusCode } from '@metamask/eth-json-rpc-middleware';
 import { JsonRpcError } from '@metamask/rpc-errors';
 import type {
   Log,
@@ -9,8 +7,8 @@ import type {
 import { TransactionStatus } from '@metamask/transaction-controller';
 import type { Hex } from '@metamask/utils';
 
-import { EIP5792ErrorCode, VERSION } from '../constants';
-import type { EIP5792Messenger } from '../types';
+import { EIP5792ErrorCode, GetCallsStatusCode, VERSION } from '../constants';
+import type { EIP5792Messenger, GetCallsStatusResult } from '../types';
 
 /**
  * Retrieves the status of a transaction batch by its ID.

packages/eip-5792-middleware/src/methods/getCapabilities.test.ts renamed to packages/eip-5792-middleware/src/hooks/getCapabilities.test.ts

@@ -1,4 +1,3 @@
-import type { GetCapabilitiesResult } from '@metamask/eth-json-rpc-middleware';
 import type {
   IsAtomicBatchSupportedResult,
   IsAtomicBatchSupportedResultEntry,
@@ -7,7 +6,7 @@ import type {
 import type { Hex } from '@metamask/utils';
 
 import { KEYRING_TYPES_SUPPORTING_7702 } from '../constants';
-import type { EIP5792Messenger } from '../types';
+import type { EIP5792Messenger, GetCapabilitiesResult } from '../types';
 import { getAccountKeyringType } from '../utils';
 
 /**

packages/eip-5792-middleware/src/methods/getCapabilities.ts renamed to packages/eip-5792-middleware/src/hooks/getCapabilities.ts

@@ -4,10 +4,6 @@ import type {
   AccountsControllerState,
 } from '@metamask/accounts-controller';
 import { Messenger } from '@metamask/base-controller';
-import type {
-  SendCalls,
-  SendCallsParams,
-} from '@metamask/eth-json-rpc-middleware';
 import { KeyringTypes } from '@metamask/keyring-controller';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
 import type {
@@ -19,7 +15,11 @@ import type { TransactionController } from '@metamask/transaction-controller';
 import type { JsonRpcRequest } from '@metamask/utils';
 
 import { processSendCalls } from './processSendCalls';
-import type { EIP5792Messenger } from '../types';
+import type {
+  SendCallsPayload,
+  SendCallsParams,
+  EIP5792Messenger,
+} from '../types';
 
 const CHAIN_ID_MOCK = '0x123';
 const CHAIN_ID_2_MOCK = '0xabc';
@@ -31,7 +31,7 @@ const FROM_MOCK_SIMPLE = '0x789abc';
 const ORIGIN_MOCK = 'test.com';
 const DELEGATION_ADDRESS_MOCK = '0x1234567890abcdef1234567890abcdef12345678';
 
-const SEND_CALLS_MOCK: SendCalls = {
+const SEND_CALLS_MOCK: SendCallsPayload = {
   version: '2.0.0',
   calls: [{ to: '0x123' }, { to: '0x456' }],
   chainId: CHAIN_ID_MOCK,

packages/eip-5792-middleware/src/methods/processSendCalls.test.ts renamed to packages/eip-5792-middleware/src/hooks/processSendCalls.test.ts

@@ -1,7 +1,3 @@
-import type {
-  SendCalls,
-  SendCallsResult,
-} from '@metamask/eth-json-rpc-middleware';
 import type { KeyringTypes } from '@metamask/keyring-controller';
 import { JsonRpcError, rpcErrors } from '@metamask/rpc-errors';
 import type {
@@ -22,7 +18,11 @@ import {
   MessageType,
   VERSION,
 } from '../constants';
-import type { EIP5792Messenger } from '../types';
+import type {
+  EIP5792Messenger,
+  SendCallsPayload,
+  SendCallsResult,
+} from '../types';
 import { getAccountKeyringType } from '../utils';
 
 /**
@@ -67,7 +67,7 @@ export type ProcessSendCallsRequest = JsonRpcRequest & {
 export async function processSendCalls(
   hooks: ProcessSendCallsHooks,
   messenger: EIP5792Messenger,
-  params: SendCalls,
+  params: SendCallsPayload,
   req: ProcessSendCallsRequest,
 ): Promise<SendCallsResult> {
   const {
@@ -159,7 +159,7 @@ async function processSingleTransaction({
   networkClientId: string;
   origin?: string;
   securityAlertId: string;
-  sendCalls: SendCalls;
+  sendCalls: SendCallsPayload;
   transactions: { params: BatchTransactionParams }[];
   validateSecurity: (
     securityRequest: ValidateSecurityRequest,
@@ -232,7 +232,7 @@ async function processMultipleTransaction({
   messenger: EIP5792Messenger;
   networkClientId: string;
   origin?: string;
-  sendCalls: SendCalls;
+  sendCalls: SendCallsPayload;
   securityAlertId: string;
   transactions: { params: BatchTransactionParams }[];
   validateSecurity: (
@@ -288,7 +288,7 @@ function generateBatchId(): Hex {
  * @param sendCalls - The sendCalls request to validate.
  * @param dappChainId - The chain ID that the dApp is connected to.
  */
-function validateSingleSendCall(sendCalls: SendCalls, dappChainId: Hex) {
+function validateSingleSendCall(sendCalls: SendCallsPayload, dappChainId: Hex) {
   validateSendCallsVersion(sendCalls);
   validateCapabilities(sendCalls);
   validateDappChainId(sendCalls, dappChainId);
@@ -304,7 +304,7 @@ function validateSingleSendCall(sendCalls: SendCalls, dappChainId: Hex) {
  * @param keyringType - The type of keyring associated with the account.
  */
 function validateSendCalls(
-  sendCalls: SendCalls,
+  sendCalls: SendCallsPayload,
   dappChainId: Hex,
   dismissSmartAccountSuggestionEnabled: boolean,
   chainBatchSupport: IsAtomicBatchSupportedResultEntry | undefined,
@@ -326,7 +326,7 @@ function validateSendCalls(
  * @param sendCalls - The sendCalls request to validate.
  * @throws JsonRpcError if the version is not supported.
  */
-function validateSendCallsVersion(sendCalls: SendCalls) {
+function validateSendCallsVersion(sendCalls: SendCallsPayload) {
   const { version } = sendCalls;
 
   if (version !== VERSION) {
@@ -343,7 +343,7 @@ function validateSendCallsVersion(sendCalls: SendCalls) {
  * @param dappChainId - The chain ID that the dApp is connected to
  * @throws JsonRpcError if the chain IDs don't match
  */
-function validateDappChainId(sendCalls: SendCalls, dappChainId: Hex) {
+function validateDappChainId(sendCalls: SendCallsPayload, dappChainId: Hex) {
   const { chainId: requestChainId } = sendCalls;
 
   if (
@@ -365,7 +365,7 @@ function validateDappChainId(sendCalls: SendCalls, dappChainId: Hex) {
  * @throws JsonRpcError if the chain ID doesn't match or EIP-7702 is not supported
  */
 function validateSendCallsChainId(
-  sendCalls: SendCalls,
+  sendCalls: SendCallsPayload,
   dappChainId: Hex,
   chainBatchSupport: IsAtomicBatchSupportedResultEntry | undefined,
 ) {
@@ -384,7 +384,7 @@ function validateSendCallsChainId(
  * @param sendCalls - The sendCalls request to validate.
  * @throws JsonRpcError if unsupported non-optional capabilities are requested.
  */
-function validateCapabilities(sendCalls: SendCalls) {
+function validateCapabilities(sendCalls: SendCallsPayload) {
   const { calls, capabilities } = sendCalls;
 
   const requiredTopLevelCapabilities = Object.keys(capabilities ?? {}).filter(