chore: Update assets and accounts packages #12984

owencraston · 2025-01-14T19:49:39Z

Description

The primary purpose of this PR is to update the accounts controller and the assets-controller to the latest version. In doing that, there were several other package updates that were needed. Here is a summary of the updates...

🔴 Major updates 🔴

"@metamask/accounts-controller": "^20.0.1" -> ^21.0.0

changelog
Breaking changes
- BREAKING: Add scopes field to KeyringAccount (feat!: add scopes field to KeyringAccount core#5066), (chore: update accounts-related packages versioning for new scopes feature core#5136)
  This field is now required and will be used to identify the supported chains (using CAIP-2 chain IDs) for every accounts.
Changes
- Bump @metamask/base-controller from ^7.0.0 to ^7.1.1 (Release 273.0.0 core#5079), (Release 280.0.0 core#5135)
- Bump @metamask/utils to ^11.0.1 (Bump @metamask/utils to ^11.0.1 and @metamask/rpc-errors to ^7.0.2 core#5080)
- Bump @metamask/rpc-errors to ^7.0.2 (Bump @metamask/utils to ^11.0.1 and @metamask/rpc-errors to ^7.0.2 core#5080)
- Use new @metamask/keyring-internal-api@^1.0.0 (refactor: use new @metamask/keyring-api layout (split packages) core#4695)
  This package has been split out from the Keyring API.
- Bump @metamask/keyring-api from ^10.1.0 to ^12.0.0 (refactor: use new @metamask/keyring-api layout (split packages) core#4695)
- Bump @metamask/eth-snap-keyring from ^5.0.1 to ^7.0.0 (refactor: use new @metamask/keyring-api layout (split packages) core#4695)
  ESM/CommonJS support.

"@metamask/assets-controllers": "^45.1.1", -> ^46.0.0",

changelog
Breaking changes
- BREAKING: Bump @metamask/accounts-controller peer dependency from ^20.0.0 to ^21.0.0 (Release 281.0.0 core#5140)
Changes
- Remove use of @metamask/keyring-api (refactor: use new @metamask/keyring-api layout (split packages) core#4695)
  @metamask/providers and webextension-polyfill peer dependencies are no longer required.
- Use new @metamask/keyring-internal-api@^1.0.0 (refactor: use new @metamask/keyring-api layout (split packages) core#4695)
  This package has been split out from the Keyring API. Its types are compatible with the @metamask/keyring-api package used previously.
- Bump @metamask/base-controller from ^7.0.0 to ^7.1.1 (Release 273.0.0 core#5079), (Release 280.0.0 core#5135)
- Bump @metamask/keyring-api from ^12.0.0 to ^13.0.0 (feat!: add scopes field to KeyringAccount core#5066)
- Bump @metamask/utils to ^11.0.1 (Bump @metamask/utils to ^11.0.1 and @metamask/rpc-errors to ^7.0.2 core#5080)
- Bump @metamask/rpc-errors to ^7.0.2 (Bump @metamask/utils to ^11.0.1 and @metamask/rpc-errors to ^7.0.2 core#5080)
Added
- Add new MultichainBalancesController (feat: add MultichainBalancesController core#4965)
  This controller has been migrated from the MetaMask extension codebase.

"@metamask/utils": "^10.0.1" -> ^11.0.1"

changelog
breaking changes
- BREAKING: generateRandomMnemonic now returns Promise instead of void (refactor!: make generateRandomMnemonic async utils#222)

Added "@metamask/keyring-internal-api": "^2.0.0",

changelog
This package was a peer dep on the latest accounts controller and assets controller. Given this I figured we should add it now anyway.
Changes needed
- update imports from @metamask/keyring-api to @metamask/keyring-internal-api
- add support for scopes in the InternalAccount object
- added migration (066.ts) to backfill the scopes to existing accounts.
  - This change is based off a similar change made in the extension made by @ccharly

Added @metamask/keyring-snap-client: "^2.0.0"

changelog
Added because KeyringClient is now exported from @metamask/keyring-snap-client instead of @metamask/keyring-api'. See app/components/Views/AddAccountActions/AddAccountActions.tsx for changes.

"@metamask/keyring-api": "^10.1.0", -> ^13.0.0"

changelog
Breaking changes
- BREAKING: Add scopes field to KeyringAccount (feat(keyring-api)!: add scopes field to KeyringAccount accounts#101)
- BREAKING: Split into several smaller packages (refactor: split keyring-api accounts#24)
  - This should improve dependencies management.
  - Internal related types (internal to both clients) have been moved to keyring-internal-* packages.
  - Keyring API clients (mainly used by dapps) have been moved to keyring-snap-client package.
  - Common utils have been moevd to keyring-utils package.

"@metamask/eth-snap-keyring": "^5.0.1" -> ^7.0.0"

changelog
breaking changes
- BREAKING: Increase minimum Node.js version to 16 (Increase minimum Node.js version to 16; recommended to 18 eth-simple-keyring#152)
- BREAKING: Bump @metamask/eth-sig-util from ^6.0.1 to ^7.0.0 (deps: @metamask/eth-sig-util@^6.0.1->^7.0.0 eth-simple-keyring#156)
- Bump @metamask/utils from ^5.0.0 to ^8.1.0 (deps: Update @metamask/utils to ^8.1.0, ethereum-cryptography to ^2.1.1 eth-simple-keyring#153)
- Bump ethereum-cryptography from ^1.2.0 to ^2.1.2 (deps: Update @metamask/utils to ^8.1.0, ethereum-cryptography to ^2.1.1 eth-simple-keyring#153)
- 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.

🟡 Minor updates 🟡

"@metamask/base-controller": "^7.0.1", -> ^7.1.1

changelog
Changes
- Bump @metamask/utils from ^10.0.0 to ^11.0.1
- Rename ControllerMessenger to Messenger (chore: Rename ControllerMessenger to Messenger core#5050)
  - ControllerMessenger has been renamed to Messenger
  - RestrictedControllerMessengerConstraint has been renamed to RestrictedMessengerConstraint
  - RestrictedControllerMessenger has been renamed to RestrictedMessenger
  - The RestrictedMessenger constructor parameter controllerMessenger has been renamed to messenger, though the old name is still accepted
  - The old names remain exported as deprecated aliases of the new names, so this is not a breaking change.

"@metamask/providers": "^18.1.0" -> ^18.3.1"

changelog
Changes
- Bump @metamask/json-rpc-engine from ^10.0.1 to ^10.0.2 (Bump MetaMask dependencies providers#397)
- Bump @metamask/json-rpc-middleware-stream from ^8.0.5 to ^8.0.6 (Bump MetaMask dependencies providers#397)
- Bump @metamask/rpc-errors from ^7.0.1 to ^7.0.2 (Bump MetaMask dependencies providers#397)
- Bump @metamask/utils from ^10.0.0 to ^11.0.1 (Bump MetaMask dependencies providers#397)

🟢 Patch updates 🟢

Related issues

Fixes: #12967
Fixes: #12966

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

Unblocks: #12599

Manual testing steps

Basic import account flow with tokens

Screen.Recording.2025-01-15.at.3.07.12.PM.mov

Screenshots/Recordings

Before

After

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 · 2025-01-14T19:49:52Z

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.

socket-security · 2025-01-14T19:51:07Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`0`	0 B
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`+1`	388 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`+1`	2.63 MB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	348 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	266 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	133 kB	danfinlay, gudahtt, kumavis, ...6 more
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	338 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	178 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`0`	50.3 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	484 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	63.5 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	32.2 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	59.2 kB	metamaskbot
npm/@metamask/[email protected]	None	`+1`	776 kB	metamaskbot
npm/@metamask/[email protected] 🔁 npm/@metamask/[email protected]	None	`+1`	668 kB	metamaskbot

View full report↗︎

github-actions · 2025-01-15T00:46:14Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: d4e2d35
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/b6060aa0-2256-4f9b-9de5-4b9b5aefbad4

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 · 2025-01-15T19:02:35Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: e739ac1
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/31e98c9b-ea89-4403-ab32-3890c31584e7

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 · 2025-01-15T20:05:03Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 9253cf0
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/c3f7c500-3e0e-4177-bb6f-cea6c8ccc969

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 · 2025-01-15T22:17:10Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 310cd82
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/3b1a6044-3f3e-4f47-8c2b-d493a734f527

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 · 2025-01-16T18:08:42Z

Bitrise

🔄🔄🔄 pr_smoke_e2e_pipeline started on Bitrise...🔄🔄🔄

Commit hash: 1829581
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/83242050-764c-4b77-8700-ea154a26270f

Note

This comment will auto-update when build completes
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 · 2025-01-16T18:33:55Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 992798e
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/8f866dbc-7861-4469-a4b1-3335ec64ec25

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

sonarqubecloud · 2025-01-16T18:43:08Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarQube Cloud

pedronfigueiredo

LGTM

metamaskbot added the team-accounts label Jan 14, 2025

owencraston force-pushed the chore/update-assets-controller branch from 2c6d5d9 to d4e2d35 Compare January 15, 2025 00:45

owencraston added the Run Smoke E2E Triggers smoke e2e on Bitrise label Jan 15, 2025

owencraston force-pushed the chore/update-assets-controller branch from bd54717 to e739ac1 Compare January 15, 2025 19:00

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jan 15, 2025

owencraston force-pushed the chore/update-assets-controller branch 2 times, most recently from 4e5e84a to 9253cf0 Compare January 15, 2025 20:04

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jan 15, 2025

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Jan 15, 2025

owencraston force-pushed the chore/update-assets-controller branch 2 times, most recently from 14199d5 to 310cd82 Compare January 15, 2025 22:16

owencraston marked this pull request as ready for review January 15, 2025 22:16

owencraston requested review from a team as code owners January 15, 2025 22:16

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jan 15, 2025

owencraston removed the Run Smoke E2E Triggers smoke e2e on Bitrise label Jan 15, 2025

capture exception if state is invalid

1829581

owencraston dismissed stale reviews from tommasini, FrederikBolding, and vinnyhoward via 1829581 January 16, 2025 17:59

owencraston force-pushed the chore/update-assets-controller branch from 51a63b8 to 1829581 Compare January 16, 2025 17:59

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jan 16, 2025

vinnyhoward previously approved these changes Jan 16, 2025

View reviewed changes

tommasini previously approved these changes Jan 16, 2025

View reviewed changes

fix lint

992798e

owencraston dismissed stale reviews from tommasini and vinnyhoward via 992798e January 16, 2025 18:32

vinnyhoward approved these changes Jan 16, 2025

View reviewed changes

tommasini approved these changes Jan 16, 2025

View reviewed changes

FrederikBolding approved these changes Jan 16, 2025

View reviewed changes

owencraston added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jan 16, 2025

sleepytanya approved these changes Jan 16, 2025

View reviewed changes

Prithpal-Sooriya approved these changes Jan 16, 2025

View reviewed changes

owencraston added this pull request to the merge queue Jan 16, 2025

pedronfigueiredo approved these changes Jan 16, 2025

View reviewed changes

sahar-fehri approved these changes Jan 16, 2025

View reviewed changes

Merged via the queue into main with commit 4c43298 Jan 16, 2025
41 of 42 checks passed

owencraston deleted the chore/update-assets-controller branch January 16, 2025 19:08

github-actions bot locked and limited conversation to collaborators Jan 16, 2025

metamaskbot added the release-7.39.0 Issue or pull request that will be included in release 7.39.0 label Jan 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Update assets and accounts packages #12984

chore: Update assets and accounts packages #12984

owencraston commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 14, 2025

socket-security bot commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 16, 2025

github-actions bot commented Jan 16, 2025 •

edited by metamaskbot

Loading

sonarqubecloud bot commented Jan 16, 2025

pedronfigueiredo left a comment

chore: Update assets and accounts packages #12984

chore: Update assets and accounts packages #12984

Conversation

owencraston commented Jan 14, 2025 • edited Loading

Description

🔴 Major updates 🔴

"@metamask/accounts-controller": "^20.0.1" -> ^21.0.0

"@metamask/assets-controllers": "^45.1.1", -> ^46.0.0",

"@metamask/utils": "^10.0.1" -> ^11.0.1"

Added "@metamask/keyring-internal-api": "^2.0.0",

Added @metamask/keyring-snap-client: "^2.0.0"

"@metamask/keyring-api": "^10.1.0", -> ^13.0.0"

"@metamask/eth-snap-keyring": "^5.0.1" -> ^7.0.0"

🟡 Minor updates 🟡

"@metamask/base-controller": "^7.0.1", -> ^7.1.1

"@metamask/providers": "^18.1.0" -> ^18.3.1"

🟢 Patch updates 🟢

"@metamask/json-rpc-engine": "^10.0.0" -> ^10.0.2",

"@metamask/json-rpc-middleware-stream": "^8.0.2" -> 8.0.6"

"@metamask/rpc-errors": "^7.0.1" -> ^7.0.2"

Related issues

Manual testing steps

Basic import account flow with tokens

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jan 14, 2025

socket-security bot commented Jan 14, 2025 • edited Loading

github-actions bot commented Jan 15, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Jan 15, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Jan 15, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Jan 15, 2025 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Jan 16, 2025

Bitrise

github-actions bot commented Jan 16, 2025 • edited by metamaskbot Loading

Bitrise

sonarqubecloud bot commented Jan 16, 2025

Quality Gate passed

pedronfigueiredo left a comment

Choose a reason for hiding this comment

owencraston commented Jan 14, 2025 •

edited

Loading

socket-security bot commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 15, 2025 •

edited by metamaskbot

Loading

github-actions bot commented Jan 16, 2025 •

edited by metamaskbot

Loading