Skip to content

[pull] main from MetaMask:main#171

Merged
pull[bot] merged 3 commits into
dmrazzy:mainfrom
MetaMask:main
Apr 25, 2025
Merged

[pull] main from MetaMask:main#171
pull[bot] merged 3 commits into
dmrazzy:mainfrom
MetaMask:main

Conversation

@pull
Copy link
Copy Markdown

@pull pull Bot commented Apr 25, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

jiexi and others added 3 commits April 25, 2025 11:47
## Explanation

Releases chain-agnostic-permission package changes
## Explanation

This PR adds support for Sonic mainnet chainId in the list
`SUPPORTED_CHAIN_IDS` so that tokenRatesController is able to fetch
prices for tokens for this network.
<img width="1122" alt="Screenshot 2025-04-24 at 23 18 08"
src="https://github.com/user-attachments/assets/e294e948-6489-4c11-b121-6e1269886473"
/>

## 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

<!--
THIS SECTION IS NO LONGER NEEDED.

The process for updating changelogs has changed. Please consult the
"Updating changelogs" section of the Contributing doc for more.
-->

## 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 communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
## Explanation

The current implementation of `TokensController` relies heavily on a
single selected network (`chainId`) as an instance property, which makes
multi-chain token handling brittle and hard to scale. Additionally, some
token operations unintentionally assume a persistent network context,
introducing potential bugs when switching networks or performing actions
concurrently across different chains.

This PR refactors the `TokensController` to eliminate reliance on an
internal `#chainId` property. Instead, all methods that require a
network context now accept a `networkClientId` as an explicit parameter.
This improves the controller’s ability to operate safely and predictably
in a multi-chain environment.

The `#onNetworkDidChange` logic and associated subscription were removed
since network changes are now handled at the method level with explicit
`networkClientId` parameters. All relevant internal state mutations and
token metadata fetches are scoped to the appropriate chain via the
`networkClientId -> chainId` mapping.

This refactor is part of a broader initiative to support simultaneous
multi-chain state handling across the codebase (see recent changes to
`TokenRatesController` and `AccountTrackerController`).

integration with UI:
extension: MetaMask/metamask-extension#32274


<!--
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
* Fixes #5580 
<!--
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:


* Related to #67890
-->

## Changelog

### `@metamask/assets-controllers`

- **UPDATE:** Refactor `TokensController` to support handling multiple
chains in parallel. All network-dependent methods now require an
explicit `networkClientId` parameter, enabling token operations to be
fully scoped to a specific chain. This improves reliability and
predictability when managing tokens across different networks.
- **BREAKING:** Remove internal reliance on a single `chainId` instance
property in `TokensController`. All chain-specific logic has been
externalized. Consumers must now explicitly pass a `networkClientId` to
methods that interact with the token state. This change may require
updates on the client side to ensure correct chain context is provided
during token actions.


<!--
THIS SECTION IS NO LONGER NEEDED.

The process for updating changelogs has changed. Please consult the
"Updating changelogs" section of the Contributing doc for more.
-->

## 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 communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes
@pull pull Bot added the ⤵️ pull label Apr 25, 2025
@pull pull Bot merged commit 48e81ce into dmrazzy:main Apr 25, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 25, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants