bump @metamask/assets-controllers to ^13.0.0
#20916
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
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
3 tasks
jiexi
changed the title
jiexi
changed the title
jiexi
changed the title
jiexi
commented
Sep 21, 2023
jiexi
added a commit
to MetaMask/core
that referenced
this pull request
Sep 22, 2023
Currently, TokenController only uses the global selected provider. We want to see how it feels making this controller consume any network provider the NetworkController may have available. We do this by extending the `addToken()` interface with an optional `networkClientId` param, but continuing to use the provider proxy as a fallback. ~~TODO: specs have not been updated to test the networkClientId case~~ added * Fixes MetaMask/MetaMask-planning#1020 * See MetaMask/metamask-extension#20916 ## Explanation <!-- 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? 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` - **BREAKING**: `TokensController` now expects `getNetworkClientById` in constructor options - **BREAKING**: `TokensController. addToken()` now accepts a single options object ``` { address: string; symbol: string; decimals: number; name?: string; image?: string; interactingAddress?: string; networkClientId?: NetworkClientId; } ``` - **CHANGED**: `TokensController. addToken()` will use the chain ID value derived from state for `networkClientId` if provided - **CHANGED**: `TokensController. addTokens()` now accepts an optional `networkClientId` as the last parameter - **CHANGED**: `TokensController. addTokens()` will use the chain ID value derived from state for `networkClientId` if provided - **CHANGED**: `TokensController. watchAsset()` options now accepts optional `networkClientId` which is used to get the ERC-20 token name if provided ## 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
|
Updated dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
@metamaskbot update-policies |
|
Policies updated |
Builds ready [38512df]
Page Load Metrics (1077 ± 428 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Builds ready [eaf661f]
Page Load Metrics (802 ± 448 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #20916 +/- ##
========================================
Coverage 68.58% 68.58%
========================================
Files 1013 1013
Lines 40614 40615 +1
Branches 10854 10858 +4
========================================
+ Hits 27854 27855 +1
Misses 12760 12760
☔ View full report in Codecov by Sentry. |
Builds ready [5557313]
Page Load Metrics (1236 ± 361 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Builds ready [d773e0c]
Page Load Metrics (963 ± 373 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
brad-decker
approved these changes
Oct 3, 2023
adonesky1
reviewed
Oct 3, 2023
14 tasks
metamaskbot
added
the
release-11.4.0
jiexi
added a commit
that referenced
this pull request
Oct 4, 2023
…1197) Fixes bug with TokensRateController no longer starting automatically on instantiation and requiring explicit `start()` to be called. Also replaces `configure({disabled})` with `start()` or `stop()` ## **Manual testing steps** * Open wallet * Check privacy settings to ensure price conversion is enabled * Restart wallet * Click send * Select ERC-20 token * Enter some amount * See that there is a conversion amount * Visit privacy settings and disable price conversion * Click send * Select ERC-20 token * Enter some amount * See that there is NO conversion amount ## **Screenshots/Recordings** _If applicable, add screenshots and/or recordings to visualize the before and after of your change._ ### **Before**  ### **After**  ## **Related issues** Fixes #20916 ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've clearly explained: - [x] What problem this PR is solving. - [x] How this problem was solved. - [x] How reviewers can test my changes. - [x] I’ve indicated what issue this PR is linked to: Fixes #??? - [ ] I’ve included tests if applicable. - [ ] I’ve documented any added code. - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). - [x] I’ve properly set the pull request status: - [ ] In case it's not yet "ready for review", I've set it to "draft". - [x] In case it's "ready for review", I've changed it from "draft" to "non-draft". ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
k-g-j
pushed a commit
that referenced
this pull request
Nov 1, 2023
…1197) Fixes bug with TokensRateController no longer starting automatically on instantiation and requiring explicit `start()` to be called. Also replaces `configure({disabled})` with `start()` or `stop()` ## **Manual testing steps** * Open wallet * Check privacy settings to ensure price conversion is enabled * Restart wallet * Click send * Select ERC-20 token * Enter some amount * See that there is a conversion amount * Visit privacy settings and disable price conversion * Click send * Select ERC-20 token * Enter some amount * See that there is NO conversion amount ## **Screenshots/Recordings** _If applicable, add screenshots and/or recordings to visualize the before and after of your change._ ### **Before**  ### **After**  ## **Related issues** Fixes #20916 ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've clearly explained: - [x] What problem this PR is solving. - [x] How this problem was solved. - [x] How reviewers can test my changes. - [x] I’ve indicated what issue this PR is linked to: Fixes #??? - [ ] I’ve included tests if applicable. - [ ] I’ve documented any added code. - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). - [x] I’ve properly set the pull request status: - [ ] In case it's not yet "ready for review", I've set it to "draft". - [x] In case it's "ready for review", I've changed it from "draft" to "non-draft". ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Needed to help get us closer to phasing out a single globally selected network.
Bumps
@metamask/assets-controllersto ^13.0.0 and passes networkClientId arg to newly updatedTokenController.addToken(),TokenController.addTokens(), andTokenController.watchAsset(). Adopts changes in other asset-related controllersScreenshots/Screencaps
None. Should be no changes apparent to user.
Manual Testing Steps
Via Dapp API
Via Wallet UI
0xc18360217d8f7ab5e7c516566761ea12ce7f9d72contract address for ENSPre-merge author checklist
Pre-merge reviewer checklist
If further QA is required (e.g. new feature, complex testing steps, large refactor), add the
Extension QA Boardlabel.In this case, a QA Engineer approval will be be required.