Skip to content

fix: discard duplicate accounts on unlock #5775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
May 14, 2025

Conversation

mikesposito
Copy link
Member

@mikesposito mikesposito commented May 7, 2025

Dependent on:

Explanation

It is no longer possible to persist duplicates in the vault, though users that already have duplicates will see them in the accounts list, and won't be able to do any action with their vault. These changes aim to discard duplicates, moving the keyring including a duplicate account to the unsupported array.

Can be tested on extension with MetaMask/metamask-extension#32621

References

Changelog

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 communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@mikesposito
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented May 7, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "28.0.0-preview-956e6bf8",
  "@metamask-previews/address-book-controller": "6.0.3-preview-956e6bf8",
  "@metamask-previews/announcement-controller": "7.0.3-preview-956e6bf8",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-956e6bf8",
  "@metamask-previews/approval-controller": "7.1.3-preview-956e6bf8",
  "@metamask-previews/assets-controllers": "61.0.0-preview-956e6bf8",
  "@metamask-previews/base-controller": "8.0.1-preview-956e6bf8",
  "@metamask-previews/bridge-controller": "21.0.0-preview-956e6bf8",
  "@metamask-previews/bridge-status-controller": "18.0.0-preview-956e6bf8",
  "@metamask-previews/build-utils": "3.0.3-preview-956e6bf8",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-956e6bf8",
  "@metamask-previews/composable-controller": "11.0.0-preview-956e6bf8",
  "@metamask-previews/controller-utils": "11.8.0-preview-956e6bf8",
  "@metamask-previews/delegation-controller": "0.2.0-preview-956e6bf8",
  "@metamask-previews/earn-controller": "0.13.0-preview-956e6bf8",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-956e6bf8",
  "@metamask-previews/ens-controller": "16.0.0-preview-956e6bf8",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-956e6bf8",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-956e6bf8",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-956e6bf8",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-956e6bf8",
  "@metamask-previews/keyring-controller": "21.0.6-preview-956e6bf8",
  "@metamask-previews/logging-controller": "6.0.4-preview-956e6bf8",
  "@metamask-previews/message-manager": "12.0.1-preview-956e6bf8",
  "@metamask-previews/multichain": "4.0.0-preview-956e6bf8",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-956e6bf8",
  "@metamask-previews/multichain-network-controller": "0.6.0-preview-956e6bf8",
  "@metamask-previews/multichain-transactions-controller": "0.10.0-preview-956e6bf8",
  "@metamask-previews/name-controller": "8.0.3-preview-956e6bf8",
  "@metamask-previews/network-controller": "23.4.0-preview-956e6bf8",
  "@metamask-previews/notification-services-controller": "7.0.0-preview-956e6bf8",
  "@metamask-previews/permission-controller": "11.0.6-preview-956e6bf8",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-956e6bf8",
  "@metamask-previews/phishing-controller": "12.5.0-preview-956e6bf8",
  "@metamask-previews/polling-controller": "13.0.0-preview-956e6bf8",
  "@metamask-previews/preferences-controller": "17.0.0-preview-956e6bf8",
  "@metamask-previews/profile-sync-controller": "13.0.0-preview-956e6bf8",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-956e6bf8",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-956e6bf8",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-956e6bf8",
  "@metamask-previews/sample-controllers": "0.1.0-preview-956e6bf8",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-956e6bf8",
  "@metamask-previews/signature-controller": "28.0.0-preview-956e6bf8",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-956e6bf8",
  "@metamask-previews/transaction-controller": "55.0.0-preview-956e6bf8",
  "@metamask-previews/user-operation-controller": "34.0.0-preview-956e6bf8"
}

@mikesposito mikesposito force-pushed the mikesposito/fix/discard-duplicates branch from 956e6bf to 1341545 Compare May 8, 2025 18:31
@mikesposito
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented May 8, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "28.0.0-preview-1341545b",
  "@metamask-previews/address-book-controller": "6.0.3-preview-1341545b",
  "@metamask-previews/announcement-controller": "7.0.3-preview-1341545b",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-1341545b",
  "@metamask-previews/approval-controller": "7.1.3-preview-1341545b",
  "@metamask-previews/assets-controllers": "61.0.0-preview-1341545b",
  "@metamask-previews/base-controller": "8.0.1-preview-1341545b",
  "@metamask-previews/bridge-controller": "21.0.0-preview-1341545b",
  "@metamask-previews/bridge-status-controller": "18.0.0-preview-1341545b",
  "@metamask-previews/build-utils": "3.0.3-preview-1341545b",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-1341545b",
  "@metamask-previews/composable-controller": "11.0.0-preview-1341545b",
  "@metamask-previews/controller-utils": "11.8.0-preview-1341545b",
  "@metamask-previews/delegation-controller": "0.2.0-preview-1341545b",
  "@metamask-previews/earn-controller": "0.13.0-preview-1341545b",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-1341545b",
  "@metamask-previews/ens-controller": "16.0.0-preview-1341545b",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-1341545b",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-1341545b",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-1341545b",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-1341545b",
  "@metamask-previews/keyring-controller": "21.0.6-preview-1341545b",
  "@metamask-previews/logging-controller": "6.0.4-preview-1341545b",
  "@metamask-previews/message-manager": "12.0.1-preview-1341545b",
  "@metamask-previews/multichain": "4.0.0-preview-1341545b",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-1341545b",
  "@metamask-previews/multichain-network-controller": "0.6.0-preview-1341545b",
  "@metamask-previews/multichain-transactions-controller": "0.10.0-preview-1341545b",
  "@metamask-previews/name-controller": "8.0.3-preview-1341545b",
  "@metamask-previews/network-controller": "23.4.0-preview-1341545b",
  "@metamask-previews/notification-services-controller": "7.0.0-preview-1341545b",
  "@metamask-previews/permission-controller": "11.0.6-preview-1341545b",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-1341545b",
  "@metamask-previews/phishing-controller": "12.5.0-preview-1341545b",
  "@metamask-previews/polling-controller": "13.0.0-preview-1341545b",
  "@metamask-previews/preferences-controller": "17.0.0-preview-1341545b",
  "@metamask-previews/profile-sync-controller": "13.0.0-preview-1341545b",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-1341545b",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-1341545b",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-1341545b",
  "@metamask-previews/sample-controllers": "0.1.0-preview-1341545b",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-1341545b",
  "@metamask-previews/signature-controller": "28.0.0-preview-1341545b",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-1341545b",
  "@metamask-previews/transaction-controller": "55.0.0-preview-1341545b",
  "@metamask-previews/user-operation-controller": "34.0.0-preview-1341545b"
}

Base automatically changed from mikesposito/fix/unsupported-keyrings to main May 13, 2025 09:09
@mikesposito mikesposito force-pushed the mikesposito/fix/discard-duplicates branch from 524f070 to b863dd5 Compare May 13, 2025 09:49
@mikesposito mikesposito marked this pull request as ready for review May 13, 2025 09:55
@mikesposito mikesposito requested review from a team as code owners May 13, 2025 09:55
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
@mikesposito
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "28.0.0-preview-aa280426",
  "@metamask-previews/address-book-controller": "6.0.3-preview-aa280426",
  "@metamask-previews/announcement-controller": "7.0.3-preview-aa280426",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-aa280426",
  "@metamask-previews/approval-controller": "7.1.3-preview-aa280426",
  "@metamask-previews/assets-controllers": "62.0.0-preview-aa280426",
  "@metamask-previews/base-controller": "8.0.1-preview-aa280426",
  "@metamask-previews/bridge-controller": "22.0.0-preview-aa280426",
  "@metamask-previews/bridge-status-controller": "19.0.0-preview-aa280426",
  "@metamask-previews/build-utils": "3.0.3-preview-aa280426",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-aa280426",
  "@metamask-previews/composable-controller": "11.0.0-preview-aa280426",
  "@metamask-previews/controller-utils": "11.8.0-preview-aa280426",
  "@metamask-previews/delegation-controller": "0.2.0-preview-aa280426",
  "@metamask-previews/earn-controller": "0.13.0-preview-aa280426",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-aa280426",
  "@metamask-previews/ens-controller": "16.0.0-preview-aa280426",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-aa280426",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-aa280426",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-aa280426",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-aa280426",
  "@metamask-previews/keyring-controller": "21.0.6-preview-aa280426",
  "@metamask-previews/logging-controller": "6.0.4-preview-aa280426",
  "@metamask-previews/message-manager": "12.0.1-preview-aa280426",
  "@metamask-previews/multichain": "4.0.0-preview-aa280426",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-aa280426",
  "@metamask-previews/multichain-network-controller": "0.6.0-preview-aa280426",
  "@metamask-previews/multichain-transactions-controller": "0.10.0-preview-aa280426",
  "@metamask-previews/name-controller": "8.0.3-preview-aa280426",
  "@metamask-previews/network-controller": "23.4.0-preview-aa280426",
  "@metamask-previews/notification-services-controller": "7.0.0-preview-aa280426",
  "@metamask-previews/permission-controller": "11.0.6-preview-aa280426",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-aa280426",
  "@metamask-previews/phishing-controller": "12.5.0-preview-aa280426",
  "@metamask-previews/polling-controller": "13.0.0-preview-aa280426",
  "@metamask-previews/preferences-controller": "17.0.0-preview-aa280426",
  "@metamask-previews/profile-sync-controller": "13.0.0-preview-aa280426",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-aa280426",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-aa280426",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-aa280426",
  "@metamask-previews/sample-controllers": "0.1.0-preview-aa280426",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-aa280426",
  "@metamask-previews/signature-controller": "28.0.0-preview-aa280426",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-aa280426",
  "@metamask-previews/transaction-controller": "55.0.1-preview-aa280426",
  "@metamask-previews/user-operation-controller": "34.0.0-preview-aa280426"
}

