Skip to content

perf: Add accountIdByAddress to AccountsController state#7893

Merged
hmalik88 merged 58 commits intomainfrom
hm/mul-1449
Mar 5, 2026
Merged

perf: Add accountIdByAddress to AccountsController state#7893
hmalik88 merged 58 commits intomainfrom
hm/mul-1449

Conversation

@hmalik88
Copy link
Contributor

@hmalik88 hmalik88 commented Feb 10, 2026

Explanation

Currently when doing an account lookup by address we're doing an O(n) operation in the clients, this has been improved to O(1) by adding an address -> account id mapping in state. The getAccountByAddress function now also takes advantage of this new piece of state to improve its lookup time.

References

N/A

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
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Medium Risk
Medium risk because it changes the public controller state shape (consumer migrations required) and alters address-lookup behavior with new caching/fallback logic that could surface mismatches if callers use non-normalized addresses.

Overview
Performance improvement: AccountsController state now includes a derived accountIdByAddress (address → account id) map, marked non-persisted and excluded from state logs.

getAccountByAddress is rewritten to use this map (with a lowercase fallback + debug logging on cache misses), and the map is constructed/maintained across constructor initialization, updateAccounts, loadBackup, and keyring add/remove patches.

Tests and typings are updated accordingly (including utils.constructAccountIdByAddress tests and downstream state-shape updates such as ProfileMetricsController tests).

Written by Cursor Bugbot for commit 903ebe3. This will update automatically on new commits. Configure here.

@hmalik88 hmalik88 requested a review from a team as a code owner February 10, 2026 16:13
@hmalik88 hmalik88 requested a review from a team as a code owner February 10, 2026 16:14
@hmalik88 hmalik88 changed the title perf: Add accountIdByAddress to AccountsController state perf!: Add accountIdByAddress to AccountsController state Feb 10, 2026
@hmalik88 hmalik88 requested a review from a team as a code owner February 10, 2026 19:37
@hmalik88
Copy link
Contributor Author

hmalik88 commented Mar 3, 2026

