feat: Update token balances controller for multichain #4782
Conversation
This file contains 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
bergeron
commented
Oct 22, 2024
| @@ -319,7 +319,7 @@ export function divideIntoBatches<Value>( | |||
| } | |||
|
|
|||
| /** | |||
| * Constructs an object from processing batches of the given values | |||
| * Constructs a result from processing batches of the given values | |||
There was a problem hiding this comment.
I allowed this to reduce to something other than an object. In my case an array was useful. Saw no reason it couldn't be a non-object, same as a regular javascript reduce. Added tests.
bergeron
commented
Oct 22, 2024
| import { reduceInBatchesSerially } from './assetsUtil'; | ||
|
|
||
| // https://github.com/mds1/multicall/blob/main/deployments.json | ||
| const MULTICALL_CONTRACT_BY_CHAINID = { |
There was a problem hiding this comment.
The multicall3 smart contract is introduced.
Simple but useful utility here. It accepts an array of calls, and executes them via a single RPC multicall if the chain supports it. And falls back to N requests otherwise.
I was initially using eth-balance-checker, but it was worse in 2 areas.
-
It requires the same list of tokens to be checked across all accounts. Which can blow up into a lot of unnecessary checks. e.g. you're watching vitalik.eth and now you have to check 1000 tokens on every account.
-
multicall3 is deployed on a lot more networks (~250)
bergeron
changed the title
|
@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. |
|
@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. |
7 tasks
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
7 tasks
…/core into brian/token-balances-controller
7 tasks
darkwing
approved these changes
Nov 13, 2024
Merged
bergeron
added a commit
that referenced
this pull request
Nov 13, 2024
Major release of the assets controllers to include #4782
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
Updates the
TokenBalancesControllerto be used across chains.It now extends
StaticIntervalPollingControllerso the new token based polling patterns can be used.The state now stores erc20 balances across all chains and accounts. It used to only store them for the current chain and current account.
erc20 balances are now fetched with a single RPC multicall across all accounts + tokens (on the ~250 chains that support the multicall3 contract). Instead of doing a
balanceOfrequest for each token like before.The
TokenBalancesController,TokenRatesController, andTokensControllernow remove state from networks when they're removed, to avoid leaving stale data.References
Changelog
@metamask/assets-controllersBREAKING: The
TokenBalancesControllerstate is now across all chains and accounts under the fieldtokenBalances, as a mapping from account address -> chain id -> token address -> balance.BREAKING: The
TokenBalancesControllernow extendsStaticIntervalPollingController, and the new polling APIstartPollingmust be used to initiate polling (startPolling,stopPollingByPollingToken).BREAKING:
TokenBalancesControllernow requires subscriptions to thePreferencesController:stateChangeandNetworkController:stateChangeevents. And access to theNetworkController:getNetworkClientById,NetworkController:getState,TokensController:getState, andPreferencesController:getStateactions.BREAKING:
TokensControllerrequires a subscription to theNetworkController:stateChangeevent. It now now removes state for chain IDs when their network is removed.CHANGED:
TokenRatesControllernow removes state for chain IDs when their network is removed.Checklist