chore: bump `@metamask/{keyring, profile-sync}-controller` #30637

mikesposito · 2025-02-28T12:30:41Z

Description

These packages are being bumped to their latest version:

`@metamask/keyring-controller`

BREAKING: addNewKeyring method now returns Promise<KeyringMetadata> instead of Promise<unknown> (#5372)
- Consumers can use the returned KeyringMetadata.id to access the created keyring instance via withKeyring.
BREAKING: withKeyring method now requires a callback argument of type ({ keyring: SelectedKeyring; metadata: KeyringMetadata }) => Promise<CallbackResult> (#5372)
Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)
Bump @metamask/eth-hd-keyring from ^10.0.0 to ^11.0.0 (#5405)
Bump @metamask/eth-simple-keyring from ^8.1.0 to ^9.0.0 (#5405)

`@metamask/profile-sync-controller`

Bump @metamask/keyring-internal-api from ^4.0.3 to ^5.0.0 (#5405)

`@metamask/eth-ledger-bridge-keyring`

BREAKING: LedgerKeyring now implements the Keyring type (#194)
- The class does not extend EventEmitter anymore.
- The LedgerKeyring.accounts class variable is now a readonly Hex[] array.
- The addAccounts method signature has been changed:
  - An amount number parameter is now required to specify the number of accounts to add.
  - The method now returns a promise resolving to an array of Hex addresses.
- The unlock method now returns Promise<Hex>.
- The getAccounts method now returns Promise<Hex[]>.
- The deserialize method now requires a LedgerKeyringSerializedState typed parameter.
- The signTransaction method now accepts an Hex typed value as the address parameter.
- The signMessage method now accepts an Hex typed value as the withAccount parameter.
- The signPersonalMessage method now accepts an Hex typed value as the withAccount parameter.
- The signTypedData method now accepts an Hex typed value as the withAccount parameter.
- The unlockAccountByAddress method now accepts an Hex typed value as the address parameter.

Related issues

Fixes:

Manual testing steps

Go to this page...

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension 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.

socket-security · 2025-02-28T12:33:56Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected] ➜ 11.0.0	None	`0`	143 kB	metamaskbot
npm/@metamask/[email protected] ➜ 9.0.0	None	`+1`	454 kB	metamaskbot
npm/@metamask/[email protected] ➜ 9.0.0	None	`0`	79 kB	metamaskbot
npm/@metamask/[email protected] ➜ 6.1.1	None	`0`	165 kB	metamaskbot
npm/@metamask/[email protected] ➜ 20.0.0	None	`+1`	67.3 kB
npm/@metamask/[email protected] ➜ 9.0.0	None	`0`	0 B

View full report↗︎

socket-security · 2025-02-28T12:40:32Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

metamaskbot · 2025-02-28T12:43:38Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

mikesposito · 2025-02-28T14:12:21Z

@metamaskbot update-policies

metamaskbot · 2025-02-28T14:24:52Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

mikesposito · 2025-03-03T11:24:26Z

@SocketSecurity ignore npm/[email protected]

## Explanation  This PR bumps these packages across the core controllers: - `@metamask/eth-simple-keyring` - `@metamask/eth-hd-keyring` - `@metamask/keyring-internal-api` The package is being updated on Extension by this PR: MetaMask/metamask-extension#30637 ## References  ## Changelog  ### `@metamask/keyring-controller` - **CHANGED**: Bump `@metamask/eth-simple-keyring` from `^8.1.0` to `^9.0.0` ([#5405](#5405)) - **CHANGED**: Bump `@metamask/eth-hd-keyring` from `^10.0.0` to `^11.0.0` ([#5405](#5405)) - **CHANGED**: Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0` ([#5405](#5405)) ### `@metamask/accounts-controller` - **CHANGED**: Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0` ([#5405](#5405)) ### `@metamask/profile-sync-controller` - **CHANGED**: Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0` ([#5405](#5405)) ### `@metamask/assets-controller` - **CHANGED**: Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0` ([#5405](#5405)) ### `@metamask/multichain-transaction-controller` - **CHANGED**: Bump `@metamask/keyring-internal-api` from `^4.0.3` to `^5.0.0` ([#5405](#5405)) ## 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

mikesposito · 2025-03-04T19:56:41Z

@metamaskbot update-policies

mathieuartu

Looking good! Thanks for doing that, was following closely this PR as you know 😛

ccharly

Code LGTM (not manually tested).

metamaskbot · 2025-03-05T17:53:09Z

Builds ready [3aad368]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- content-script: 0
- offscreen: 0

Page Load Metrics (1543 ± 44 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	432	1848	1487	258	124
		domContentLoaded	1416	1786	1520	84	40
		load	1435	1846	1543	91	44
		domInteractive	24	113	34	21	10
		backgroundConnect	10	64	30	18	9
		firstReactRender	14	67	28	21	10
		getState	4	51	13	15	7
		initialActions	0	0	0	0	0
		loadScripts	1022	1377	1115	77	37
		setupStore	7	53	13	13	6
		uiStartup	1612	2084	1741	102	49

Bundle size diffs [🚀 Bundle size reduced!]

background: -1.77 KiB (-0.03%)
ui: 0 Bytes (0.00%)
common: 796 Bytes (0.01%)

## Explanation This PR makes the necessary changes so that `UserStorageController` and `AuthenticationController` consumes the profile sync SDK. That means that there's no longer controller specific logic nor services related to authentication and user storage. Test coverages has also been increased to almost 100% for all things related to authentication and user storage, for controller & SDK. ## References Related to: https://consensyssoftware.atlassian.net/browse/IDENTITY-48 Extension test drive PR: MetaMask/metamask-extension#30681 Note that when bumping the version on the extension and mobile, some changes will be mandatory: - Updating the mock storage key for both identity and notifications E2E tests constants - Updating `sessionData` shapes everywhere - Add a migration to manage `sessionData` shape changes so that it is reset for users still using the previous shape - Bumping `KeyringController` to `^19.2.1` if not done already, and take care of the breaking changes this version adds on extension - This will most likely be fixed with MetaMask/metamask-extension#30637 ## Changelog  ### `@metamask/profile-sync-controller` - **CHANGED**: `UserStorageController` and `AuthenticationController` now use the SDK under the hood. - **CHANGED**(**BREAKING**): `AuthenticationController` state entry `sessionData` has changed shape to fully reflect the `LoginResponse` SDK type. - **CHANGED**(**BREAKING**): `UserStorageController` cannot use the `'AuthenticationController:performSignOut'` action anymore. ### `@metamask/notification-services-controller` - **CHANGED**: Change import for mock access token (only related to tests) ## 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 - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

vivek-consensys · 2025-03-06T08:48:55Z

LGTM!

metamaskbot · 2025-03-07T10:46:27Z

Builds ready [ea84681]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- content-script: 0
- offscreen: 0

Page Load Metrics (1718 ± 56 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1514	2001	1718	119	57
		domContentLoaded	1504	1973	1681	116	56
		load	1516	2001	1718	117	56
		domInteractive	25	95	43	21	10
		backgroundConnect	12	90	44	22	11
		firstReactRender	14	68	31	21	10
		getState	6	63	15	16	8
		initialActions	0	1	0	0	0
		loadScripts	1109	1506	1256	100	48
		setupStore	7	55	14	14	7
		uiStartup	1694	2203	1939	132	63

Bundle size diffs [🚀 Bundle size reduced!]

background: -1.77 KiB (-0.03%)
ui: 0 Bytes (0.00%)
common: 796 Bytes (0.01%)

mikesposito added 2 commits February 28, 2025 13:28

chore: bump @metamask/keyring-controller

6dd9edf

Merge branch 'main' into mikesposito/bump-keyring-controller

b65cc5e

metamaskbot added the team-wallet-framework label Feb 28, 2025

This comment was marked as outdated.

Sign in to view

use preview build

c4a8c9d

mikesposito force-pushed the mikesposito/bump-keyring-controller branch from 4c87f28 to c4a8c9d Compare February 28, 2025 13:34

mikesposito added 2 commits February 28, 2025 14:48

use new option bag from withKeyring

be6cb84

fix: support new addNewKeyring return

bf6646b

Update LavaMoat policies

6f06ffc

mikesposito added 3 commits March 3, 2025 10:20

fix: use the right preview build

e44e7da

fix ledger tests

0f9ae0f

fix mmi-controller unit tests

b890f35

mikesposito mentioned this pull request Mar 3, 2025

chore: bump keyring packages MetaMask/core#5405

Merged

4 tasks

bump @metamask/profile-sync-controller

c4445ea

mikesposito changed the title ~~chore: bump @metamask/keyring-controller~~ chore: bump @metamask/{keyring, profile-sync}-controller Mar 3, 2025

Merge branch 'main' into mikesposito/bump-keyring-controller

227b1b7

mathieuartu mentioned this pull request Mar 4, 2025

refactor: profile sync controllers should consume SDK methods MetaMask/core#5413

Merged

4 tasks

remove package previews

d0e8ea2

This was linked to issues Mar 4, 2025

Update metamask/keyring-controller to version 20.0.0 #30736

Closed

Update metamask/profile-sync-controller to version 9.0.0 #30739

Closed

mikesposito and others added 2 commits March 4, 2025 16:28

Merge branch 'main' into mikesposito/bump-keyring-controller

561fbc6

Merge branch 'main' into mikesposito/bump-keyring-controller

9e24ac2

mikesposito requested review from a team as code owners March 5, 2025 09:47

mathieuartu previously approved these changes Mar 5, 2025

View reviewed changes

ccharly previously approved these changes Mar 5, 2025

View reviewed changes

mikesposito and others added 2 commits March 5, 2025 13:35

Merge branch 'main' into mikesposito/bump-keyring-controller

f639d3a

use @metamask/eth-trezor-keyring@^6.1.1

70e7886

mikesposito dismissed stale reviews from ccharly and mathieuartu via 70e7886 March 5, 2025 13:57

mikesposito added 3 commits March 5, 2025 17:54

fix: :withKeyring action for snaps

2d7df2b

Merge branch 'main' into mikesposito/bump-keyring-controller

ff11f90

chore: remove findKeyringById

3aad368

mathieuartu approved these changes Mar 5, 2025

View reviewed changes

vivek-consensys added the QA Passed label Mar 6, 2025

matthewwalsh0 approved these changes Mar 6, 2025

View reviewed changes

mikesposito added this pull request to the merge queue Mar 6, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 6, 2025

mikesposito added this pull request to the merge queue Mar 6, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 6, 2025

Merge branch 'main' into mikesposito/bump-keyring-controller

ea84681

mikesposito enabled auto-merge March 7, 2025 10:08

mikesposito added this pull request to the merge queue Mar 7, 2025

Merged via the queue into main with commit 74d4186 Mar 7, 2025
74 checks passed

mikesposito deleted the mikesposito/bump-keyring-controller branch March 7, 2025 11:15

github-actions bot locked and limited conversation to collaborators Mar 7, 2025

metamaskbot added the release-12.15.0 Issue or pull request that will be included in release 12.15.0 label Mar 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: bump `@metamask/{keyring, profile-sync}-controller` #30637

chore: bump `@metamask/{keyring, profile-sync}-controller` #30637

mikesposito commented Feb 28, 2025 •

edited

Loading

This comment was marked as outdated.

socket-security bot commented Feb 28, 2025 •

edited

Loading

socket-security bot commented Feb 28, 2025 •

edited

Loading

metamaskbot commented Feb 28, 2025

mikesposito commented Feb 28, 2025

metamaskbot commented Feb 28, 2025

mikesposito commented Mar 3, 2025

mikesposito commented Mar 4, 2025

mathieuartu left a comment

ccharly left a comment

metamaskbot commented Mar 5, 2025

vivek-consensys commented Mar 6, 2025

metamaskbot commented Mar 7, 2025

chore: bump @metamask/{keyring, profile-sync}-controller #30637

chore: bump @metamask/{keyring, profile-sync}-controller #30637

Conversation

mikesposito commented Feb 28, 2025 • edited Loading

Description

@metamask/keyring-controller

@metamask/profile-sync-controller

@metamask/eth-ledger-bridge-keyring

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

This comment was marked as outdated.

socket-security bot commented Feb 28, 2025 • edited Loading

socket-security bot commented Feb 28, 2025 • edited Loading

metamaskbot commented Feb 28, 2025

mikesposito commented Feb 28, 2025

metamaskbot commented Feb 28, 2025

mikesposito commented Mar 3, 2025

mikesposito commented Mar 4, 2025

mathieuartu left a comment

Choose a reason for hiding this comment

ccharly left a comment

Choose a reason for hiding this comment

metamaskbot commented Mar 5, 2025

vivek-consensys commented Mar 6, 2025

metamaskbot commented Mar 7, 2025

chore: bump `@metamask/{keyring, profile-sync}-controller` #30637

chore: bump `@metamask/{keyring, profile-sync}-controller` #30637

mikesposito commented Feb 28, 2025 •

edited

Loading

`@metamask/keyring-controller`

`@metamask/profile-sync-controller`

`@metamask/eth-ledger-bridge-keyring`

socket-security bot commented Feb 28, 2025 •

edited

Loading

socket-security bot commented Feb 28, 2025 •

edited

Loading