@metamaskbot publish-previews

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026

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

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "4.1.1-preview-0eb28104d",
  "@metamask-previews/accounts-controller": "36.0.1-preview-0eb28104d",
  "@metamask-previews/address-book-controller": "7.0.1-preview-0eb28104d",
  "@metamask-previews/ai-controllers": "0.1.0-preview-0eb28104d",
  "@metamask-previews/analytics-controller": "1.0.0-preview-0eb28104d",
  "@metamask-previews/analytics-data-regulation-controller": "0.0.0-preview-0eb28104d",
  "@metamask-previews/announcement-controller": "8.0.0-preview-0eb28104d",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-0eb28104d",
  "@metamask-previews/approval-controller": "8.0.0-preview-0eb28104d",
  "@metamask-previews/assets-controller": "2.2.0-preview-0eb28104d",
  "@metamask-previews/assets-controllers": "100.0.3-preview-0eb28104d",
  "@metamask-previews/base-controller": "9.0.0-preview-0eb28104d",
  "@metamask-previews/base-data-service": "0.0.0-preview-0eb28104d",
  "@metamask-previews/bridge-controller": "67.4.0-preview-0eb28104d",
  "@metamask-previews/bridge-status-controller": "67.0.1-preview-0eb28104d",
  "@metamask-previews/build-utils": "3.0.4-preview-0eb28104d",
  "@metamask-previews/chain-agnostic-permission": "1.4.0-preview-0eb28104d",
  "@metamask-previews/claims-controller": "0.4.2-preview-0eb28104d",
  "@metamask-previews/client-controller": "1.0.0-preview-0eb28104d",
  "@metamask-previews/compliance-controller": "1.0.1-preview-0eb28104d",
  "@metamask-previews/composable-controller": "12.0.0-preview-0eb28104d",
  "@metamask-previews/config-registry-controller": "0.0.0-preview-0eb28104d",
  "@metamask-previews/connectivity-controller": "0.1.0-preview-0eb28104d",
  "@metamask-previews/controller-utils": "11.19.0-preview-0eb28104d",
  "@metamask-previews/core-backend": "6.0.0-preview-0eb28104d",
  "@metamask-previews/delegation-controller": "2.0.1-preview-0eb28104d",
  "@metamask-previews/earn-controller": "11.1.1-preview-0eb28104d",
  "@metamask-previews/eip-5792-middleware": "3.0.0-preview-0eb28104d",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-0eb28104d",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-0eb28104d",
  "@metamask-previews/ens-controller": "19.0.3-preview-0eb28104d",
  "@metamask-previews/error-reporting-service": "3.0.1-preview-0eb28104d",
  "@metamask-previews/eth-block-tracker": "15.0.1-preview-0eb28104d",
  "@metamask-previews/eth-json-rpc-middleware": "23.1.0-preview-0eb28104d",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-0eb28104d",
  "@metamask-previews/foundryup": "1.0.1-preview-0eb28104d",
  "@metamask-previews/gas-fee-controller": "26.0.3-preview-0eb28104d",
  "@metamask-previews/gator-permissions-controller": "2.0.0-preview-0eb28104d",
  "@metamask-previews/geolocation-controller": "0.0.0-preview-0eb28104d",
  "@metamask-previews/json-rpc-engine": "10.2.3-preview-0eb28104d",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-0eb28104d",
  "@metamask-previews/keyring-controller": "25.1.0-preview-0eb28104d",
  "@metamask-previews/logging-controller": "7.0.1-preview-0eb28104d",
  "@metamask-previews/message-manager": "14.1.0-preview-0eb28104d",
  "@metamask-previews/messenger": "0.3.0-preview-0eb28104d",
  "@metamask-previews/multichain-account-service": "7.0.0-preview-0eb28104d",
  "@metamask-previews/multichain-api-middleware": "1.2.7-preview-0eb28104d",
  "@metamask-previews/multichain-network-controller": "3.0.4-preview-0eb28104d",
  "@metamask-previews/multichain-transactions-controller": "7.0.1-preview-0eb28104d",
  "@metamask-previews/name-controller": "9.0.0-preview-0eb28104d",
  "@metamask-previews/network-controller": "30.0.0-preview-0eb28104d",
  "@metamask-previews/network-enablement-controller": "4.1.2-preview-0eb28104d",
  "@metamask-previews/notification-services-controller": "22.0.0-preview-0eb28104d",
  "@metamask-previews/permission-controller": "12.2.0-preview-0eb28104d",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-0eb28104d",
  "@metamask-previews/perps-controller": "0.0.0-preview-0eb28104d",
  "@metamask-previews/phishing-controller": "16.3.0-preview-0eb28104d",
  "@metamask-previews/polling-controller": "16.0.3-preview-0eb28104d",
  "@metamask-previews/preferences-controller": "22.1.0-preview-0eb28104d",
  "@metamask-previews/profile-metrics-controller": "3.0.1-preview-0eb28104d",
  "@metamask-previews/profile-sync-controller": "27.1.0-preview-0eb28104d",
  "@metamask-previews/ramps-controller": "10.0.0-preview-0eb28104d",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-0eb28104d",
  "@metamask-previews/remote-feature-flag-controller": "4.1.0-preview-0eb28104d",
  "@metamask-previews/sample-controllers": "4.0.3-preview-0eb28104d",
  "@metamask-previews/seedless-onboarding-controller": "8.1.0-preview-0eb28104d",
  "@metamask-previews/selected-network-controller": "26.0.3-preview-0eb28104d",
  "@metamask-previews/shield-controller": "5.0.1-preview-0eb28104d",
  "@metamask-previews/signature-controller": "39.0.4-preview-0eb28104d",
  "@metamask-previews/storage-service": "1.0.0-preview-0eb28104d",
  "@metamask-previews/subscription-controller": "6.0.0-preview-0eb28104d",
  "@metamask-previews/transaction-controller": "62.19.0-preview-0eb28104d",
  "@metamask-previews/transaction-pay-controller": "16.1.2-preview-0eb28104d",
  "@metamask-previews/user-operation-controller": "41.0.3-preview-0eb28104d"
}

