feat(snap-account-service): add migration logic + keyring v2 support#8732
Open
ccharly wants to merge 20 commits into
Open
feat(snap-account-service): add migration logic + keyring v2 support#8732ccharly wants to merge 20 commits into
ccharly wants to merge 20 commits into
Conversation
ccharly
force-pushed
the
cc/feat/snap-account-service-keyring-v2-support
branch
from
96269d0 to
43c238b
Compare
ccharly
changed the base branch from
main
to
cc/feat/snap-account-service-account-group-events
ccharly
changed the title
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
ccharly
force-pushed
the
cc/feat/snap-account-service-keyring-v2-support
branch
from
8452267 to
ce71df1
Compare
Base automatically changed from
cc/feat/snap-account-service-account-group-events
to
main
May 12, 2026 19:50
ccharly
force-pushed
the
cc/feat/snap-account-service-keyring-v2-support
branch
from
a4b5e03 to
47199fa
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
ccharly
force-pushed
the
cc/feat/snap-account-service-keyring-v2-support
branch
2 times, most recently
from
9cae8f4 to
24c3001
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
ccharly
force-pushed
the
cc/feat/snap-account-service-keyring-v2-support
branch
from
98e5de2 to
3ab5f83
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit f39f26b. Configure here.
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. Learn how to use preview builds in other projects. Expand for full list of packages and versions. |
hmalik88
reviewed
May 19, 2026
Comment on lines
+480
to
+483
| filter: (keyring): keyring is SnapKeyring => | ||
| isSnapKeyring(keyring) && keyring.snapId === snapId, | ||
| }, | ||
| async ({ keyring }) => operation(keyring as SnapKeyring), |
Contributor
There was a problem hiding this comment.
why do we need the cast if we're using the type predicate in the filter?
Contributor
Author
There was a problem hiding this comment.
I think we lose the type generics when using actions (that use generics) through the messenger
Contributor
There was a problem hiding this comment.
Ah yeah I figured, all good! I wonder if the typing can be improved in the messenger so we don't lose it, I imagine there would be so many castings dropped across all teams if so haha 😆
hmalik88
reviewed
May 19, 2026
|
|
||
| // Migrate from the global v1 Snap keyring to the per-Snap v2 keyring | ||
| // before doing anything else. | ||
| await this.migrate(); |
Contributor
There was a problem hiding this comment.
can we not do this in the constructor? doing it anytime a snap provider gets used doesn't feel right even though it's a no-op.
Contributor
Author
There was a problem hiding this comment.
Well.. I put it there to ensure the migration would be run no matter who requires a Snap keyring.
Maybe I could try to:
- Rename
migratetoensureMigrated - Hook
KeyringController:unlockinstead - Run the migration right after the unlock (which could be a noop)
This way, we could guarantee the migration has been ran correctly.
We could add a guard like if (!this.migrated) { throw new Error('Not migrated yet'); } in case a :ensureReady comes before (but I don't think that would happen with the :unlock hook honestly)
Contributor
There was a problem hiding this comment.
Ok nice, that sounds good
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Add migration logic to migrate from the legacy Snap keyring to the new architecture with 1 Snap keyring v2 per Snaps.
Also enhance
:ensureReadyso consumers can safely call:withKeyringV2to get the associated Snap keyring v2 instance before using it.References
N/A
Checklist
Note
High Risk
High risk because it changes Snap keyring selection, migration, and selected-account forwarding across keyrings, which can affect account availability and Snap message routing during startup and resync flows.
Overview
Adds a concurrency-safe migration in
SnapAccountServiceto move accounts from the legacy global Snap keyring into per-SnapSnapKeyringv2 instances, removes the legacy keyring afterward, and makesensureReadyrun migration + auto-create a missing v2 keyring for the requested Snap.Updates Snap message delegation and selected-account forwarding to target v2 keyrings via
KeyringController:withKeyringV2/withKeyringV2Unsafe, including filtering selected accounts to only those owned by each Snap and special-casingGetSelectedAccounts.Migrates
multichain-account-serviceSnap providers to usewithKeyringV2and the@metamask/eth-snap-keyring/v2API (includingdeleteAccountand updatedcreateAccount(s)signatures), and bumps@metamask/eth-snap-keyringto^22.1.0across affected packages.Reviewed by Cursor Bugbot for commit 61b8446. Bugbot is set up for automated code reviews on this repo. Configure here.