Skip to content

Conversation

ffmcgee725
Copy link
Member

@ffmcgee725 ffmcgee725 commented Sep 5, 2025

Explanation

The newly created EIP-5792 Middleware package (PR #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) into this new package.

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

References

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, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@ffmcgee725
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Sep 5, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "0.12.1-preview-3b6e464",
  "@metamask-previews/accounts-controller": "33.0.0-preview-3b6e464",
  "@metamask-previews/address-book-controller": "6.1.1-preview-3b6e464",
  "@metamask-previews/announcement-controller": "7.0.3-preview-3b6e464",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-3b6e464",
  "@metamask-previews/approval-controller": "7.1.3-preview-3b6e464",
  "@metamask-previews/assets-controllers": "74.3.3-preview-3b6e464",
  "@metamask-previews/base-controller": "8.3.0-preview-3b6e464",
  "@metamask-previews/bridge-controller": "41.4.0-preview-3b6e464",
  "@metamask-previews/bridge-status-controller": "41.0.0-preview-3b6e464",
  "@metamask-previews/build-utils": "3.0.3-preview-3b6e464",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-3b6e464",
  "@metamask-previews/composable-controller": "11.0.0-preview-3b6e464",
  "@metamask-previews/controller-utils": "11.12.0-preview-3b6e464",
  "@metamask-previews/delegation-controller": "0.7.0-preview-3b6e464",
  "@metamask-previews/earn-controller": "7.0.0-preview-3b6e464",
  "@metamask-previews/eip-5792-middleware": "1.0.0-preview-3b6e464",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-3b6e464",
  "@metamask-previews/ens-controller": "17.0.1-preview-3b6e464",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-3b6e464",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-3b6e464",
  "@metamask-previews/foundryup": "1.0.1-preview-3b6e464",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-3b6e464",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-3b6e464",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-3b6e464",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-3b6e464",
  "@metamask-previews/keyring-controller": "23.0.0-preview-3b6e464",
  "@metamask-previews/logging-controller": "6.0.4-preview-3b6e464",
  "@metamask-previews/message-manager": "12.0.2-preview-3b6e464",
  "@metamask-previews/messenger": "0.2.0-preview-3b6e464",
  "@metamask-previews/multichain-account-service": "0.6.0-preview-3b6e464",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-3b6e464",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-3b6e464",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-3b6e464",
  "@metamask-previews/name-controller": "8.0.3-preview-3b6e464",
  "@metamask-previews/network-controller": "24.1.0-preview-3b6e464",
  "@metamask-previews/network-enablement-controller": "0.4.0-preview-3b6e464",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-3b6e464",
  "@metamask-previews/permission-controller": "11.0.6-preview-3b6e464",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-3b6e464",
  "@metamask-previews/phishing-controller": "13.1.0-preview-3b6e464",
  "@metamask-previews/polling-controller": "14.0.0-preview-3b6e464",
  "@metamask-previews/preferences-controller": "19.0.0-preview-3b6e464",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-3b6e464",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-3b6e464",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-3b6e464",
  "@metamask-previews/sample-controllers": "1.0.0-preview-3b6e464",
  "@metamask-previews/seedless-onboarding-controller": "3.0.0-preview-3b6e464",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-3b6e464",
  "@metamask-previews/shield-controller": "0.1.2-preview-3b6e464",
  "@metamask-previews/signature-controller": "33.0.0-preview-3b6e464",
  "@metamask-previews/subscription-controller": "0.0.0-preview-3b6e464",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-3b6e464",
  "@metamask-previews/transaction-controller": "60.2.0-preview-3b6e464",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-3b6e464"
}

