Skip to content

Commit

Permalink
fix: fix token import flow (#4924)
Browse files Browse the repository at this point in the history
## Explanation

As autodetection is now multi-chain, the `addTokens` function must be
adjusted by taking the `allTokens` and filter on `chainId` into account
to avoid importing the wrong tokens.

The `addTokens` function currently operates by taking the existing list
of imported tokens ( without considering the network ) and adding the
tokens specified in the `tokensToImport` parameter. This approach can
result in incorrect tokens being imported, as it doesn’t filter by
chain. To address this, we use `allTokens` to ensure accurate filtering
by chain.

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/assets-controllers`

- **CHANGED**: addTokens should rely now on `allTokens`


## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
  • Loading branch information
salimtb authored Nov 13, 2024
1 parent e06caee commit 37d2c1e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions packages/assets-controllers/src/TokensController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -462,16 +462,16 @@ export class TokensController extends BaseController<
*/
async addTokens(tokensToImport: Token[], networkClientId?: NetworkClientId) {
const releaseLock = await this.#mutex.acquire();
const { ignoredTokens, allDetectedTokens } = this.state;
const { allTokens, ignoredTokens, allDetectedTokens } = this.state;
const importedTokensMap: { [key: string]: true } = {};
// Used later to dedupe imported tokens
const newTokensMap = Object.values(tokensToImport).reduce(
(output, token) => {
output[token.address] = token;
return output;
},
{} as { [address: string]: Token },
);
const newTokensMap = [
...(allTokens[this.#chainId]?.[this.#getSelectedAccount().address] || []),
...tokensToImport,
].reduce((output, token) => {
output[token.address] = token;
return output;
}, {} as { [address: string]: Token });
try {
tokensToImport.forEach((tokenToAdd) => {
const { address, symbol, decimals, image, aggregators, name } =
Expand Down

0 comments on commit 37d2c1e

Please sign in to comment.