Skip to content

Conversation

mathieuartu
Copy link
Contributor

@mathieuartu mathieuartu commented Aug 20, 2025

Explanation

This PR introduces comprehensive backup and synchronization capabilities to AccountTreeController, adding account tree data persistence and cross-device synchronization through user storage.

It adds one new public method to AccountTreeController, syncWithUserStorage, that is intended to replace every current occurence of UserStorageController:syncInternalAccountsWithUserStorage in the clients.

Legacy account syncing is still performed as a migration to multichain account syncing step, and is encompassed in this new syncWithUserStorage public method.

The implementation features a new BackupAndSyncService with atomic sync queues, bidirectional metadata synchronization, and rollback mechanisms for failed operations.
The service automatically triggers sync operations when users add and rename wallets/groups, change visibility states, or perform other metadata modifications. Analytics tracking and performance tracing provide observability into sync operations, while debug logging assists with troubleshooting sync issues.

It is worth noting that this PR also removes all account syncing code from UserStorageController.

References

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

@mathieuartu
Copy link
Contributor Author

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Sep 9, 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/account-tree-controller": "0.13.1-preview-5ca78b09",
  "@metamask-previews/accounts-controller": "33.0.0-preview-5ca78b09",
  "@metamask-previews/address-book-controller": "6.1.1-preview-5ca78b09",
  "@metamask-previews/announcement-controller": "7.0.3-preview-5ca78b09",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-5ca78b09",
  "@metamask-previews/approval-controller": "7.1.3-preview-5ca78b09",
  "@metamask-previews/assets-controllers": "74.3.3-preview-5ca78b09",
  "@metamask-previews/base-controller": "8.3.0-preview-5ca78b09",
  "@metamask-previews/bridge-controller": "42.0.0-preview-5ca78b09",
  "@metamask-previews/bridge-status-controller": "42.0.0-preview-5ca78b09",
  "@metamask-previews/build-utils": "3.0.3-preview-5ca78b09",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-5ca78b09",
  "@metamask-previews/composable-controller": "11.0.0-preview-5ca78b09",
  "@metamask-previews/controller-utils": "11.12.0-preview-5ca78b09",
  "@metamask-previews/delegation-controller": "0.7.0-preview-5ca78b09",
  "@metamask-previews/earn-controller": "7.0.0-preview-5ca78b09",
  "@metamask-previews/eip-5792-middleware": "1.0.0-preview-5ca78b09",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-5ca78b09",
  "@metamask-previews/ens-controller": "17.0.1-preview-5ca78b09",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-5ca78b09",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-5ca78b09",
  "@metamask-previews/foundryup": "1.0.1-preview-5ca78b09",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-5ca78b09",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-5ca78b09",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-5ca78b09",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-5ca78b09",
  "@metamask-previews/keyring-controller": "23.0.0-preview-5ca78b09",
  "@metamask-previews/logging-controller": "6.0.4-preview-5ca78b09",
  "@metamask-previews/message-manager": "12.0.2-preview-5ca78b09",
  "@metamask-previews/messenger": "0.2.0-preview-5ca78b09",
  "@metamask-previews/multichain-account-service": "0.7.0-preview-5ca78b09",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-5ca78b09",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-5ca78b09",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-5ca78b09",
  "@metamask-previews/name-controller": "8.0.3-preview-5ca78b09",
  "@metamask-previews/network-controller": "24.1.0-preview-5ca78b09",
  "@metamask-previews/network-enablement-controller": "0.4.0-preview-5ca78b09",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-5ca78b09",
  "@metamask-previews/permission-controller": "11.0.6-preview-5ca78b09",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-5ca78b09",
  "@metamask-previews/phishing-controller": "13.1.0-preview-5ca78b09",
  "@metamask-previews/polling-controller": "14.0.0-preview-5ca78b09",
  "@metamask-previews/preferences-controller": "19.0.0-preview-5ca78b09",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-5ca78b09",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-5ca78b09",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-5ca78b09",
  "@metamask-previews/sample-controllers": "1.0.0-preview-5ca78b09",
  "@metamask-previews/seedless-onboarding-controller": "4.0.0-preview-5ca78b09",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-5ca78b09",
  "@metamask-previews/shield-controller": "0.1.2-preview-5ca78b09",
  "@metamask-previews/signature-controller": "33.0.0-preview-5ca78b09",
  "@metamask-previews/subscription-controller": "0.0.0-preview-5ca78b09",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-5ca78b09",
  "@metamask-previews/transaction-controller": "60.2.0-preview-5ca78b09",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-5ca78b09"
}

@mathieuartu
Copy link
Contributor 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/account-tree-controller": "0.13.1-preview-ea6406b3",
  "@metamask-previews/accounts-controller": "33.0.0-preview-ea6406b3",
  "@metamask-previews/address-book-controller": "6.1.1-preview-ea6406b3",
  "@metamask-previews/announcement-controller": "7.0.3-preview-ea6406b3",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-ea6406b3",
  "@metamask-previews/approval-controller": "7.1.3-preview-ea6406b3",
  "@metamask-previews/assets-controllers": "74.3.3-preview-ea6406b3",
  "@metamask-previews/base-controller": "8.3.0-preview-ea6406b3",
  "@metamask-previews/bridge-controller": "42.0.0-preview-ea6406b3",
  "@metamask-previews/bridge-status-controller": "42.0.0-preview-ea6406b3",
  "@metamask-previews/build-utils": "3.0.3-preview-ea6406b3",
  "@metamask-previews/chain-agnostic-permission": "1.1.1-preview-ea6406b3",
  "@metamask-previews/composable-controller": "11.0.0-preview-ea6406b3",
  "@metamask-previews/controller-utils": "11.12.0-preview-ea6406b3",
  "@metamask-previews/delegation-controller": "0.7.0-preview-ea6406b3",
  "@metamask-previews/earn-controller": "7.0.0-preview-ea6406b3",
  "@metamask-previews/eip-5792-middleware": "1.1.0-preview-ea6406b3",
  "@metamask-previews/eip1193-permission-middleware": "1.0.0-preview-ea6406b3",
  "@metamask-previews/ens-controller": "17.0.1-preview-ea6406b3",
  "@metamask-previews/error-reporting-service": "2.0.0-preview-ea6406b3",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-ea6406b3",
  "@metamask-previews/foundryup": "1.0.1-preview-ea6406b3",
  "@metamask-previews/gas-fee-controller": "24.0.0-preview-ea6406b3",
  "@metamask-previews/gator-permissions-controller": "0.1.0-preview-ea6406b3",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-ea6406b3",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-ea6406b3",
  "@metamask-previews/keyring-controller": "23.0.0-preview-ea6406b3",
  "@metamask-previews/logging-controller": "6.0.4-preview-ea6406b3",
  "@metamask-previews/message-manager": "12.0.2-preview-ea6406b3",
  "@metamask-previews/messenger": "0.2.0-preview-ea6406b3",
  "@metamask-previews/multichain-account-service": "0.7.0-preview-ea6406b3",
  "@metamask-previews/multichain-api-middleware": "1.0.0-preview-ea6406b3",
  "@metamask-previews/multichain-network-controller": "0.12.0-preview-ea6406b3",
  "@metamask-previews/multichain-transactions-controller": "5.0.0-preview-ea6406b3",
  "@metamask-previews/name-controller": "8.0.3-preview-ea6406b3",
  "@metamask-previews/network-controller": "24.1.0-preview-ea6406b3",
  "@metamask-previews/network-enablement-controller": "0.5.0-preview-ea6406b3",
  "@metamask-previews/notification-services-controller": "17.0.0-preview-ea6406b3",
  "@metamask-previews/permission-controller": "11.0.6-preview-ea6406b3",
  "@metamask-previews/permission-log-controller": "4.0.0-preview-ea6406b3",
  "@metamask-previews/phishing-controller": "13.1.0-preview-ea6406b3",
  "@metamask-previews/polling-controller": "14.0.0-preview-ea6406b3",
  "@metamask-previews/preferences-controller": "19.0.0-preview-ea6406b3",
  "@metamask-previews/profile-sync-controller": "24.0.0-preview-ea6406b3",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-ea6406b3",
  "@metamask-previews/remote-feature-flag-controller": "1.7.0-preview-ea6406b3",
  "@metamask-previews/sample-controllers": "1.0.0-preview-ea6406b3",
  "@metamask-previews/seedless-onboarding-controller": "4.0.0-preview-ea6406b3",
  "@metamask-previews/selected-network-controller": "23.0.0-preview-ea6406b3",
  "@metamask-previews/shield-controller": "0.1.2-preview-ea6406b3",
  "@metamask-previews/signature-controller": "33.0.0-preview-ea6406b3",
  "@metamask-previews/subscription-controller": "0.0.0-preview-ea6406b3",
  "@metamask-previews/token-search-discovery-controller": "3.3.0-preview-ea6406b3",
  "@metamask-previews/transaction-controller": "60.2.0-preview-ea6406b3",
  "@metamask-previews/user-operation-controller": "39.0.0-preview-ea6406b3"
}

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! (thanks a ton for addressing all this, we finally made it 💪)

@ccharly
Copy link
Contributor

ccharly commented Sep 11, 2025

(small remark though, I haven't reviewed the tests entirely, but we have good coverage and have run multiple real-case manual scenarios with preview builds, so we're good)

@mathieuartu mathieuartu merged commit 2745df9 into main Sep 11, 2025
239 checks passed
@mathieuartu mathieuartu deleted the feat/multichain-account-syncing branch September 11, 2025 07:10
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.

4 participants