feat(keyring-controller): add withKeyringV2 and deprecate withKeyring#8372
Draft
mathieuartu wants to merge 3 commits intomainfrom
Draft
feat(keyring-controller): add withKeyringV2 and deprecate withKeyring#8372mathieuartu wants to merge 3 commits intomainfrom
withKeyringV2 and deprecate withKeyring#8372mathieuartu wants to merge 3 commits intomainfrom
Conversation
withKeyringV2 and deprecate withKeyring
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
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
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
References
For example:
-->
Checklist
Note
Medium Risk
Adds a new atomic keyring-operation API that wraps V1 keyrings into
KeyringV2adapters and introduces new builder registration, which could affect keyring mutation/persistence and error handling paths. Dependency bumps for keyring packages also change transitive behavior/types used by the controller.Overview
Introduces
KeyringController.withKeyringV2(and messenger actionKeyringController:withKeyringV2) to run mutually-exclusive, persist-or-rollback operations against a selected keyring using theKeyringV2API, including safeguards against returning the wrapped keyring instance.Adds a
keyringV2Buildersconstructor option plus default V2 builders for HD and Simple keyrings (HdKeyringV2,SimpleKeyringV2), and throws a newKeyringV2NotSupportederror when no builder exists. MarkswithKeyringas deprecated in favor ofwithKeyringV2, updates tests accordingly, and bumps@metamask/eth-hd-keyring/@metamask/eth-simple-keyringto versions that provide the V2 adapters.Written by Cursor Bugbot for commit 5b9a85a. This will update automatically on new commits. Configure here.