Release 254.0.0 #4956

ccharly · 2024-11-21T10:37:39Z

Major release for accounts-related packages (mostly due to peer dependency updates).

Mostly to align versions of the keyring-api to enable Solana support in the extension.

Related PR

chore: adds Solana support for the account overview metamask-extension#28411

mikesposito · 2024-11-21T11:50:40Z

packages/accounts-controller/CHANGELOG.md

+
+### Changed
+
+- Bump `@metamask/keyring-api` from `^8.1.3` to `^10.1.0` ([#4948](https://github.com/MetaMask/core/pull/4948))


@metamask/keyring-api v10 ships with a @metamask/providers (peer dependency) major version update that consumers of this package will have to update to, to avoid things breaking. I think this should be a major release for keyring-controller as well - what do you think?

I think you are right yes... I did some digging yesterday about this, and the versions seem ok using yarn why, see:

chore: bump @metamask/{keyring-api,eth-snap-keyring,snaps-*} #4948 (comment)

However, I still think we should have bump the direct dependencies to snaps-* in the keyring-api to "align" the minimum dependency on @metamask/providers...

I will re-release all packages and update the changelogs accordingly. I'm on it now.

Posted in another comment but is this right? The @metamask/providers peer dependency tells me that the thing that depends on @metamask/keyring-api should also depend on @metamask/providers, not the client. Or am I understanding this wrong? See other thread. We can resolve this conversation.

socket-security · 2024-11-21T14:32:43Z

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected]

View full report↗︎

packages/accounts-controller/CHANGELOG.md

packages/assets-controllers/package.json

packages/chain-controller/CHANGELOG.md

Co-authored-by: Elliot Winkler <[email protected]>

…o `^9.7.0` (#4959) ## Explanation This change was not required, and bumping peer dependency does require the "consumer" of that packages to potentially update his packages too, which would result in a breaking change for the `accounts-controller` here. ## References - #4956 (comment) ## Changelog N/A (since we would revert to the state of the last release of the `accounts-controller` for that specific line). ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate - [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

mcmire

A few more things but otherwise this looks good.

packages/chain-controller/CHANGELOG.md

packages/keyring-controller/CHANGELOG.md

packages/user-operation-controller/CHANGELOG.md

packages/transaction-controller/package.json

packages/assets-controllers/CHANGELOG.md

packages/chain-controller/CHANGELOG.md

Co-authored-by: Elliot Winkler <[email protected]>

mcmire

LGTM!

…1` (#28545) ## **Description** Updating the `keyring-api` and Snap keyring alongside other controllers that depend on those versions too. Some controllers from [this release](MetaMask/core#4956) were left out from this PR mainly because the current major version being used in the extension is not updated yet. The current included controllers do have a peer dependency to either the `keyring-controller` or the `accounts-controller` which is why they are being included in this PR. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/28545?quickstart=1) ## **Related issues** - MetaMask/core#4956 ## **Manual testing steps** N/A ## **Screenshots/Recordings** ### **Before** ### **After** ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

## **Description** All accounts-related packages have been moved to our new [monorepo](https://github.com/MetaMask/accounts). A new patch version has been released for each of them. Those new versions have been used and released in all core controllers: MetaMask/core#4734 This repository contains the following packages [1](https://github.com/MetaMask/accounts#user-content-fn-fn1-2bb23fc02fdc197b87e0d6543909d37e): - [@metamask/eth-hd-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-hd): ✅ we are already using the latest version 9.0.0 - [@metamask/eth-ledger-bridge-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-ledger-bridge): We are using [version 6.0.0](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-ledger-bridge/CHANGELOG.md#600) which is already pointing to the mono repo. - [@metamask/eth-simple-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-simple): ✅ Not used on mobile. [@metamask/eth-snap-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap): ⚠️ Needs updating. Changes described below. - [@metamask/eth-trezor-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-trezor): ✅ Not used on mobile. [@metamask/keyring-api](https://github.com/MetaMask/accounts/blob/main/packages/keyring-api): ⚠️ Needs updating. Changes described below. ### Summary of the updates #### @metamask/accounts-controller 19.0.0 -> 20.0.1 - Breaking Changes: - Changed - BREAKING: Bump peer dependency @metamask/keyring-controller from ^18.0.0 to ^19.0.0 (MetaMask/core#4956). - BREAKING: Bump @metamask/keyring-api from ^8.1.3 to ^10.1.0 (MetaMask/core#4948) - If you are depending on @metamask/providers directly, you will need to upgrade to 18.1.0. - [changelog](https://github.com/MetaMask/core/blob/main/packages/accounts-controller/CHANGELOG.md#2001) #### @metamask/keyring-controller 18.0.0 -> 19.0.1 Updated to support the latest version of the accounts controller. - Breaking changes: - BREAKING: Bump @metamask/keyring-api from ^8.1.3 to ^10.1.0 (MetaMask/core#4948) If you are depending on @metamask/providers directly, you will need to upgrade to 18.1.0. #### @metamask/providers 16.1.0-> 18.1.0 This was changed largely to support the newest version of the accounts controller and keyring controller. - Breaking Changes: - Fixed - BREAKING: Change webextension-polyfill from dependency to peerDependency (MetaMask/providers#319) - Users are now expected to have the polyfill in their environment - BREAKING: Bump @metamask/json-rpc-engine from ^9.0.1 to ^10.0.0 (MetaMask/providers#378) - BREAKING: Bump @metamask/rpc-errors from ^6.4.0 to ^7.0.0 (MetaMask/providers#373) - [Changelog](https://github.com/MetaMask/providers/blob/main/CHANGELOG.md#1810) #### @metamask/keyring-api 8.1.0 -> 10.1.0 [Version 8.1.1](https://github.com/MetaMask/accounts/blob/main/packages/keyring-api/CHANGELOG.md#811) onward is using the new mono repo. I updated to version 10.1.0 to support the breaking changes in the accounts controller bump from v19.0.0 to v20.0.1 - Breaking Changes: - BREAKING: Rename btc_sendmany method to sendBitcoin (MetaMask/accounts#73) - BREAKING: Bump peer dependency @metamask/providers from ^17.2.0 to ^18.1.0 (MetaMask/accounts#76) #### @metamask/eth-snap-keyring 4.3.3 -> 5.0.1 - [Version 4.3.4](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap-bridge/CHANGELOG.md#434) an onward is using the new accounts mono repo. - Breaking Changes: - BREAKING: Bump @metamask/eth-sig-util dependency from ^7.0.3 to ^8.0.0 (MetaMask/accounts#79) signTypedData no longer support number for addresses, see [here](https://github.com/MetaMask/eth-sig-util/blob/main/CHANGELOG.md#800). - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap-bridge/CHANGELOG.md#440) #### @metamask/eth-sig-util 7.0.2 -> 8.0.0 Updated to support version 5 of the eth-snap-keyring. These breaking changes do not effect the application. - Breaking changes: - BREAKING: Values of type number are not accepted as address parameter anymore. Valid values are string and Uint8Array. (MetaMask/eth-sig-util#391) BREAKING: Drop support for Node.js versions 16, 21. (MetaMask/eth-sig-util#390) #### Added webextension-polyfill [webextension-polyfill](https://github.com/mozilla/webextension-polyfill) is required as a peer dependancy in newest updated of the `@metamask/providers` package. The changelog states that `"Users are now expected to have the polyfill in their environment"`. [Extension is using version 0.8.0](https://github.com/MetaMask/metamask-extension/blob/95301f48f819080a7c5124601815cbee7dfdddce/package.json#L677) of this package. ## **Related issues** Fixes: MetaMask/accounts-planning#614 Related issues Related to: MetaMask/accounts#39 MetaMask/accounts#50 MetaMask/accounts#54 MetaMask/core#4713 MetaMask/core#4734 ## **Manual testing steps** 1. Importing an account should work as expected 2. Snap accounts should work as expected 3. Hardware wallets should work as expected ## **Screenshots/Recordings**  ### **Before**  ### **After** Importing an account ✅ : https://github.com/user-attachments/assets/77625167-8b05-4cd8-89fe-6903b8f414a1 Snap accounts ✅ : https://github.com/user-attachments/assets/4ae1d7f7-f91a-4294-b0e6-6efeac3cea8a Importing private key ✅ : https://github.com/user-attachments/assets/891ba01e-b516-47f9-9fb7-e07d0e31ee24 ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

All accounts-related packages have been moved to our new [monorepo](https://github.com/MetaMask/accounts). A new patch version has been released for each of them. Those new versions have been used and released in all core controllers: MetaMask/core#4734 This repository contains the following packages [1](https://github.com/MetaMask/accounts#user-content-fn-fn1-2bb23fc02fdc197b87e0d6543909d37e): - [@metamask/eth-hd-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-hd): ✅ we are already using the latest version 9.0.0 - [@metamask/eth-ledger-bridge-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-ledger-bridge): We are using [version 6.0.0](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-ledger-bridge/CHANGELOG.md#600) which is already pointing to the mono repo. - [@metamask/eth-simple-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-simple): ✅ Not used on mobile. [@metamask/eth-snap-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap): ⚠️ Needs updating. Changes described below. - [@metamask/eth-trezor-keyring](https://github.com/MetaMask/accounts/blob/main/packages/keyring-eth-trezor): ✅ Not used on mobile. [@metamask/keyring-api](https://github.com/MetaMask/accounts/blob/main/packages/keyring-api): ⚠️ Needs updating. Changes described below. - Breaking Changes: - Changed - BREAKING: Bump peer dependency @metamask/keyring-controller from ^18.0.0 to ^19.0.0 (MetaMask/core#4956). - BREAKING: Bump @metamask/keyring-api from ^8.1.3 to ^10.1.0 (MetaMask/core#4948) - If you are depending on @metamask/providers directly, you will need to upgrade to 18.1.0. - [changelog](https://github.com/MetaMask/core/blob/main/packages/accounts-controller/CHANGELOG.md#2001) Updated to support the latest version of the accounts controller. - Breaking changes: - BREAKING: Bump @metamask/keyring-api from ^8.1.3 to ^10.1.0 (MetaMask/core#4948) If you are depending on @metamask/providers directly, you will need to upgrade to 18.1.0. This was changed largely to support the newest version of the accounts controller and keyring controller. - Breaking Changes: - Fixed - BREAKING: Change webextension-polyfill from dependency to peerDependency (MetaMask/providers#319) - Users are now expected to have the polyfill in their environment - BREAKING: Bump @metamask/json-rpc-engine from ^9.0.1 to ^10.0.0 (MetaMask/providers#378) - BREAKING: Bump @metamask/rpc-errors from ^6.4.0 to ^7.0.0 (MetaMask/providers#373) - [Changelog](https://github.com/MetaMask/providers/blob/main/CHANGELOG.md#1810) [Version 8.1.1](https://github.com/MetaMask/accounts/blob/main/packages/keyring-api/CHANGELOG.md#811) onward is using the new mono repo. I updated to version 10.1.0 to support the breaking changes in the accounts controller bump from v19.0.0 to v20.0.1 - Breaking Changes: - BREAKING: Rename btc_sendmany method to sendBitcoin (MetaMask/accounts#73) - BREAKING: Bump peer dependency @metamask/providers from ^17.2.0 to ^18.1.0 (MetaMask/accounts#76) - [Version 4.3.4](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap-bridge/CHANGELOG.md#434) an onward is using the new accounts mono repo. - Breaking Changes: - BREAKING: Bump @metamask/eth-sig-util dependency from ^7.0.3 to ^8.0.0 (MetaMask/accounts#79) signTypedData no longer support number for addresses, see [here](https://github.com/MetaMask/eth-sig-util/blob/main/CHANGELOG.md#800). - [changelog](https://github.com/MetaMask/accounts/blob/main/packages/keyring-snap-bridge/CHANGELOG.md#440) Updated to support version 5 of the eth-snap-keyring. These breaking changes do not effect the application. - Breaking changes: - BREAKING: Values of type number are not accepted as address parameter anymore. Valid values are string and Uint8Array. (MetaMask/eth-sig-util#391) BREAKING: Drop support for Node.js versions 16, 21. (MetaMask/eth-sig-util#390) [webextension-polyfill](https://github.com/mozilla/webextension-polyfill) is required as a peer dependancy in newest updated of the `@metamask/providers` package. The changelog states that `"Users are now expected to have the polyfill in their environment"`. [Extension is using version 0.8.0](https://github.com/MetaMask/metamask-extension/blob/95301f48f819080a7c5124601815cbee7dfdddce/package.json#L677) of this package. Fixes: MetaMask/accounts-planning#614 Related issues Related to: MetaMask/accounts#39 MetaMask/accounts#50 MetaMask/accounts#54 MetaMask/core#4713 MetaMask/core#4734 1. Importing an account should work as expected 2. Snap accounts should work as expected 3. Hardware wallets should work as expected   Importing an account ✅ : https://github.com/user-attachments/assets/77625167-8b05-4cd8-89fe-6903b8f414a1 Snap accounts ✅ : https://github.com/user-attachments/assets/4ae1d7f7-f91a-4294-b0e6-6efeac3cea8a Importing private key ✅ : https://github.com/user-attachments/assets/891ba01e-b516-47f9-9fb7-e07d0e31ee24 - [x] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

ccharly added 3 commits November 21, 2024 11:28

Initialize Release 254.0.0

461964b

Update Release 254.0.0

eabc43e

chore: update changelogs

afbeb5b

ccharly changed the title ~~Release/254.0.0~~ Release 254.0.0 Nov 21, 2024

ccharly marked this pull request as ready for review November 21, 2024 10:43

ccharly requested review from a team as code owners November 21, 2024 10:43

zone-live previously approved these changes Nov 21, 2024

View reviewed changes

gantunesr previously approved these changes Nov 21, 2024

View reviewed changes

matthewwalsh0 previously approved these changes Nov 21, 2024

View reviewed changes

mikesposito reviewed Nov 21, 2024

View reviewed changes

ccharly added 2 commits November 21, 2024 15:07

Update Release 254.0.0

47f1e8d

chore: update changelogs

9b2827c

ccharly dismissed stale reviews from matthewwalsh0, gantunesr, and zone-live via 9b2827c November 21, 2024 14:28

fix: fix changelogs

c95d82f

mcmire reviewed Nov 21, 2024

View reviewed changes

chore: also release the assets-controllers

00683a5

ccharly mentioned this pull request Nov 21, 2024

chore: downgrade snaps-controllers peer dependency from ^9.10.0 to ^9.7.0 #4959

Merged

4 tasks

chore: better changelog entry

e1904af

Co-authored-by: Elliot Winkler <[email protected]>

ccharly added 3 commits November 21, 2024 19:26

chore: remove snaps-controllers peer dependency bump entry

138e7fa

chore(chain-controller): 1.0.0 -> 0.2.0

16081bb

chore: cosmetic

69aa8d6

Merge branch 'main' into release/254.0.0

796ccfc

mcmire reviewed Nov 21, 2024

View reviewed changes

ccharly and others added 4 commits November 21, 2024 21:10

chore: better comments on changelog entries

0df0b85

Co-authored-by: Elliot Winkler <[email protected]>

chore: remove duplicated entries

229a2fc

Co-authored-by: Elliot Winkler <[email protected]>

chore: add missing changelog entry for assets-controllers

7f0ffa6

chore: replace changelog entry for user-operation-controller

627ec8a

mcmire approved these changes Nov 21, 2024

View reviewed changes

ccharly merged commit b831256 into main Nov 21, 2024
120 checks passed

ccharly deleted the release/254.0.0 branch November 21, 2024 20:43

ccharly mentioned this pull request Nov 22, 2024

chore: bump keyring-api to ^10.1.0 + eth-snap-keyring to ^5.0.1 MetaMask/metamask-extension#28545

Merged

7 tasks

owencraston mentioned this pull request Dec 4, 2024

chore: Update accounts packages MetaMask/metamask-mobile#12555

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release 254.0.0 #4956

Release 254.0.0 #4956

ccharly commented Nov 21, 2024 •

edited

Loading

mikesposito Nov 21, 2024

ccharly Nov 21, 2024

ccharly Nov 21, 2024

mcmire Nov 21, 2024 •

edited

Loading

socket-security bot commented Nov 21, 2024 •

edited

Loading

mcmire left a comment

mcmire left a comment


		### Changed

		- Bump `@metamask/keyring-api` from `^8.1.3` to `^10.1.0` ([#4948](https://github.com/MetaMask/core/pull/4948))

Release 254.0.0 #4956

Release 254.0.0 #4956

Conversation

ccharly commented Nov 21, 2024 • edited Loading

Related PR

mikesposito Nov 21, 2024

Choose a reason for hiding this comment

ccharly Nov 21, 2024

Choose a reason for hiding this comment

ccharly Nov 21, 2024

Choose a reason for hiding this comment

mcmire Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

socket-security bot commented Nov 21, 2024 • edited Loading

mcmire left a comment

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

ccharly commented Nov 21, 2024 •

edited

Loading

mcmire Nov 21, 2024 •

edited

Loading

socket-security bot commented Nov 21, 2024 •

edited

Loading