refactor: split keyring-api #24
Merged
Conversation
This file contains 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
ccharly
force-pushed
the
refactor/split-keyring-api
branch
5 times, most recently
from
4678982 to
55f15b4
Compare
|
@metamaskbot publish-preview |
1 similar comment
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
ccharly
force-pushed
the
refactor/split-keyring-api
branch
from
67f3b77 to
672cc7b
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
This was referenced Sep 13, 2024
ccharly
force-pushed
the
refactor/split-keyring-api
branch
from
672cc7b to
b9b21be
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
|
This PR is marked as stale because it has been open for 60 days with no activity. Please remove the stale label or leave a comment, or it will be closed in 14 days. |
danroc
reviewed
Dec 5, 2024
danroc
reviewed
Dec 5, 2024
danroc
reviewed
Dec 5, 2024
danroc
reviewed
Dec 5, 2024
danroc
reviewed
Dec 5, 2024
Co-authored-by: Daniel Rocha <[email protected]>
|
@metamaskbot publish-preview |
…ate tsconfig.scripts.json
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
danroc
reviewed
Dec 5, 2024
danroc
approved these changes
Dec 5, 2024
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions (from the Expand for full list of packages and versions. |
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
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.
Description
Split of the
keyring-apiinto smaller packages.Fixes: https://github.com/MetaMask/accounts-planning/issues/729