ffmcgee725 added a commit to MetaMask/eth-json-rpc-middleware that referenced this pull request Sep 5, 2025
@ffmcgee725
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Sep 5, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "0.12.1-preview-fe3c100",
  "@metamask-previews/accounts-controller": "33.0.0-preview-fe3c100",
  "@metamask-previews/address-book-controller": "6.1.1-preview-fe3c100",
  "@metamask-previews/announcement-controller": "7.0.3-preview-fe3c100",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-fe3c100",
  "@metamask-previews/approval-controller": "7.1.3-preview-fe3c100",
  "@metamask-previews/assets-controllers": "74.3.3-preview-fe3c100",
  "@metamask-previews/base-controller": "8.3.0-preview-fe3c100",
  "@metamask-previews/bridge-controller": "41.4.0-preview-fe3c100",
  "@metamask-previews/bridge-status-controller": "41.0.0-preview-fe3c100",
  "@metamask-previews/build-utils": "3.0.3-preview-fe3c100",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-fe3c100",
  "@metamask-previews/composable-controller": "11.0.0-preview-fe3c100",
  "@metamask-previews/controller-utils": "11.12.0-preview-fe3c100",
  "@metamask-previews/delegation-controller": "0.7.0-preview-fe3c100",
  "@metamask-previews/earn-controller": "7.0.0-preview-fe3c100",
  "@metamask-previews/eip-5792-middleware": "1.0.0-preview-fe3c100",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-fe3c100",
  "@metamask-previews/ens-controller": "17.0.1-preview-fe3c100",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-fe3c100",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-fe3c100",
  "@metamask-previews/foundryup": "1.0.1-preview-fe3c100",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-fe3c100",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-fe3c100",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-fe3c100",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-fe3c100",
  "@metamask-previews/keyring-controller": "23.0.0-preview-fe3c100",
  "@metamask-previews/logging-controller": "6.0.4-preview-fe3c100",
  "@metamask-previews/message-manager": "12.0.2-preview-fe3c100",
  "@metamask-previews/messenger": "0.2.0-preview-fe3c100",
  "@metamask-previews/multichain-account-service": "0.6.0-preview-fe3c100",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-fe3c100",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-fe3c100",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-fe3c100",
  "@metamask-previews/name-controller": "8.0.3-preview-fe3c100",
  "@metamask-previews/network-controller": "24.1.0-preview-fe3c100",
  "@metamask-previews/network-enablement-controller": "0.4.0-preview-fe3c100",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-fe3c100",
  "@metamask-previews/permission-controller": "11.0.6-preview-fe3c100",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-fe3c100",
  "@metamask-previews/phishing-controller": "13.1.0-preview-fe3c100",
  "@metamask-previews/polling-controller": "14.0.0-preview-fe3c100",
  "@metamask-previews/preferences-controller": "19.0.0-preview-fe3c100",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-fe3c100",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-fe3c100",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-fe3c100",
  "@metamask-previews/sample-controllers": "1.0.0-preview-fe3c100",
  "@metamask-previews/seedless-onboarding-controller": "3.0.0-preview-fe3c100",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-fe3c100",
  "@metamask-previews/shield-controller": "0.1.2-preview-fe3c100",
  "@metamask-previews/signature-controller": "33.0.0-preview-fe3c100",
  "@metamask-previews/subscription-controller": "0.0.0-preview-fe3c100",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-fe3c100",
  "@metamask-previews/transaction-controller": "60.2.0-preview-fe3c100",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-fe3c100"
}

Copy link
Contributor

github-actions bot commented Sep 5, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "0.12.1-preview-c977d80",
  "@metamask-previews/accounts-controller": "33.0.0-preview-c977d80",
  "@metamask-previews/address-book-controller": "6.1.1-preview-c977d80",
  "@metamask-previews/announcement-controller": "7.0.3-preview-c977d80",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-c977d80",
  "@metamask-previews/approval-controller": "7.1.3-preview-c977d80",
  "@metamask-previews/assets-controllers": "74.3.3-preview-c977d80",
  "@metamask-previews/base-controller": "8.3.0-preview-c977d80",
  "@metamask-previews/bridge-controller": "41.4.0-preview-c977d80",
  "@metamask-previews/bridge-status-controller": "41.0.0-preview-c977d80",
  "@metamask-previews/build-utils": "3.0.3-preview-c977d80",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-c977d80",
  "@metamask-previews/composable-controller": "11.0.0-preview-c977d80",
  "@metamask-previews/controller-utils": "11.12.0-preview-c977d80",
  "@metamask-previews/delegation-controller": "0.7.0-preview-c977d80",
  "@metamask-previews/earn-controller": "7.0.0-preview-c977d80",
  "@metamask-previews/eip-5792-middleware": "1.0.0-preview-c977d80",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-c977d80",
  "@metamask-previews/ens-controller": "17.0.1-preview-c977d80",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-c977d80",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-c977d80",
  "@metamask-previews/foundryup": "1.0.1-preview-c977d80",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-c977d80",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-c977d80",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-c977d80",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-c977d80",
  "@metamask-previews/keyring-controller": "23.0.0-preview-c977d80",
  "@metamask-previews/logging-controller": "6.0.4-preview-c977d80",
  "@metamask-previews/message-manager": "12.0.2-preview-c977d80",
  "@metamask-previews/messenger": "0.2.0-preview-c977d80",
  "@metamask-previews/multichain-account-service": "0.6.0-preview-c977d80",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-c977d80",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-c977d80",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-c977d80",
  "@metamask-previews/name-controller": "8.0.3-preview-c977d80",
  "@metamask-previews/network-controller": "24.1.0-preview-c977d80",
  "@metamask-previews/network-enablement-controller": "0.4.0-preview-c977d80",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-c977d80",
  "@metamask-previews/permission-controller": "11.0.6-preview-c977d80",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-c977d80",
  "@metamask-previews/phishing-controller": "13.1.0-preview-c977d80",
  "@metamask-previews/polling-controller": "14.0.0-preview-c977d80",
  "@metamask-previews/preferences-controller": "19.0.0-preview-c977d80",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-c977d80",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-c977d80",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-c977d80",
  "@metamask-previews/sample-controllers": "1.0.0-preview-c977d80",
  "@metamask-previews/seedless-onboarding-controller": "3.0.0-preview-c977d80",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-c977d80",
  "@metamask-previews/shield-controller": "0.1.2-preview-c977d80",
  "@metamask-previews/signature-controller": "33.0.0-preview-c977d80",
  "@metamask-previews/subscription-controller": "0.0.0-preview-c977d80",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-c977d80",
  "@metamask-previews/transaction-controller": "60.2.0-preview-c977d80",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-c977d80"
}

@ffmcgee725
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Sep 5, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "0.12.1-preview-55f2e41",
  "@metamask-previews/accounts-controller": "33.0.0-preview-55f2e41",
  "@metamask-previews/address-book-controller": "6.1.1-preview-55f2e41",
  "@metamask-previews/announcement-controller": "7.0.3-preview-55f2e41",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-55f2e41",
  "@metamask-previews/approval-controller": "7.1.3-preview-55f2e41",
  "@metamask-previews/assets-controllers": "74.3.3-preview-55f2e41",
  "@metamask-previews/base-controller": "8.3.0-preview-55f2e41",
  "@metamask-previews/bridge-controller": "41.4.0-preview-55f2e41",
  "@metamask-previews/bridge-status-controller": "41.0.0-preview-55f2e41",
  "@metamask-previews/build-utils": "3.0.3-preview-55f2e41",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-55f2e41",
  "@metamask-previews/composable-controller": "11.0.0-preview-55f2e41",
  "@metamask-previews/controller-utils": "11.12.0-preview-55f2e41",
  "@metamask-previews/delegation-controller": "0.7.0-preview-55f2e41",
  "@metamask-previews/earn-controller": "7.0.0-preview-55f2e41",
  "@metamask-previews/eip-5792-middleware": "1.0.0-preview-55f2e41",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-55f2e41",
  "@metamask-previews/ens-controller": "17.0.1-preview-55f2e41",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-55f2e41",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-55f2e41",
  "@metamask-previews/foundryup": "1.0.1-preview-55f2e41",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-55f2e41",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-55f2e41",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-55f2e41",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-55f2e41",
  "@metamask-previews/keyring-controller": "23.0.0-preview-55f2e41",
  "@metamask-previews/logging-controller": "6.0.4-preview-55f2e41",
  "@metamask-previews/message-manager": "12.0.2-preview-55f2e41",
  "@metamask-previews/messenger": "0.2.0-preview-55f2e41",
  "@metamask-previews/multichain-account-service": "0.6.0-preview-55f2e41",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-55f2e41",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-55f2e41",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-55f2e41",
  "@metamask-previews/name-controller": "8.0.3-preview-55f2e41",
  "@metamask-previews/network-controller": "24.1.0-preview-55f2e41",
  "@metamask-previews/network-enablement-controller": "0.4.0-preview-55f2e41",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-55f2e41",
  "@metamask-previews/permission-controller": "11.0.6-preview-55f2e41",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-55f2e41",
  "@metamask-previews/phishing-controller": "13.1.0-preview-55f2e41",
  "@metamask-previews/polling-controller": "14.0.0-preview-55f2e41",
  "@metamask-previews/preferences-controller": "19.0.0-preview-55f2e41",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-55f2e41",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-55f2e41",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-55f2e41",
  "@metamask-previews/sample-controllers": "1.0.0-preview-55f2e41",
  "@metamask-previews/seedless-onboarding-controller": "3.0.0-preview-55f2e41",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-55f2e41",
  "@metamask-previews/shield-controller": "0.1.2-preview-55f2e41",
  "@metamask-previews/signature-controller": "33.0.0-preview-55f2e41",
  "@metamask-previews/subscription-controller": "0.0.0-preview-55f2e41",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-55f2e41",
  "@metamask-previews/transaction-controller": "60.2.0-preview-55f2e41",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-55f2e41"
}

* @param options - Configuration object containing the getAccounts function.
* @param options.getAccounts - Function to retrieve accounts for the requester.
* @returns A normalized (lowercase) hex address if valid and authorized.
* @throws JsonRpcError with unauthorized error if the requester doesn't have permission to access the address.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @throws JsonRpcError with unauthorized error if the requester doesn't have permission to access the address.
* @throws JsonRpcError with unauthorized error if the requester doesn't have permission to access the address.

Copy link
Contributor

@adonesky1 adonesky1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@adonesky1 adonesky1 enabled auto-merge (squash) September 9, 2025 17:51
@adonesky1 adonesky1 merged commit b469c1f into main Sep 9, 2025
239 checks passed
@adonesky1 adonesky1 deleted the jc/WAPI-691 branch September 9, 2025 17:57
ffmcgee725 added a commit to MetaMask/eth-json-rpc-middleware that referenced this pull request Sep 10, 2025
…) package (#401)

<!--
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 issues or other links reviewers should consult to
understand this pull request better? For instance:

* Fixes #12345
* See: #67890
-->

## Explanation

The newly created EIP-5792 Middleware package ([PR
#6422](MetaMask/core#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 removes the identified middleware into
@metamask/eip-5792-middleware.

PR [#6477](MetaMask/core#6477) from
https://github.com/MetaMask/core moves this middleware to the specified
package.

* Fixes https://consensyssoftware.atlassian.net/browse/WAPI-691
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants