Fix: Token detection on accounts other than current #1848
Merged
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
force-pushed
the
brian/token-detection-different-account
branch
from
2b536a6
to
265c2cd
Compare
sahar-fehri
approved these changes
Oct 18, 2023
salimtb
approved these changes
Oct 18, 2023
mcmire
pushed a commit
that referenced
this pull request
Nov 2, 2023
## Explanation `TokensController.addDetectedTokens` supports detecting tokens on accounts other than the one currently selected. But a bug occurs in this case. Tokens (both added and detected) from the current account get incorrectly copied to the detecting account, even when the detecting account has no balance of those tokens. This happened because `state.tokens` and `state.detectedTokens` were used to check for existing tokens, but these are scoped to the current account rather than the detecting account. Fix: Check `state.allTokens`, `state.allDetectedTokens`, and `state.allIgnoredTokens` instead, since they contain tokens for all chains + addresses. Some perf improvements are also made to combine `find` and `indexOf` into a single `findIndex`. Added a unit test that reproduced the problem on the old code, and passes with the new code. The existing test did not catch this because of its operation order (it detected the other account first, then added to the current account). ## Changelog ### `@metamask/assets-controllers` - **FIXED**: Token detection on accounts other than current ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
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
TokensController.addDetectedTokenssupports detecting tokens on accounts other than the one currently selected. But a bug occurs in this case. Tokens (both added and detected) from the current account get incorrectly copied to the detecting account, even when the detecting account has no balance of those tokens.This happened because
state.tokensandstate.detectedTokenswere used to check for existing tokens, but these are scoped to the current account rather than the detecting account.Fix: Check
state.allTokens,state.allDetectedTokens, andstate.allIgnoredTokensinstead, since they contain tokens for all chains + addresses. Some perf improvements are also made to combinefindandindexOfinto a singlefindIndex.Added a unit test that reproduced the problem on the old code, and passes with the new code. The existing test did not catch this because of its operation order (it detected the other account first, then added to the current account).
Changelog
@metamask/assets-controllersChecklist