feat(keyring-controller): add withKeyringV2 support#8390
Open
feat(keyring-controller): add withKeyringV2 support#8390
withKeyringV2 support#8390Conversation
ccharly
force-pushed
the
cc/add-withkeyringv2-keyring-controller
branch
from
5a456ff to
41df780
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
ccharly
commented
Apr 8, 2026
Comment on lines
+20
to
+23
| branches: 94.91, | ||
| functions: 100, | ||
| lines: 99.03, | ||
| statements: 99.04, | ||
| lines: 99.11, | ||
| statements: 99.12, |
Contributor
Author
There was a problem hiding this comment.
Currently, that's what we have on main:
----------------------|---------|----------|---------|---------|------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------------------|---------|----------|---------|---------|------------------------------
All files | 99.04 | 95.09 | 100 | 99.03 |
KeyringController.ts | 98.93 | 94.52 | 100 | 98.92 | 647,2099,2473,2485,2529,2836
constants.ts | 100 | 100 | 100 | 100 |
errors.ts | 100 | 100 | 100 | 100 |
----------------------|---------|----------|---------|---------|------------------------------And the new coverage is like this:
----------------------|---------|----------|---------|---------|------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------------------|---------|----------|---------|---------|------------------------------
All files | 99.12 | 94.91 | 100 | 99.11 |
KeyringController.ts | 99.03 | 94.37 | 100 | 99.01 | 736,2412,2796,2808,2852,3190
constants.ts | 100 | 100 | 100 | 100 |
errors.ts | 100 | 100 | 100 | 100 |
----------------------|---------|----------|---------|---------|------------------------------Same number of lines not covered, so nothing has changed in terms of coverage.
Contributor
Author
There was a problem hiding this comment.
Another small update after rebasing:
----------------------|---------|----------|---------|---------|------------------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------------------|---------|----------|---------|---------|------------------------------
All files | 99.09 | 94.91 | 100 | 99.08 |
KeyringController.ts | 99 | 94.37 | 100 | 98.98 | 632,2202,2586,2598,2642,2980
constants.ts | 100 | 100 | 100 | 100 |
errors.ts | 100 | 100 | 100 | 100 |
----------------------|---------|----------|---------|---------|------------------------------
ccharly
force-pushed
the
cc/add-withkeyringv2-keyring-controller
branch
from
50b0fc4 to
54abb25
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/add-withkeyringv2-keyring-controller
branch
from
39cc64a to
3c61b0b
Compare
ccharly
changed the title
withKeyringV2 and deprecate withKeyringwithKeyringV2 support
ccharly
force-pushed
the
cc/add-withkeyringv2-keyring-controller
branch
from
3c61b0b to
8667557
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/add-withkeyringv2-keyring-controller
branch
from
d452085 to
6b4f746
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. |
mathieuartu
reviewed
Apr 13, 2026
| * the given operation with the wrapped keyring as a mutually | ||
| * exclusive atomic operation. | ||
| * | ||
| * We re-wrap the keyring in a `KeyringV2` adapter on each invocation, |
Contributor
There was a problem hiding this comment.
This is not true anymore based on your awesome work ⭐
Contributor
Author
There was a problem hiding this comment.
Ah damn true, I forgot to update the docs with this 🙈 Let me re-write something for this
Comment on lines
+1925
to
+1926
| * We re-wrap the keyring in a `KeyringV2` adapter on each invocation, | ||
| * since V2 wrappers are ephemeral adapters created on-the-fly, and cheap to create. |
Contributor
There was a problem hiding this comment.
No longer true, we could add something like The cached KeyringV2 adapter is retrieved from the keyring entry. instead? WDYT?
Comment on lines
+1936
to
+1937
| * Selection is performed against the V1 keyrings in `#keyrings`, since | ||
| * V2 wrappers are ephemeral adapters created on-the-fly. |
Comment on lines
+329
to
+330
| * Selection is performed against the V1 keyrings in `#keyrings`, since | ||
| * V2 wrappers are ephemeral adapters created on-the-fly. |
| /** | ||
| * Keyring selector used for `withKeyringV2` (see {@link KeyringController#withKeyringV2} and {@link KeyringSelector}). | ||
| */ | ||
| export type KeyringSelectorV2<SelectedKeyring extends KeyringV2 = KeyringV2> = |
Contributor
There was a problem hiding this comment.
Wondering if the generic is overkill? We always narrow down to KeyringV2 in the filter I guess?
Contributor
Author
There was a problem hiding this comment.
I think we should keep it. We introduced this recently with @danroc and this allow us to do stuff like:
await controller.withKeyringV2({ filter: isSnapKeyring }, ({ keyring }) => {
if (keyring.getSnapId() === ...) { // Only available on `SnapKeyringV2`.
...
}
});Like keyring is already properly inferred as SnapKeyringV2 AND we still have a constraint of KeyringV2, so semantically this is still correct!
Comment on lines
+1985
to
+1989
| if (Object.is(result, keyring)) { | ||
| throw new KeyringControllerError( | ||
| KeyringControllerErrorMessage.UnsafeDirectKeyringAccess, | ||
| ); | ||
| } |
Contributor
There was a problem hiding this comment.
Nit: duplication here and in the unsafe variant. Could we use a broader version of assertNoUnsafeDirectKeyringAccess maybe?
Contributor
Author
There was a problem hiding this comment.
Maybe it's time yep 😄 I'll see what I can do!
Co-authored-by: Mathieu Artu <mathieu.artu@consensys.net>
Co-authored-by: Mathieu Artu <mathieu.artu@consensys.net>
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
Another approach for
withKeyringV2where we actually extend the existing list of keyring instances to have an optionalkeyringV2field.This allow to keep them in memory and have the same lifecycle than v1 keyring instance (and since all v2 implementations are wrappers for now, they are "bound" to v1 instances anyway).
Original PR:
withKeyringV2and deprecatewithKeyring#8372References
N/A
Checklist
Note
Medium Risk
Introduces new V2 keyring selection/execution paths and caches V2 adapters alongside legacy keyrings, which could affect keyring lifecycle, rollback/persistence behavior, and error handling. Dependency bumps to keyring packages may also subtly change signing/account behavior.
Overview
Adds first-class
KeyringV2support by storing an optional in-memory V2 adapter next to each legacy keyring entry and creating/destroying these adapters during keyring create/restore/clear flows.Introduces
withKeyringV2(locked, persisted/rollback) andwithKeyringV2Unsafe(lock-free, no rollback) APIs plus messenger action types, including a newKeyringSelectorV2(type/address/id/filter) and aKeyringV2NotSupportederror when no V2 builder exists for a selected keyring.Updates tests to cover selector variants, lock/rollback semantics, and messenger callability; bumps
@metamask/eth-hd-keyring/@metamask/eth-simple-keyringversions and adjusts Jest coverage thresholds accordingly.Reviewed by Cursor Bugbot for commit d8bc565. Bugbot is set up for automated code reviews on this repo. Configure here.