Copy link
Contributor

@ccharly ccharly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. As discussed internally, this could cause some issues with the Snap keyring if this one gets "skipped as unsupported".

But it shouldn't be possible to add an account with a duplicated address anyway, we are checking this on the Snap keyring itself:

await controller.submitPassword(password);

expect(controller.state.keyrings).toHaveLength(1); // Second keyring will be skipped as "unsupported".
expect(unlockListener).toHaveBeenCalledTimes(1);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nit: I saw we were doing this in another test, but this might redundant:

Suggested change
expect(unlockListener).toHaveBeenCalledTimes(1);
expect(controller.state.isUnlocked).toBe(true);
expect(unlockListener).toHaveBeenCalledTimes(1);

Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@cryptodev-2s cryptodev-2s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mikesposito mikesposito enabled auto-merge (squash) May 14, 2025 08:48
@mikesposito mikesposito merged commit b1c2e74 into main May 14, 2025
202 checks passed
@mikesposito mikesposito deleted the mikesposito/fix/discard-duplicates branch May 14, 2025 09:00
github-merge-queue bot pushed a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
DDDDDanica pushed a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

Fixes: #32935

1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

<!-- [screenshots/recordings] -->

<!-- [screenshots/recordings] -->

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
runway-github bot added a commit to MetaMask/metamask-extension that referenced this pull request May 15, 2025
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^22.0.0`:

```markdown
## [22.0.0]

### Changed

- **BREAKING** `keyringsMetadata` has been removed from the controller state ([#5725](MetaMask/core#5725))
  - The metadata is now stored in each keyring object in the `state.keyrings` array.
  - When updating to this version, we recommend removing the `keyringsMetadata` state and all state referencing a keyring ID with a migration. New metadata will be generated for each keyring automatically after the update.
### Fixed
- Keyrings with duplicate accounts are skipped as unsupported on unlock ([#5775](MetaMask/core#5775))

## [21.0.6]

### Changed

- Prevent emitting `:stateChange` from `withKeyring` unnecessarily ([#5732](MetaMask/core#5732))

```

and `@metamask/accounts-controller` to `^29.0.0`:

```markdown
## [29.0.0]

### Changed

- **BREAKING:** bump `@metamask/keyring-controller` peer dependency to `^22.0.0` ([#5802](MetaMask/core#5802))

## [28.0.0]

### Added
- Add new `setAccountNameAndSelectAccount` action ([#5714](MetaMask/core#5714))
- Add `entropySource` and `derivationPath` to EVM HD account options ([#5618](MetaMask/core#5618))
### Changed
- **BREAKING:** Bump `@metamask/snaps-controllers` peer dependency from `^9.19.0` to `^11.0.0` ([#5639](MetaMask/core#5639))
- **BREAKING:** Bump `@metamask/providers` peer dependency from `^18.1.0` to `^21.0.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/base-controller` from `^8.0.0` to `^8.0.1` ([#5722](MetaMask/core#5722))
- Bump `@metamask/snaps-sdk` from `^6.17.1` to `^6.22.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/snaps-utils` from `^8.10.0` to `^9.2.0` ([#5639](MetaMask/core#5639))
- Bump `@metamask/eth-snap-keyring` from `^12.0.0` to `^12.1.1` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))
### Fixed
- Do not fire events during `update` blocks ([#5555](MetaMask/core#5555))
- Prevent unnecessary state updates when updating `InternalAccount.metadata.snap` ([#5735](MetaMask/core#5735))
```

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/32621?quickstart=1)

## **Related issues**

Fixes: #32935

## **Manual testing steps**

### 1. Add duplicate to the wallet state
1.1. Switch to the `v11.7.3` branch, build locally, and install the
extension from `chrome://extensions`
1.2. Onboard with an SRP of which we know the second account (`child
guilt hollow arrive average popular nasty soon summer like scheme diary
pill country rapid`)
1.3. Import an account that is part of the mnemonic (
`0x80842b7e3cfb1118e86a427cdec418e3b4179ef5bbbfd71c02a76349831c8a8b`
which is the account at index 2 of the above SRP)
1.4. Add a new account on the main HD
1.5. Switch to `Version-v12.17.1` branch, and refresh the extension in
`chrome://extensions`
1.6. Unlock the wallet, you should see duplicates in your accounts list
and you won't be able to add new accounts

### 2. Test the fix
2.1. Switch to this branch, build locally, and refresh the extension in
`chrome://extensions`
2.2 Unlock the wallet, you shouldn't see duplicate accounts anymore, and
you should be able to add new accounts

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/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-extension/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.

---------

Co-authored-by: Mark Stacey <mark.stacey@consensys.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants