Skip to content

Conversation

@salimtb
Copy link
Contributor

@salimtb salimtb commented Dec 12, 2025

Explanation

  • Fix TokenBalancesController to evaluate allowExternalServices dynamically instead of only at constructor time.
    • Previously, the #balanceFetchers array was built once in the constructor, so changes to allowExternalServices() after initialization were not reflected
    • Now allowExternalServices() is stored as a function and evaluated dynamically in the fetcher's supports method
  • Fix TokenDetectionController methods addDetectedTokensViaPolling and addDetectedTokensViaWs to refresh token metadata cache before use
    • Previously, these methods used a potentially stale/empty #tokensChainsCache from construction time
    • Now they fetch the latest tokensChainsCache from TokenListController:getState before looking up token metadata

Extension UI: MetaMask/metamask-extension#38841
Mobile UI: MetaMask/metamask-mobile#23864

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

Note

Introduce onboarding-aware balance fetching, dynamic allowExternalServices checks, and fresh token metadata usage, with refactors and tests across balances and detection controllers.

  • TokenBalancesController:
    • Add isOnboarded option; isActive now requires unlocked + onboarded.
    • Always include Accounts API fetcher; supports() now evaluates allowExternalServices() dynamically.
    • Preserve original polling intents; improve interval grouping and error handling.
  • AccountTrackerController:
    • Add isOnboarded option; skip refresh/syncBalanceWithAddresses when not onboarded.
    • Refresh balances for both from and to addresses on tx events.
    • Handle unprocessedChainIds fallback; tighten typings, privatize syncAccounts, safer event handling.
  • TokenDetectionController:
    • Refresh tokensChainsCache at call-time for addDetectedTokensViaPolling/addDetectedTokensViaWs.
    • Keep RPC detection path; skip when external services disabled/unavailable.
  • Tests/Changelog:
    • Extensive unit tests for onboarding gating, dynamic external-services, fallbacks, and cache refresh.
    • Update CHANGELOG.md with added options and fixes; add mocks tests for Accounts API balances.

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

@salimtb salimtb marked this pull request as ready for review December 12, 2025 18:35
@salimtb salimtb requested review from a team as code owners December 12, 2025 18:35
this.#balanceFetchers = [
...(accountsApiChainIds().length > 0 && allowExternalServices()
? [this.#createAccountsApiFetcher()]
: []),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we should not do this at the constructor level , this is init only when the worker restart , the new approach will have it changing even when the worker doesn't restart

return {
// Dynamically check allowExternalServices() at call time, not just at construction time
supports: (chainId: ChainIdHex): boolean =>
this.#allowExternalServices() &&
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we consider chains not supported for api fetch if basic func is off

// This fixes a bug where the cache from construction time could be stale/empty
const { tokensChainsCache } = this.messenger.call(
'TokenListController:getState',
);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

same here , we should fetch this value from the state to ensure we get last updated data

@salimtb
Copy link
Contributor Author

salimtb commented Dec 13, 2025

@metamaskbot publish-preview

@github-actions
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": "4.0.0-preview-6c59381c",
  "@metamask-previews/accounts-controller": "35.0.0-preview-6c59381c",
  "@metamask-previews/address-book-controller": "7.0.1-preview-6c59381c",
  "@metamask-previews/analytics-controller": "0.0.0-preview-6c59381c",
  "@metamask-previews/announcement-controller": "8.0.0-preview-6c59381c",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-6c59381c",
  "@metamask-previews/approval-controller": "8.0.0-preview-6c59381c",
  "@metamask-previews/assets-controllers": "94.0.0-preview-6c59381c",
  "@metamask-previews/base-controller": "9.0.0-preview-6c59381c",
  "@metamask-previews/bridge-controller": "64.1.0-preview-6c59381c",
  "@metamask-previews/bridge-status-controller": "64.1.0-preview-6c59381c",
  "@metamask-previews/build-utils": "3.0.4-preview-6c59381c",
  "@metamask-previews/chain-agnostic-permission": "1.3.0-preview-6c59381c",
  "@metamask-previews/claims-controller": "0.2.0-preview-6c59381c",
  "@metamask-previews/composable-controller": "12.0.0-preview-6c59381c",
  "@metamask-previews/controller-utils": "11.16.0-preview-6c59381c",
  "@metamask-previews/core-backend": "5.0.0-preview-6c59381c",
  "@metamask-previews/delegation-controller": "2.0.0-preview-6c59381c",
  "@metamask-previews/earn-controller": "11.0.0-preview-6c59381c",
  "@metamask-previews/eip-5792-middleware": "2.0.0-preview-6c59381c",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-6c59381c",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-6c59381c",
  "@metamask-previews/ens-controller": "19.0.0-preview-6c59381c",
  "@metamask-previews/error-reporting-service": "3.0.0-preview-6c59381c",
  "@metamask-previews/eth-block-tracker": "15.0.0-preview-6c59381c",
  "@metamask-previews/eth-json-rpc-middleware": "22.0.1-preview-6c59381c",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-6c59381c",
  "@metamask-previews/foundryup": "1.0.1-preview-6c59381c",
  "@metamask-previews/gas-fee-controller": "26.0.0-preview-6c59381c",
  "@metamask-previews/gator-permissions-controller": "0.8.0-preview-6c59381c",
  "@metamask-previews/json-rpc-engine": "10.2.0-preview-6c59381c",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-6c59381c",
  "@metamask-previews/keyring-controller": "25.0.0-preview-6c59381c",
  "@metamask-previews/logging-controller": "7.0.1-preview-6c59381c",
  "@metamask-previews/message-manager": "14.1.0-preview-6c59381c",
  "@metamask-previews/messenger": "0.3.0-preview-6c59381c",
  "@metamask-previews/multichain-account-service": "4.0.1-preview-6c59381c",
  "@metamask-previews/multichain-api-middleware": "1.2.5-preview-6c59381c",
  "@metamask-previews/multichain-network-controller": "3.0.0-preview-6c59381c",
  "@metamask-previews/multichain-transactions-controller": "7.0.0-preview-6c59381c",
  "@metamask-previews/name-controller": "9.0.0-preview-6c59381c",
  "@metamask-previews/network-controller": "27.0.0-preview-6c59381c",
  "@metamask-previews/network-enablement-controller": "4.0.0-preview-6c59381c",
  "@metamask-previews/notification-services-controller": "21.0.0-preview-6c59381c",
  "@metamask-previews/permission-controller": "12.1.1-preview-6c59381c",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-6c59381c",
  "@metamask-previews/phishing-controller": "16.1.0-preview-6c59381c",
  "@metamask-previews/polling-controller": "16.0.0-preview-6c59381c",
  "@metamask-previews/preferences-controller": "22.0.0-preview-6c59381c",
  "@metamask-previews/profile-metrics-controller": "1.1.0-preview-6c59381c",
  "@metamask-previews/profile-sync-controller": "27.0.0-preview-6c59381c",
  "@metamask-previews/ramps-controller": "0.0.0-preview-6c59381c",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-6c59381c",
  "@metamask-previews/remote-feature-flag-controller": "3.0.0-preview-6c59381c",
  "@metamask-previews/sample-controllers": "4.0.0-preview-6c59381c",
  "@metamask-previews/seedless-onboarding-controller": "7.1.0-preview-6c59381c",
  "@metamask-previews/selected-network-controller": "26.0.0-preview-6c59381c",
  "@metamask-previews/shield-controller": "4.0.0-preview-6c59381c",
  "@metamask-previews/signature-controller": "38.0.0-preview-6c59381c",
  "@metamask-previews/storage-service": "0.0.1-preview-6c59381c",
  "@metamask-previews/subscription-controller": "5.4.0-preview-6c59381c",
  "@metamask-previews/token-search-discovery-controller": "4.0.0-preview-6c59381c",
  "@metamask-previews/transaction-controller": "62.6.0-preview-6c59381c",
  "@metamask-previews/transaction-pay-controller": "10.5.0-preview-6c59381c",
  "@metamask-previews/user-operation-controller": "41.0.0-preview-6c59381c"
}

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@salimtb
Copy link
Contributor Author

salimtb commented Dec 13, 2025

@metamaskbot publish-preview

@github-actions
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": "4.0.0-preview-cb4a07d5",
  "@metamask-previews/accounts-controller": "35.0.0-preview-cb4a07d5",
  "@metamask-previews/address-book-controller": "7.0.1-preview-cb4a07d5",
  "@metamask-previews/analytics-controller": "0.0.0-preview-cb4a07d5",
  "@metamask-previews/announcement-controller": "8.0.0-preview-cb4a07d5",
  "@metamask-previews/app-metadata-controller": "2.0.0-preview-cb4a07d5",
  "@metamask-previews/approval-controller": "8.0.0-preview-cb4a07d5",
  "@metamask-previews/assets-controllers": "94.0.0-preview-cb4a07d5",
  "@metamask-previews/base-controller": "9.0.0-preview-cb4a07d5",
  "@metamask-previews/bridge-controller": "64.1.0-preview-cb4a07d5",
  "@metamask-previews/bridge-status-controller": "64.1.0-preview-cb4a07d5",
  "@metamask-previews/build-utils": "3.0.4-preview-cb4a07d5",
  "@metamask-previews/chain-agnostic-permission": "1.3.0-preview-cb4a07d5",
  "@metamask-previews/claims-controller": "0.2.0-preview-cb4a07d5",
  "@metamask-previews/composable-controller": "12.0.0-preview-cb4a07d5",
  "@metamask-previews/controller-utils": "11.16.0-preview-cb4a07d5",
  "@metamask-previews/core-backend": "5.0.0-preview-cb4a07d5",
  "@metamask-previews/delegation-controller": "2.0.0-preview-cb4a07d5",
  "@metamask-previews/earn-controller": "11.0.0-preview-cb4a07d5",
  "@metamask-previews/eip-5792-middleware": "2.0.0-preview-cb4a07d5",
  "@metamask-previews/eip-7702-internal-rpc-middleware": "0.1.0-preview-cb4a07d5",
  "@metamask-previews/eip1193-permission-middleware": "1.0.3-preview-cb4a07d5",
  "@metamask-previews/ens-controller": "19.0.0-preview-cb4a07d5",
  "@metamask-previews/error-reporting-service": "3.0.0-preview-cb4a07d5",
  "@metamask-previews/eth-block-tracker": "15.0.0-preview-cb4a07d5",
  "@metamask-previews/eth-json-rpc-middleware": "22.0.1-preview-cb4a07d5",
  "@metamask-previews/eth-json-rpc-provider": "6.0.0-preview-cb4a07d5",
  "@metamask-previews/foundryup": "1.0.1-preview-cb4a07d5",
  "@metamask-previews/gas-fee-controller": "26.0.0-preview-cb4a07d5",
  "@metamask-previews/gator-permissions-controller": "0.8.0-preview-cb4a07d5",
  "@metamask-previews/json-rpc-engine": "10.2.0-preview-cb4a07d5",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.8-preview-cb4a07d5",
  "@metamask-previews/keyring-controller": "25.0.0-preview-cb4a07d5",
  "@metamask-previews/logging-controller": "7.0.1-preview-cb4a07d5",
  "@metamask-previews/message-manager": "14.1.0-preview-cb4a07d5",
  "@metamask-previews/messenger": "0.3.0-preview-cb4a07d5",
  "@metamask-previews/multichain-account-service": "4.0.1-preview-cb4a07d5",
  "@metamask-previews/multichain-api-middleware": "1.2.5-preview-cb4a07d5",
  "@metamask-previews/multichain-network-controller": "3.0.0-preview-cb4a07d5",
  "@metamask-previews/multichain-transactions-controller": "7.0.0-preview-cb4a07d5",
  "@metamask-previews/name-controller": "9.0.0-preview-cb4a07d5",
  "@metamask-previews/network-controller": "27.0.0-preview-cb4a07d5",
  "@metamask-previews/network-enablement-controller": "4.0.0-preview-cb4a07d5",
  "@metamask-previews/notification-services-controller": "21.0.0-preview-cb4a07d5",
  "@metamask-previews/permission-controller": "12.1.1-preview-cb4a07d5",
  "@metamask-previews/permission-log-controller": "5.0.0-preview-cb4a07d5",
  "@metamask-previews/phishing-controller": "16.1.0-preview-cb4a07d5",
  "@metamask-previews/polling-controller": "16.0.0-preview-cb4a07d5",
  "@metamask-previews/preferences-controller": "22.0.0-preview-cb4a07d5",
  "@metamask-previews/profile-metrics-controller": "2.0.0-preview-cb4a07d5",
  "@metamask-previews/profile-sync-controller": "27.0.0-preview-cb4a07d5",
  "@metamask-previews/ramps-controller": "1.0.0-preview-cb4a07d5",
  "@metamask-previews/rate-limit-controller": "7.0.0-preview-cb4a07d5",
  "@metamask-previews/remote-feature-flag-controller": "3.0.0-preview-cb4a07d5",
  "@metamask-previews/sample-controllers": "4.0.0-preview-cb4a07d5",
  "@metamask-previews/seedless-onboarding-controller": "7.1.0-preview-cb4a07d5",
  "@metamask-previews/selected-network-controller": "26.0.0-preview-cb4a07d5",
  "@metamask-previews/shield-controller": "4.0.0-preview-cb4a07d5",
  "@metamask-previews/signature-controller": "38.0.0-preview-cb4a07d5",
  "@metamask-previews/storage-service": "0.0.1-preview-cb4a07d5",
  "@metamask-previews/subscription-controller": "5.4.0-preview-cb4a07d5",
  "@metamask-previews/token-search-discovery-controller": "4.0.0-preview-cb4a07d5",
  "@metamask-previews/transaction-controller": "62.6.0-preview-cb4a07d5",
  "@metamask-previews/transaction-pay-controller": "10.5.0-preview-cb4a07d5",
  "@metamask-previews/user-operation-controller": "41.0.0-preview-cb4a07d5"
}

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.

2 participants