refactor: use new @metamask/keyring-api layout (split packages)#28861
Merged
refactor: use new @metamask/keyring-api layout (split packages)#28861
@metamask/keyring-api layout (split packages)#28861Conversation
Contributor
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/@metamask/accounts-controller@20.0.0, npm/@metamask/eth-snap-keyring@5.0.1, npm/@metamask/keyring-api@10.1.0 |
db007ee to
6c9889d
Compare
6c9889d to
bf4405f
Compare
3 tasks
Collaborator
Builds ready [238f522]
Page Load Metrics (2009 ± 136 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
ccharly
added a commit
to MetaMask/core
that referenced
this pull request
Dec 11, 2024
) ## Explanation The `keyring-api` has been split out into multiple smaller packages, this introduce some breaking changes since some exports have been moved elsewhere. This was done to reduce the number of required dependencies for the `keyring-api`. The `InternalAccount` type (widely used internally by some controllers) has been moved to a new package: `@metamask/keyring-internal-api`. ## References Relates to: - MetaMask/accounts#24 Basic testing done through the CI + preview builds: - MetaMask/metamask-extension#28861 ## Changelog ### `@metamask/keyring-controller` - **CHANGED**: Remove use of peer dependency `@metamask/providers` - **CHANGED**: Bump `@metamask/keyring-api` to `^12.0.0` - **CHANGED**: Use `@metamask/keyring-internal-api@^1.0.0` > Even if we are bumping the major of the `keyring-api`, this is not breaking since all > types from the split are compatible. The only difference now here is the `Keyring` > interface which has a new optional method `listAccountTransactions`, optional, thus > non-breaking (and this type is not used there anyway) ### `@metamask/accounts-controller` - **CHANGED**: Bump `@metamask/keyring-api` to `^12.0.0` - **CHANGED**: Bump `@metamask/eth-snap-keyring` to `^7.0.0` - **CHANGED**: Use `@metamask/keyring-internal-api@^1.0.0` > `eth-snap-keyring` has been bumped to `7.0.0` but this was a mistake since no breaking changes has been introduced there either. > The version `6.0.0` also introduces `ts-bridge` builds, but this is already compatible with this repo, so not breaking here either. ### `@metamask/assets-controllers` - **CHANGED**: Remove use of `@metamask/keyring-api` - **CHANGED**: Use `@metamask/keyring-internal-api@^1.0.0` ### `@metamask/chain-controller` - **CHANGED**: Remove use of `@metamask/keyring-api` - **CHANGED**: Use `@metamask/keyring-internal-api@^1.0.0` - **CHANGED**: Use `@metamask/keyring-utils@^1.0.0` ### `@metamask/profile-sync-controller` - **CHANGED**: Remove use of `@metamask/keyring-api` - **CHANGED**: Use `@metamask/keyring-internal-api@^1.0.0` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
matthewwalsh0
previously approved these changes
Dec 17, 2024
NidhiKJha
previously approved these changes
Dec 17, 2024
79dad4d
darioAnongba
approved these changes
Dec 17, 2024
Prithpal-Sooriya
approved these changes
Dec 17, 2024
danroc
approved these changes
Dec 17, 2024
matthewwalsh0
approved these changes
Dec 18, 2024
jonybur
approved these changes
Dec 18, 2024
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
12 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.
Description
Bumping accounts related dependencies + use the new
keyring-apilayout.Those tests requires a higher timeout (which might not be true once merged to
main)flags = {"circleci": {"timeoutMinutes": 35}}Related issues
N/A
Manual testing steps
N/A
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist