feat: add getErc20Balances helper TokenBalancesControllers #5925
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
salimtb
changed the title
salimtb
force-pushed
the
feat/token-balances-controller-get-balance
branch
from
32372f2 to
69122ec
Compare
|
@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. |
salimtb
force-pushed
the
feat/token-balances-controller-get-balance
branch
from
c93d287 to
2a93861
Compare
sahar-fehri
reviewed
Jun 6, 2025
| * @returns The balances for the given token addresses. | ||
| */ | ||
| async #batchBalanceOf({ | ||
| chainId, |
There was a problem hiding this comment.
Nit: Do you think its better to pass the networkClientId instead of chainId?
We would also pass networkClientId in getErc20Balances instead of chainId
sahar-fehri
reviewed
Jun 6, 2025
| @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
|
|
|||
| - Added Base Network for networks to track in `TokenDetectionController` ([#5902](https://github.com/MetaMask/core/pull/5902)) | |||
| - Network changes were added in `@metamask/controller-utils` | |||
| - Add `getErc20Balances` function within `TokenBalancesController` to support fetching ERC-20 token balances for a given address and token list ([#5925](https://github.com/MetaMask/core/pull/5925)) | |||
There was a problem hiding this comment.
Nit: can we add this Changelog before the "- Added Base Network for network..."
sahar-fehri
reviewed
Jun 6, 2025
| tokenAddresses: Hex[]; | ||
| }): Promise<Record<Hex, Hex | null>> { | ||
| // Return early if no token addresses provided | ||
| if (tokenAddresses.length === 0) { |
There was a problem hiding this comment.
Makes sense to return early here; wondering if there is a specific use case you had in mind for adding the condition?
I think this fct will be used on clients to fetch balances on the fly for 1 or more tokens in the import flow; i , for now, dnt expect it to be called with an empty array; but makes sense to me to keep the check!
sahar-fehri
approved these changes
Jun 6, 2025
Comment on lines
+485
to
+486
| tokenAddresses.forEach((tokenAddress, i) => { | ||
| balances[tokenAddress] = results[i]?.success |
There was a problem hiding this comment.
Comment - So this is a 1:1 mapping?
Reason I'm asking is below (in the updateBalancesByChainId) we loop through the results and then index to get the tokenAddress; over here we are doing it the other way round.
There was a problem hiding this comment.
We can leave as is, this was mostly a comment.
Prithpal-Sooriya
approved these changes
Jun 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation
This change introduces a new
getErc20Balancesservice function within theTokenBalancesController. The goal is to provide a reusable and isolated utility to fetch ERC-20 token balances for a given address and token list.The service is intended to be used internally by the controller or other consumers needing direct access to raw ERC-20 balances, while abstracting away Web3 calls and error handling.
References
Changelog
@metamask/assets-controllersUPDATE: Created getErc20Balances function within TokenBalancesController to support fetching ERC-20 token balances for a given address and token list. This modular service simplifies balance retrieval logic and can be reused across different parts of the controller.
Checklist