feat(TokenBalancesController): Integrate Websocket updates in TokenBalancesController #6784
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kriys94
force-pushed
the
feature/token-balances-integration
branch
7 times, most recently
from
695f8e8 to
b06186b
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring alerts on:
|
Kriys94
force-pushed
the
feature/token-balances-integration
branch
from
9e3af3f to
54419f6
Compare
Kriys94
commented
Oct 8, 2025
Kriys94
commented
Oct 8, 2025
Kriys94
commented
Oct 9, 2025
Kriys94
commented
Oct 9, 2025
Kriys94
commented
Oct 9, 2025
Kriys94
commented
Oct 9, 2025
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Kriys94
commented
Oct 9, 2025
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Kriys94
force-pushed
the
feature/token-balances-integration
branch
4 times, most recently
from
a83a25c to
bb5bd02
Compare
This PR integrates the TokenBalancesController with the @metamask/core-backend package to enable real-time balance updates via WebSocket connections. Key Changes: - Add real-time balance updates via WebSocket integration with AccountActivityService - Add support for dynamic polling based on WebSocket connection status - Add TokenDetectionController:addDetectedTokensViaWs action handler - Add @metamask/core-backend as a dependency and peer dependency - Extract parseAssetType into token-balances-utils for better code organization - Update documentation and tests Breaking Changes: - TokenBalancesController messenger must now allow AccountActivityService events - TokenBalancesController messenger must now allow TokenDetectionController:addDetectedTokensViaWs action - Change TokenBalancesController default polling interval to 30 seconds (was 180 seconds)
Kriys94
force-pushed
the
feature/token-balances-integration
branch
from
bb5bd02 to
d3a8b3b
Compare
packages/assets-controllers/src/TokenDetectionController.test.ts
Outdated
Show resolved
Hide resolved
Prithpal-Sooriya
previously approved these changes
Oct 10, 2025
|
@SocketSecurity ignore npm/@metamask/[email protected] This package is accepted to allow WS usage for these asset controllers.
|
Prithpal-Sooriya
previously approved these changes
Oct 10, 2025
| ); | ||
|
|
||
| // postBalance.amount is in hex format (raw units) | ||
| const balanceHex = postBalance.amount as Hex; |
There was a problem hiding this comment.
Bug: Invalid Hex Assertion in Balance Update
The postBalance.amount value is type-asserted as Hex without validating its existence or format. If the AccountActivityService provides a balance update where postBalance.amount is missing or not a valid hex string, this could lead to unexpected behavior when the value is used downstream.
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
Tested the app and working successfully MetaMask/metamask-extension#36782 |
7 tasks
|
App tested in mobile too MetaMask/metamask-mobile#21050 |
bergarces
approved these changes
Oct 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR integrates the
TokenBalancesControllerwith the new@metamask/core-backendpackage to enable real-time balance updates via WebSocket connections. This provides users with instant balance updates without relying solely on periodic polling.Context & Dependencies
@metamask/core-backendpackage withBackendWebSocketServiceandAccountActivityService.Current State & Problem
Currently, the
TokenBalancesControllerrelies exclusively on periodic REST API polling to detect balance changes. This approach has several limitations:Solution
This PR enhances
TokenBalancesControllerto:AccountActivityServiceis availableKey Implementation Details
Integration with AccountActivityService:
AccountActivityService:balanceUpdatedevents via messengerConnection State Coordination:
BackendWebSocketService:connectionStateChangedeventsReferences
Checklist
@metamask/assets-controllersNote
Integrates TokenBalancesController with AccountActivityService for real-time balance updates, adds status-driven polling (with debounce/jitter) and WS-based token import, updates docs/tests, and introduces core-backend dependency with BREAKING messenger and interval changes.
AccountActivityService:balanceUpdatedandstatusChangedfor real-time updates and status-driven polling.30s(down) and5mwhen WebSocket is up.AccountTracker, imports untracked tokens viaTokenDetectionController:addDetectedTokensViaWs.caipChainIdToHex,parseAssetType), handlesallIgnoredTokens, and cleans up timers on destroy.addDetectedTokensViaWsto add WS-detected tokens from cache; minor cleanups.AccountActivityService:balanceUpdated,AccountActivityService:statusChanged, andTokenDetectionController:addDetectedTokensViaWs.30s(was180s).docs/real-time-balance-updates-flow.mdand updates README.@metamask/core-backendas dependency and peerDependency; updates tsconfig references and yarn.lock.Written by Cursor Bugbot for commit 5dac77e. This will update automatically on new commits. Configure here.