Release 161.0.0 #4413
Release 161.0.0 #4413
Conversation
Co-authored-by: Jongsun Suh <[email protected]>
| - **BREAKING:** Newly added account is no longer set as the last selected account ([#4363](https://github.com/MetaMask/core/pull/4363)) | ||
| - Bump `@metamask/eth-snap-keyring` to `^4.3.1` ([#4405](https://github.com/MetaMask/core/pull/4405)) | ||
| - Bump `@metamask/keyring-api` to `^8.0.0` ([#4405](https://github.com/MetaMask/core/pull/4405)) | ||
| - Bump `@metamask/keyring-controller` to `^17.1.0` (`devDependencies`) ([#4413](https://github.com/MetaMask/core/pull/4413)) |
There was a problem hiding this comment.
Hmm we generally don't include devDeps bumps in the changelog, but I'm not sure why keyring-controller isn't a dependency.
That might be a holdover from a past state when keyring-controller only supplied types to accounts-controller?
@mcmire Should we recategorize keyring-controller as a dependency for accounts-controller at some point?
There was a problem hiding this comment.
I'm good with doing that in another PR as well.
This isn't the only case I've seen where a package needed to be moved to a different level. So we (Wallet Framework team) should probably go through all packages and audit them to ensure that any controller package that should be in dependencies and/or peerDependencies should be there. In addition I think knowing how to express dependencies on packages that are only for types — and knowing how to express dependencies that are used in conjunction with the messenger — has been a constant source of confusion, we should add documentation somewhere that explains our position.
There was a problem hiding this comment.
You're right, this should be moved to dependency now. To not block this release, i'll update this in another PR
There was a problem hiding this comment.
Oh weird my comment got added in the wrong place. Well you got the idea :)
|
|
||
| - **BREAKING:** Add `messenger` as a constructor option for `AccountTrackerController` ([#4225](https://github.com/MetaMask/core/pull/4225)) | ||
| - Add `AccountTrackerControllerMessenger` type | ||
| - `NftController` now allows `AccountsController:getAccount`, `AccountsController:getSelectedAccount` as messenger actions and subscribes to the `AccountsController:selectedEvmAccountChange` messenger event ([#4221](https://github.com/MetaMask/core/pull/4221)) |
There was a problem hiding this comment.
Saying that the controller allows the actions/events is a bit inaccurate; it would be better to say that the messenger that the controller takes must allow these actions/events. If the consumer isn't doing that currently and upgrades this package, then they will see a type and runtime error when the NftController constructor is run, so that makes this a breaking change:
| - `NftController` now allows `AccountsController:getAccount`, `AccountsController:getSelectedAccount` as messenger actions and subscribes to the `AccountsController:selectedEvmAccountChange` messenger event ([#4221](https://github.com/MetaMask/core/pull/4221)) | |
| - **BREAKING:** The `NftController` messenger must now allow `AccountsController:getAccount` and `AccountsController:getSelectedAccount` as messenger actions and `AccountsController:selectedEvmAccountChange` as a messenger event ([#4221](https://github.com/MetaMask/core/pull/4221)) |
There was a problem hiding this comment.
Initially we had that BREAKING prefix yes, but after discussing with @MajorLift, I understood this was not considered a "real" breaking changes. Anyway, I do agree with your suggestion, so let's re-add it. :)
There was a problem hiding this comment.
I agree with Elliot's description of the desired behavior, but it doesn't appear that we have type or runtime error guardrails in controller constructor for subtype messengers. Passing in messengers with incomplete or never allowlists into controller constructors seems to work fine.
Runtime errors are thrown, but only when call and subscribe/unsubscribe (or more accurately #isAllowedAction, #isAllowedEvent) is being invoked for the omitted actions/events.
I'll experiment with this a bit more in the test files since I might just be doing something wrong.
Edit: Created a base-controller ticket for this #4414
| - **BREAKING:** Newly added account is no longer set as the last selected account ([#4363](https://github.com/MetaMask/core/pull/4363)) | ||
| - Bump `@metamask/eth-snap-keyring` to `^4.3.1` ([#4405](https://github.com/MetaMask/core/pull/4405)) | ||
| - Bump `@metamask/keyring-api` to `^8.0.0` ([#4405](https://github.com/MetaMask/core/pull/4405)) | ||
| - Bump `@metamask/keyring-controller` to `^17.1.0` (`devDependencies`) ([#4413](https://github.com/MetaMask/core/pull/4413)) |
There was a problem hiding this comment.
I'm good with doing that in another PR as well.
This isn't the only case I've seen where a package needed to be moved to a different level. So we (Wallet Framework team) should probably go through all packages and audit them to ensure that any controller package that should be in dependencies and/or peerDependencies should be there. In addition I think knowing how to express dependencies on packages that are only for types — and knowing how to express dependencies that are used in conjunction with the messenger — has been a constant source of confusion, we should add documentation somewhere that explains our position.
Co-authored-by: Elliot Winkler <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>
There was a problem hiding this comment.
Looks good to me!
@MajorLift do you have any more thoughts?
|
Sorry @mcmire and @MajorLift! We missed that last comment ( |
|
@gantunesr No worries, everything looks good to me! :) |
| - Add `enable` and `disable` methods to `TokenRatesController` ([#4314](https://github.com/MetaMask/core/pull/4314)) | ||
| - These are used to stop and restart polling. | ||
| - Export `ContractExchangeRates` type ([#4314](https://github.com/MetaMask/core/pull/4314)) | ||
| - Add `AccountTrackerControllerMessenger` type |
There was a problem hiding this comment.
Ah looks like this belongs under line 14.
Leaving this comment as reference to be fixed by a future PR covering AccountTrackerController.
## Explanation This release contains the following packages: - `@metamask/accounts-controller` (major) - `@metamask/assets-controllers` (major) - `@metamask/chain-controller` (minor) - `@metamask/keyring-controller` (minor) - `@metamask/selected-network-controller` (patch) - `@metamask/transaction-controller` (major) <!-- ## 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/package-a` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here ### `@metamask/package-b` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here --> ## 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 --------- Co-authored-by: Jongsun Suh <[email protected]> Co-authored-by: Elliot Winkler <[email protected]>
Explanation
This release contains the following packages:
@metamask/accounts-controller(major)@metamask/assets-controllers(major)@metamask/chain-controller(minor)@metamask/keyring-controller(minor)@metamask/selected-network-controller(patch)@metamask/transaction-controller(major)Checklist