feat(keyring-api): add initial keyring v2 interface #397
Conversation
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
mathieuartu
changed the title
ccharly
reviewed
Nov 12, 2025
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
ccharly
reviewed
Nov 13, 2025
ccharly
reviewed
Nov 14, 2025
mathieuartu
force-pushed
the
feat/keyring-v2-interface
branch
from
5f083b8 to
5a7b40a
Compare
Contributor
|
LGTM! @ccharly, do you want to discuss further how to enforce the methods and arguments based on the capabilities or should we merge this PR as is? I'm fine with both approaches. |
Contributor
|
I think it's ok to go with this version for now, we can try to work in parallel with that "keyring capabilities combinations" ideas in parallel IMO 👍 |
ccharly
reviewed
Nov 19, 2025
| return CreateAccountPrivateKeyOptionsStruct; | ||
| default: | ||
| // Return first struct as fallback - validation will fail with proper error indicating the type mismatch | ||
| return CreateAccountBip44DerivePathOptionsStruct; |
Contributor
There was a problem hiding this comment.
For future improvements, I think we could have a specific Struct for this which is the union of all various type values, so it does not default only to bip44:derive-path, but that's fine for now
Co-authored-by: Charly Chevalier <[email protected]>
ccharly
approved these changes
Nov 19, 2025
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.
Related to the Unified Keyring Interface ADR
Fixes MUL-1225
Examples
Note
Adds the new Keyring V2 interface and supporting v2 types for account creation/export, capabilities, and keyring types, with tests and README note.
@metamask/keyring-api/src/api/v2: New module exportingkeyring.ts(KeyringV2),keyring-capabilities.ts(KeyringCapabilitiesStruct),keyring-type.ts(KeyringType),private-key.ts(encodings/import/export formats),create-account/*(BIP‑44 derive/discover and private key import options + union), andexport-account/*(private key export options/results + union).api/index.tsto export./v2.KeyringAccountTypeStructinapi/account.tsfor validatingKeyringAccountType.CreateAccountOptionsStructand type tests (keyring.test-d.ts) covering enums, option unions, capabilities, and exports.KeyringV2(WIP) and its path.Written by Cursor Bugbot for commit 9f4da7f. This will update automatically on new commits. Configure here.