refactor(assets-controllers): migrate getBalancesInSingleCall to use multicall3 #7121
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
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
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
Current State
The
getBalancesInSingleCallfunction inAssetsContractControllerwas previously using a direct contract call to the single-call balance checker contract (SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID). This approach had limited chain coverage as the contract was only deployed on a subset of networks.Solution
This PR refactors
getBalancesInSingleCallto use thegetTokenBalancesForMultipleAddressesutility function, which leverages Multicall3'saggregate3method. This provides:Key Changes
AssetsContractController.ts
getTokenBalancesForMultipleAddressesMULTICALL_CONTRACT_BY_CHAINIDbefore attempting to fetch balancestokenAddress -> userAddress -> BNtotokenAddress -> BNmulticall.ts
MULTICALL_CONTRACT_BY_CHAINIDconstant to enable external chain support checksTest Updates
Web3Provider.prototype.callmocks (which caused stack overflow errors) with direct mocking ofgetTokenBalancesForMultipleAddressesafterEachhooks to restore mocks and clean network mocks usingnock.cleanAll()AssetsContractControllerWithNetworkClientId.test.tsto correctly reflect that Sepolia now has Multicall3 supportBNobjects instead ofBigNumberNon-Obvious Changes
afterEachcleanup hooks to prevent test pollution from persistent mocksReferences
Checklist