@hmalik88
Copy link
Contributor Author

hmalik88 commented Mar 4, 2026

@metamaskbot publish-previews

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

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

Expand for full list of packages and versions.
{
  "@metamask-previews/account-tree-controller": "4.1.1-preview-968b2b4f4",
  "@metamask-previews/accounts-controller": "36.0.1-preview-968b2b4f4",
  "@metamask-previews/address-book-controller": "7.0.1-preview-968b2b4f4",
  "@metamask-previews/ai-controllers": "0.1.0-preview-968b2b4f4",
  "@metamask-previews/analytics-controller": "1.0.0-preview-968b2b4f4",
  "@metamask-previews/analytics-data-regulation-controller": "0.0.0-preview-968b2b4f4",
  "@metamask-previews/announcement-controller": "8.0.0-preview-968b2b4f4",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-968b2b4f4",
  "@metamask-previews/approval-controller": "8.0.0-preview-968b2b4f4",
  "@metamask-previews/assets-controller": "2.2.0-preview-968b2b4f4",
  "@metamask-previews/assets-controllers": "100.0.3-preview-968b2b4f4",
  "@metamask-previews/base-controller": "9.0.0-preview-968b2b4f4",
  "@metamask-previews/base-data-service": "0.0.0-preview-968b2b4f4",
  "@metamask-previews/bridge-controller": "68.0.0-preview-968b2b4f4",
  "@metamask-previews/bridge-status-controller": "68.0.0-preview-968b2b4f4",
  "@metamask-previews/build-utils": "3.0.4-preview-968b2b4f4",
  "@metamask-previews/chain-agnostic-permission": "1.4.0-preview-968b2b4f4",
  "@metamask-previews/claims-controller": "0.4.2-preview-968b2b4f4",
  "@metamask-previews/client-controller": "1.0.0-preview-968b2b4f4",
  "@metamask-previews/compliance-controller": "1.0.1-preview-968b2b4f4",
  "@metamask-previews/composable-controller": "12.0.0-preview-968b2b4f4",
  "@metamask-previews/config-registry-controller": "0.0.0-preview-968b2b4f4",
  "@metamask-previews/connectivity-controller": "0.1.0-preview-968b2b4f4",
  "@metamask-previews/controller-utils": "11.19.0-preview-968b2b4f4",
  "@metamask-previews/core-backend": "6.0.0-preview-968b2b4f4",
  "@metamask-previews/delegation-controller": "2.0.1-preview-968b2b4f4",
  "@metamask-previews/earn-controller": "11.1.1-preview-968b2b4f4",
  "@metamask-previews/eip-5792-middleware": "3.0.0-preview-968b2b4f4",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-968b2b4f4",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-968b2b4f4",
  "@metamask-previews/ens-controller": "19.0.3-preview-968b2b4f4",
  "@metamask-previews/error-reporting-service": "3.0.1-preview-968b2b4f4",
  "@metamask-previews/eth-block-tracker": "15.0.1-preview-968b2b4f4",
  "@metamask-previews/eth-json-rpc-middleware": "23.1.0-preview-968b2b4f4",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-968b2b4f4",
  "@metamask-previews/foundryup": "1.0.1-preview-968b2b4f4",
  "@metamask-previews/gas-fee-controller": "26.0.3-preview-968b2b4f4",
  "@metamask-previews/gator-permissions-controller": "2.0.0-preview-968b2b4f4",
  "@metamask-previews/geolocation-controller": "0.1.0-preview-968b2b4f4",
  "@metamask-previews/json-rpc-engine": "10.2.3-preview-968b2b4f4",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-968b2b4f4",
  "@metamask-previews/keyring-controller": "25.1.0-preview-968b2b4f4",
  "@metamask-previews/logging-controller": "7.0.1-preview-968b2b4f4",
  "@metamask-previews/message-manager": "14.1.0-preview-968b2b4f4",
  "@metamask-previews/messenger": "0.3.0-preview-968b2b4f4",
  "@metamask-previews/multichain-account-service": "7.0.0-preview-968b2b4f4",
  "@metamask-previews/multichain-api-middleware": "1.2.7-preview-968b2b4f4",
  "@metamask-previews/multichain-network-controller": "3.0.4-preview-968b2b4f4",
  "@metamask-previews/multichain-transactions-controller": "7.0.1-preview-968b2b4f4",
  "@metamask-previews/name-controller": "9.0.0-preview-968b2b4f4",
  "@metamask-previews/network-controller": "30.0.0-preview-968b2b4f4",
  "@metamask-previews/network-enablement-controller": "4.1.2-preview-968b2b4f4",
  "@metamask-previews/notification-services-controller": "22.0.0-preview-968b2b4f4",
  "@metamask-previews/permission-controller": "12.2.0-preview-968b2b4f4",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-968b2b4f4",
  "@metamask-previews/perps-controller": "1.0.0-preview-968b2b4f4",
  "@metamask-previews/phishing-controller": "16.3.0-preview-968b2b4f4",
  "@metamask-previews/polling-controller": "16.0.3-preview-968b2b4f4",
  "@metamask-previews/preferences-controller": "22.1.0-preview-968b2b4f4",
  "@metamask-previews/profile-metrics-controller": "3.0.1-preview-968b2b4f4",
  "@metamask-previews/profile-sync-controller": "27.1.0-preview-968b2b4f4",
  "@metamask-previews/ramps-controller": "10.1.0-preview-968b2b4f4",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-968b2b4f4",
  "@metamask-previews/remote-feature-flag-controller": "4.1.0-preview-968b2b4f4",
  "@metamask-previews/sample-controllers": "4.0.3-preview-968b2b4f4",
  "@metamask-previews/seedless-onboarding-controller": "8.1.0-preview-968b2b4f4",
  "@metamask-previews/selected-network-controller": "26.0.3-preview-968b2b4f4",
  "@metamask-previews/shield-controller": "5.0.1-preview-968b2b4f4",
  "@metamask-previews/signature-controller": "39.0.4-preview-968b2b4f4",
  "@metamask-previews/storage-service": "1.0.0-preview-968b2b4f4",
  "@metamask-previews/subscription-controller": "6.0.0-preview-968b2b4f4",
  "@metamask-previews/transaction-controller": "62.19.0-preview-968b2b4f4",
  "@metamask-previews/transaction-pay-controller": "16.2.0-preview-968b2b4f4",
  "@metamask-previews/user-operation-controller": "41.0.3-preview-968b2b4f4"
}

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 💪

Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

