fix(assets-controllers): TokenRatesController state consistency #3624
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
Gudahtt
force-pushed
the
keep-token-rates-state-consistent
branch
10 times, most recently
from
7d2b6c9
to
9abf35c
Compare
The TokenRatesController has been updated to ensure that the two sets of exchange rate state are always consistent with each other. Previously if the method `updateExchangeRatesByChainId` was called directly, it would not update the `contractExchangeRates` state even if the equivalent part of `contractExchangeRatesByChainId` was updated by that call. The tests have undergone a substantial refactor to ensure that we cover all cases between both of these update methods. The test cases written previously left out many test cases. We should now have better (but not perfect) coverage, and the tests are now shared between the two methods because they have identical test cases. Fixes #3597
Gudahtt
force-pushed
the
keep-token-rates-state-consistent
branch
from
9abf35c
to
7df71ef
Compare
mcmire
reviewed
Dec 7, 2023
| }), | ||
| validateCurrencySupported: jest.fn().mockReturnValue( | ||
| false, | ||
| // Cast used because this method has an assertion in the return |
There was a problem hiding this comment.
Hmm, yes, okay, I can investigate this. Seems fine for now though.
| '0x0000000000000000000000000000000000000002', | ||
| ]; | ||
| const tokenPricesService = buildMockTokenPricesService({ | ||
| fetchTokenPrices: jest.fn().mockResolvedValue({ |
There was a problem hiding this comment.
Yes, this is better than my silly fetchTokenPricesWithIncreasingPriceForEachToken function 😂
Gudahtt
commented
Dec 7, 2023
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
3 tasks
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
The TokenRatesController has been updated to ensure that the two sets of exchange rate state are always consistent with each other. Previously if the method
updateExchangeRatesByChainIdwas called directly, it would not update thecontractExchangeRatesstate even if the equivalent part ofcontractExchangeRatesByChainIdwas updated by that call.The tests have undergone a substantial refactor to ensure that we cover all cases between both of these update methods. The test cases written previously left out many test cases. We should now have better (but not perfect) coverage, and the tests are now shared between the two methods because they have identical test cases.
References
Fixes #3597
Changelog
@metamask/assets-controllerscontractExchangeRatesstate would sometimes be stale after callingupdateExchangeRatesByChainIdChecklist