Split up `multichain` package into 3 packages by mcmire · Pull Request #5476 · MetaMask/core

mcmire · 2025-03-13T20:51:58Z

Explanation

Not everything in @metamask/multichain is strictly multichain-related. We could rename this package to @metamask/caip25, but not everything is CAIP-25-related, either.

To better highlight the purpose of the different parts of @metamask/multichain, this commit splits it up into 3 packages:

@metamask/chain-agnostic-permission: Defines an endowment type permission designed to persist the account and chain components of a CAIP-25 request. This package also includes adapters and utility functions for interfacing with this permission.
@metamask/eip1193-permission-middleware: Implements the JSON-RPC methods for managing permissions as referenced in EIP-2255 and MIP-2, but adapted to support chain-agnostic permission caveats.
@metamask/multichain-api-middleware: JSON-RPC methods and middleware to support the the MetaMask Multichain API.

Note that the existing code in @metamask/multichain has not been touched. We will deprecate and remove this package later.

References

Closeshttps://github.com/MetaMask/MetaMask-planning/issues/4395.

Changelog

(No updates to changelogs needed)

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 highlighted breaking changes using the "BREAKING" category above as appropriate
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

This commit adjusts the constraints in `yarn.config.cjs`: - Remove `expectControllerDependenciesListedAsPeerDependencies`. As its name implies, this constraint ensured that dependencies which referred to controllers were always listed as peer dependencies. This is incorrect, because in some cases we may simply want to list them as "production" dependencies. - Correct `expectDependenciesNotInBothProdAndDev` (now `expectDependenciesNotInBothProdAndDevOrPeer`) to not only ensure that a dependency is not listed in both `dependencies` and `devDependencies` but also both `dependencies` and `peerDependencies` (only `devDependencies` + `peerDependencies` is allowed, as combinations go). - Add `expectPeerDependenciesAlsoListedAsDevDependencies` constraint to ensure that peer dependencies are also listed as dev dependencies. - Fix `expectUpToDateWorkspaceDependenciesAndDevDependencies` to skip validation of "production" dependencies that are also listed in peer dependencies (this avoids conflicting constraints). - Correct `expectConsistentDependenciesAndDevDependencies` to skip workspace dependencies, as that is already being handled by `expectUpToDateWorkspaceDependenciesAndDevDependencies` (this avoids conflicting constraints). Note that because of these changes, several controllers have also been corrected to fit.

Not everything in `@metamask/multichain` is strictly multichain-related. We could rename this package to `@metamask/caip25`, but not everything is CAIP-25-related, either. To better highlight the purpose of the different parts of `@metamask/multichain`, this commit extracts those parts to 3 packages: - `@metamask/chain-agnostic-permission`: Defines a permission caveat and endowment designed to match [CAIP-25][1] and related specifications. - `@metamask/eip1193-permission-middleware`: Implements JSON-RPC methods for managing permissions as described in [EIP-2255][2] and [MIP-2][3]. - `@metamask/multichain-api-middleware`: Implements JSON-RPC methods in the [MetaMask Multichain API][4] that manage and utilize [chain-agnostic permissions][5]. Note that the existing code in `@metamask/multichain` has not been touched. We will deprecate and remove this package in a future commit. [1]: https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md [2]: https://eips.ethereum.org/EIPS/eip-2255 [3]: https://github.com/MetaMask/metamask-improvement-proposals/blob/main/MIPs/mip-2.md [4]: https://github.com/MetaMask/metamask-improvement-proposals/blob/main/MIPs/mip-5.md [5]: https://github.com/MetaMask/chain-agnostic-permission

ffmcgee725

LGTM! 🚀

adonesky1 · 2025-03-14T16:50:52Z

Would it be possible to create preview builds and replace uses of the @metamask/multichain package with these packages in an extension branch? Or is this not possible on this PR where the packages are first introduced?

mcmire · 2025-03-14T16:59:39Z

@adonesky1 Hmm I think that is possible! I will give it a shot.

Co-authored-by: Alex Donesky <adonesky@gmail.com>

The base branch was changed.

Co-authored-by: Alex Donesky <adonesky@gmail.com>

mcmire · 2025-03-14T18:08:27Z

@metamaskbot publish-previews

mcmire · 2025-03-14T19:24:07Z

@adonesky1 I just checked and it's not possible to publish a preview build of a not-yet-published package. I tried to fix this and it would take a bit of time to fix, so I don't think it's something we can address right now.

adonesky1 · 2025-03-14T22:09:54Z

A few small outstanding comments otherwise LGTM!

…rmission-middleware

mcmire · 2025-03-17T15:35:02Z

I believe I've addressed all the comments here. Ready for re-review.

jiexi · 2025-03-17T17:01:13Z

+ Object.keys(caip25EquivalentPermissions).length > 0;
+
+ if (hasCaip25EquivalentPermissions) {
+ const caip25Permission = getCaip25PermissionFromLegacyPermissionsForOrigin(


should we move the getCaip25PermissionFromLegacyPermissions hook over from extension? The only platform specific thing I may be worried about is the special handling for snap origins

ahh sorry. ignore this. definitely outside the scope of this PR. my bad

adonesky1 · 2025-03-17T17:53:33Z

Other than @jiexi's outstanding comment that needs a fix/cleanup, LGTM!

adonesky1

LGTM

jiexi

🚀 ➡️ 🚀 🚀 🚀

cryptodev-2s

LGTM!

## Explanation As follow-up work to the previous splitting of the `multichain` package into 3 new packages `@metamask/chain-agnostic-permission` `@metamask/eip1193-permission-middleware` `@multichain/multichain-api-middleware` done in the [following PR](#5476), we now want to completely deprecate/remove the legacy package and later mark it as deprecated while also linking to the new packages in npm.  ## References  * Fixes : MetaMask/MetaMask-planning#4729 * Related to MetaMask/MetaMask-planning#4395 ## Changelog  ## 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

mcmire added 2 commits March 12, 2025 15:18

mcmire force-pushed the extract-wallet-api-packages branch from 74b0f6a to 48096e6Compare March 13, 2025 20:55

mcmire commented Mar 13, 2025
View reviewed changes

Comment threadpackages/chain-agnostic-permission/README.md Outdated
Comment threadpackages/eip1193-permission-middleware/README.md Outdated
Comment threadpackages/multichain-api-middleware/README.md Outdated

mcmire added 3 commits March 13, 2025 15:01

Fix index test for chain-agnostic-permission
a6e40d4

Fix package links in READMEs
e4d3b60

Add missing dependency
4a6239e

adonesky1 reviewed Mar 13, 2025
View reviewed changes

Comment thread.github/CODEOWNERS Outdated

adonesky1 reviewed Mar 13, 2025
View reviewed changes

Comment thread.github/CODEOWNERS Outdated

jiexi reviewed Mar 13, 2025
View reviewed changes

Comment threadpackages/chain-agnostic-permission/src/index.test.ts

ffmcgee725 reviewed Mar 14, 2025
View reviewed changes

Comment threadpackages/eip1193-permission-middleware/src/wallet-getPermissions.test.ts Outdated

ffmcgee725 reviewed Mar 14, 2025
View reviewed changes

Comment threadpackages/multichain-api-middleware/src/handlers/wallet-getSession.test.ts Outdated

mcmire added 4 commits March 14, 2025 07:55

Rename multichainMethodCallValidator{,Middleware}
c895fae

Update descriptions of packages
dc3db6f

Fix codeowners
947b53e

Remove unnecessary comments
d7c4238

ffmcgee725 previously approved these changes Mar 14, 2025
View reviewed changes

adonesky1 reviewed Mar 14, 2025
View reviewed changes

Comment threadpackages/chain-agnostic-permission/README.md Outdated

adonesky1 reviewed Mar 14, 2025
View reviewed changes

Comment threadpackages/eip1193-permission-middleware/README.md Outdated

Update README for eip1193-permission-middleware
2fe9a73
Co-authored-by: Alex Donesky <adonesky@gmail.com>

Base automatically changed from allow-controller-to-only-be-listed-in-deps to mainMarch 14, 2025 17:49

mcmireand others added 4 commits March 14, 2025 12:01

Update chain-agnostic-permission README
05b61fb
Co-authored-by: Alex Donesky <adonesky@gmail.com>

Merge branch 'main' into extract-wallet-api-packages
3bc6df4

Update dep graph in README
53bb65d

Fix formatting
34d5630

mcmire marked this pull request as ready for review March 14, 2025 19:22

mcmire requested review from a team as code owners March 14, 2025 19:22

adonesky1 reviewed Mar 14, 2025
View reviewed changes

Comment threadpackages/profile-sync-controller/CHANGELOG.md

adonesky1and others added 2 commits March 17, 2025 09:28

Merge branch 'main' into extract-wallet-api-packages
17ba7f1

Revert change to profile-sync-controller changelog
81c5835

adonesky1 reviewed Mar 17, 2025
View reviewed changes

Comment threadpackages/chain-agnostic-permission/src/types.ts

mcmire added 2 commits March 17, 2025 09:32

Move CaveatTypes, EndowmentTypes, and RestrictedMethods to eip1193-pe…
becfb94
…rmission-middleware

Update chain-agnostic-permission package description
cd459d2

jiexi reviewed Mar 17, 2025
View reviewed changes

Comment threadpackages/multichain-api-middleware/src/middlewares/multichainMethodCallValidator.test.ts Outdated

Remove duplicate test file
42e170d

adonesky1 approved these changes Mar 17, 2025
View reviewed changes

ffmcgee725 approved these changes Mar 17, 2025
View reviewed changes

jiexi approved these changes Mar 17, 2025
View reviewed changes

adonesky1 enabled auto-merge (squash) March 17, 2025 18:53

Merge branch 'main' into extract-wallet-api-packages
bc627a5

cryptodev-2s approved these changes Mar 18, 2025
View reviewed changes

adonesky1 merged commit acca1ea into mainMar 18, 2025

adonesky1 deleted the extract-wallet-api-packages branch March 18, 2025 14:13

adonesky1 mentioned this pull request Mar 18, 2025
chore: repoint @metamask/multichain package references to new packages MetaMask/metamask-extension#31097
Closed
7 tasks

ffmcgee725 mentioned this pull request Jun 12, 2025
chore: remove multichain deprecated package #5960
Merged
4 tasks

mcmire mentioned this pull request Apr 29, 2026
Enable PR link validation in changelogs by default #8637
Draft
4 tasks

Uh oh!

Uh oh!

Conversation

mcmire commented Mar 13, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ffmcgee725 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adonesky1 commented Mar 14, 2025

Uh oh!

mcmire commented Mar 14, 2025

Uh oh!

Uh oh!

mcmire commented Mar 14, 2025

Uh oh!

mcmire commented Mar 14, 2025

Uh oh!

Uh oh!

adonesky1 commented Mar 14, 2025

Uh oh!

Uh oh!

mcmire commented Mar 17, 2025

Uh oh!

jiexiMar 17, 2025

Choose a reason for hiding this comment

Uh oh!

jiexiMar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adonesky1 commented Mar 17, 2025

Uh oh!

adonesky1 left a comment

Choose a reason for hiding this comment

Uh oh!

jiexi left a comment

Choose a reason for hiding this comment

Uh oh!

cryptodev-2s left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mcmire commented Mar 13, 2025•
edited
Loading