LGTM.

@hmalik88 hmalik88 added this pull request to the merge queue Mar 5, 2026
Merged via the queue into main with commit 416032d Mar 5, 2026
322 checks passed
@hmalik88 hmalik88 deleted the hm/mul-1449 branch March 5, 2026 16:04
cursor bot pushed a commit that referenced this pull request Mar 5, 2026
## Explanation

Currently when doing an account lookup by address we're doing an O(n)
operation in the clients, this has been improved to O(1) by adding an
address -> account id mapping in state. The `getAccountByAddress`
function now also takes advantage of this new piece of state to improve
its lookup time.

## References

N/A

## 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 communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md)
- [x] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Medium risk because it changes the public controller state shape
(consumer migrations required) and alters address-lookup behavior with
new caching/fallback logic that could surface mismatches if callers use
non-normalized addresses.
> 
> **Overview**
> **Performance improvement:** `AccountsController` state now includes a
derived `accountIdByAddress` (address → account id) map, marked
*non-persisted* and excluded from state logs.
> 
> `getAccountByAddress` is rewritten to use this map (with a lowercase
fallback + debug logging on cache misses), and the map is
constructed/maintained across constructor initialization,
`updateAccounts`, `loadBackup`, and keyring add/remove patches.
> 
> Tests and typings are updated accordingly (including
`utils.constructAccountIdByAddress` tests and downstream state-shape
updates such as `ProfileMetricsController` tests).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
903ebe3. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants