chore: Update accounts packages #12555

owencraston · 2024-12-04T20:22:43Z

Description

All accounts-related packages have been moved to our new monorepo.

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:

@metamask/eth-hd-keyring: ✅ we are already using the latest version 9.0.0
@metamask/eth-ledger-bridge-keyring: We are using version 6.0.0 which is already pointing to the mono repo.
@metamask/eth-simple-keyring: ✅ Not used on mobile.
@metamask/eth-snap-keyring: ⚠️ Needs updating. Changes described below.
@metamask/eth-trezor-keyring: ✅ Not used on mobile.
@metamask/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 (Release 254.0.0 core#4956).
  - BREAKING: Bump @metamask/keyring-api from ^8.1.3 to ^10.1.0 (chore: bump @metamask/{keyring-api,eth-snap-keyring,snaps-*} core#4948)
  - If you are depending on @metamask/providers directly, you will need to upgrade to 18.1.0.
changelog

@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 (chore: bump @metamask/{keyring-api,eth-snap-keyring,snaps-*} 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 (fix(deps): move webextension-polyfill to peerDeps + devDeps 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 (deps: @metamask/json-rpc-engine@^9.0.1->^10.0.0 providers#378)
  - BREAKING: Bump @metamask/rpc-errors from ^6.4.0 to ^7.0.0 (Bump @metamask/rpc-errors from 6.4.0 to 7.0.0 providers#373)
Changelog

@metamask/keyring-api 8.1.0 -> 10.1.0

Version 8.1.1 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 (feat!: rename btc_sendmany to sendBitcoin accounts#73)
- BREAKING: Bump peer dependency @metamask/providers from ^17.2.0 to ^18.1.0 (chore(keyring-api): update peer dependency @metamask/providers@^17.2.0 -> ^18.1.0 accounts#76)

@metamask/eth-snap-keyring 4.3.3 -> 5.0.1

Version 4.3.4 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 (chore: bump dependency eth-sig-util@^7.0.3 -> ^8.0.0 accounts#79)
  signTypedData no longer support number for addresses, see here.
changelog

@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. (fix: Bypass numerical address cast eth-sig-util#391)
  BREAKING: Drop support for Node.js versions 16, 21. (drop support for Node.js versions 16, 21 eth-sig-util#390)

Added webextension-polyfill

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 of this package.

Related issues

Fixes: https://github.com/MetaMask/accounts-planning/issues/614

Related issues
Related to:

MetaMask/accounts#39
MetaMask/accounts#50
MetaMask/accounts#54
MetaMask/core#4713
MetaMask/core#4734

Manual testing steps

Importing an account should work as expected
Snap accounts should work as expected
Hardware wallets should work as expected

Screenshots/Recordings

Before

After

Importing an account ✅ :

Screen.Recording.2024-12-04.at.3.23.33.PM.mov

Snap accounts ✅ :

Screen.Recording.2024-12-04.at.3.26.41.PM.mov

Importing private key ✅ :

Screen.Recording.2024-12-04.at.3.35.39.PM.mov

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
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 format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

github-actions · 2024-12-04T20:22:58Z

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.

github-actions · 2024-12-04T20:23:21Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 8df9a0d
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/d10c2d95-39cc-4afe-b59d-c2ef650811b3

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

socket-security · 2024-12-04T20:23:56Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/accounts-controller@20.0.1	None	`0`	269 kB	metamaskbot
npm/@metamask/controller-utils@11.4.4	network	`0`	265 kB	metamaskbot
npm/@metamask/eth-snap-keyring@5.0.1	None	`+1`	299 kB	metamaskbot
npm/@metamask/keyring-api@10.1.0	None	`0`	265 kB	metamaskbot
npm/@metamask/keyring-controller@19.0.1	Transitive: environment	`+4`	825 kB	metamaskbot
npm/@metamask/message-manager@11.0.2	None	`0`	211 kB	metamaskbot
npm/@metamask/providers@18.2.0	None	`0`	440 kB	metamaskbot
npm/webextension-polyfill@0.12.0	None	`0`	205 kB	addons-robot

🚮 Removed packages: npm/@metamask/accounts-controller@19.0.0, npm/@metamask/controller-utils@11.4.3, npm/@metamask/eth-snap-keyring@4.4.0, npm/@metamask/message-manager@11.0.1, npm/@metamask/providers@18.1.1

View full report↗︎

github-actions · 2024-12-04T21:19:16Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: f8f8e67
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/8ebefcd9-07bd-4b83-b18c-4eab82265f2e

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

github-actions · 2024-12-04T22:22:52Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: b598c65
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/7c0d2875-1a69-4619-b090-60857740c83a

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

github-actions · 2024-12-04T23:09:56Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 750312c
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/e7d6dfba-1acc-4968-a8c7-ea35bc09490d

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

package.json

yarn.lock

github-actions · 2024-12-05T18:10:16Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 213f2c0
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/8778950b-92fc-459c-aeb0-6add97851b6e

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

github-actions · 2024-12-05T18:51:32Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: fb012cc
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/4791be78-d2d8-40ce-bcd0-dffaf9d076f6

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

sonarqubecloud · 2024-12-05T19:03:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

owencraston added the Run Smoke E2E Triggers smoke e2e on Bitrise label Dec 4, 2024

metamaskbot added the team-accounts label Dec 4, 2024

owencraston force-pushed the chore/accounts-monorepo-packages branch from 8cbd558 to f8f8e67 Compare December 4, 2024 21:08

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 4, 2024

owencraston changed the title ~~chore: Migrate mobile dependencies to use accounts monorepo versions~~ chore: Update accounts packages Dec 4, 2024

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 4, 2024

owencraston force-pushed the chore/accounts-monorepo-packages branch from cd7145c to 750312c Compare December 4, 2024 23:08

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 4, 2024

owencraston marked this pull request as ready for review December 4, 2024 23:29

owencraston requested review from a team as code owners December 4, 2024 23:29

tommasini previously approved these changes Dec 5, 2024

View reviewed changes

ccharly reviewed Dec 5, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

yarn.lock Outdated Show resolved Hide resolved

tommasini mentioned this pull request Dec 5, 2024

chore: bump @metamask/{preferences,assets}-controllers #12579

Merged

7 tasks

owencraston dismissed tommasini’s stale review via 213f2c0 December 5, 2024 18:07

owencraston force-pushed the chore/accounts-monorepo-packages branch from 750312c to 213f2c0 Compare December 5, 2024 18:07

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 5, 2024

owencraston added 2 commits December 5, 2024 10:50

chore: update accounts packages

9c936eb

dedupe

9b57697

owencraston added 3 commits December 5, 2024 10:50

update keyring controller to v19.0.1

e7ac78c

migrate keyring controller patch

c0a8f82

bump @metamask/eth-snap-keyring to v5

fb012cc

owencraston force-pushed the chore/accounts-monorepo-packages branch from 213f2c0 to fb012cc Compare December 5, 2024 18:50

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 5, 2024

tommasini approved these changes Dec 5, 2024

View reviewed changes

owencraston added this pull request to the merge queue Dec 5, 2024

Merged via the queue into main with commit 011560f Dec 5, 2024
40 checks passed

owencraston deleted the chore/accounts-monorepo-packages branch December 5, 2024 19:57

github-actions bot locked and limited conversation to collaborators Dec 5, 2024

metamaskbot added the release-7.38.0 Issue or pull request that will be included in release 7.38.0 label Dec 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Update accounts packages #12555

chore: Update accounts packages #12555

owencraston commented Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

socket-security bot commented Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 5, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 5, 2024 •

edited by metamaskbot

Loading

sonarqubecloud bot commented Dec 5, 2024

chore: Update accounts packages #12555

chore: Update accounts packages #12555

Conversation

owencraston commented Dec 4, 2024 • edited Loading

Description

Summary of the updates

@metamask/accounts-controller 19.0.0 -> 20.0.1

@metamask/keyring-controller 18.0.0 -> 19.0.1

@metamask/providers 16.1.0-> 18.1.0

@metamask/keyring-api 8.1.0 -> 10.1.0

@metamask/eth-snap-keyring 4.3.3 -> 5.0.1

@metamask/eth-sig-util 7.0.2 -> 8.0.0

Added webextension-polyfill

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Dec 4, 2024

github-actions bot commented Dec 4, 2024 • edited by metamaskbot Loading

Bitrise

socket-security bot commented Dec 4, 2024 • edited Loading

github-actions bot commented Dec 4, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Dec 4, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Dec 4, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Dec 5, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Dec 5, 2024 • edited by metamaskbot Loading

Bitrise

sonarqubecloud bot commented Dec 5, 2024

Quality Gate passed

owencraston commented Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

socket-security bot commented Dec 4, 2024 •

edited

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 4, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 5, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Dec 5, 2024 •

edited by metamaskbot

Loading