Prevent bug where incorrect symbol used for token rates #1496
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
There is a bug present in the TokenRatesController where a network switch can result in token rates being requested for the wrong network.
This can happen when the network state update event comes before currency rate controller state update event. The controller only works correctly if the currency rate controller state update event happens first.
Instead of getting the ticker from the currency rate controller, we now get it directly from the network controller. This simplifies the controller and ensures that we always use the currency symbol corresponding with the current chain ID.
References
This is tangentially related to #1466
Changelog
@metamask/assets-controllers
onCurrencyRateStateChange
constructor parameter from TokenRatesControllerChecklist