fix(snap-account-service)!: relax keyring messages/methods handling#8860
Open
ccharly wants to merge 5 commits into
Open
fix(snap-account-service)!: relax keyring messages/methods handling#8860ccharly wants to merge 5 commits into
ccharly wants to merge 5 commits into
Conversation
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. |
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
1 participant
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
We used to always auto-create the legacy Snap keyring (and in the future, Snap keyring v2 instances) automatically when handling events/methods, but this can sometimes cause some deadlock, especially with v1 events (e.g. you call
keyring.removeAccountwhich will send anotify:accountDeleted).This was working fine before cause a lot of consumers were creating the Snap keyring in an unsafe way (combining
getKeyringsByTypeandaddNewKeyring).We now only delegate those calls to the Snap keyring only when this makes sense!
References
N/A
Checklist
Note
Medium Risk
Changes runtime behavior of
handleKeyringSnapMessageand selected-account forwarding to conditionally skip/throw when the legacy Snap keyring is missing, which could affect Snap lifecycle and event handling if callers relied on implicit keyring creation.Overview
Reduces deadlock risk by stopping implicit legacy Snap keyring creation in most code paths:
handleKeyringSnapMessagenow checks keyring availability viaKeyringController:withKeyringUnsafeand only auto-creates the keyring forKeyringEvent.AccountCreated.Adds special handling for
SnapManageAccountsMethod.GetSelectedAccounts(returns[]if the keyring doesn’t exist yet) and updates selected-account forwarding to silently skip when the keyring is missing instead of creating it. Tests, changelog, and dependencies are updated accordingly (new@metamask/keyring-api/@metamask/keyring-snap-sdk).Reviewed by Cursor Bugbot for commit bfa94c0. Bugbot is set up for automated code reviews on this repo. Configure here.