Ensure that all controllers used across clients are using BaseControllerV2 #1509
Open
18 of 28 tasks
Labels
Comments
|
These also need to be updated:
Completed:
|
This was referenced Nov 30, 2023
|
@MajorLift Done! |
Merged
3 tasks
MajorLift
added a commit
that referenced
this issue
Dec 11, 2023
## Explanation As part of the upcoming core wallet library initiative, we plan to migrate all controllers to `BaseControllerV2`. This commit upgrades `ComposableController`. ## References - Closes #2082 - See #1509 ## Changelog ### `@metamask/composable-controller` ## Added - Add types `ComposableControllerState`, `ComposableControllerStateChangeEvent`, `ComposableControllerEvents`, `ComposableControllerMessenger`. ## Changed - **BREAKING:** `ComposableController` is upgraded to extend `BaseControllerV2`. - The constructor now expects an options object with required properties `controllers` and `messenger` as its only argument. - `ComposableController` no longer has a `subscribe` method. Instead, listeners for `ComposableController` events must be registered to the controller messenger that generated the restricted messenger assigned to the instance's `messagingSystem` class field. - Any getters for `ComposableController` state that access the internal class field directly should be refactored to instead use listeners that are subscribed to `ComposableControllerStateChangeEvent`. ## 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 --------- Co-authored-by: Ellilot Winkler <[email protected]>
MajorLift
added a commit
that referenced
this issue
Dec 22, 2023
…ticIntervalPollingController` (#3609) ## Explanation This upgrades `TokenDetectionController` to extend `BaseControllerV2` and `StaticIntervalPollingController` as a preparation step for merging `TokenDetectionController` with `DetectTokensController`. ## References - See #1813 - See #1509 - Closes #3625 ## Changelog ### Added - `TokenListController` now exports a `TokenListControllerMessenger` type ([#3609](#3609)). - `TokenDetectionController` exports types `TokenDetectionControllerMessenger`, `TokenDetectionControllerActions`, `TokenDetectionControllerGetStateAction`, `TokenDetectionControllerEvents`, `TokenDetectionControllerStateChangeEvent` ([#3609](#3609)). - Add `enable` and `disable` methods to `TokenDetectionController`, which control whether the controller is able to make polling requests or all of its network calls are blocked. ([#3609](#3609)). - Note that if the controller is initiated without the `disabled` constructor option set to `false`, the `enable` method will need to be called before the controller can make polling requests in response to subscribed events. ### Changed - **BREAKING:** `TokenDetectionController` is upgraded to extend `BaseControllerV2` and `StaticIntervalPollingController` ([#3609](#3609)). - The constructor now expects an options object as its only argument, with required properties `messenger`, `networkClientId`, required callbacks `onPreferencesStateChange`, `getBalancesInSingleCall`, `addDetectedTokens`, `getTokenState`, `getPreferencesState`, and optional properties `disabled`, `interval`, `selectedAddress`. ## 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 --------- Co-authored-by: Elliot Winkler <[email protected]>
mcmire
changed the title
This was referenced Jul 17, 2024
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
These controllers are still using BaseController (v1) and need to be migrated to BaseControllerV2. Some controllers don't need to be controllers at all.
Core packages
TokenDetectionControllertoBaseControllerV2#3625)PhishingControllerto BaseControllerV2 #1705)Non-core packages
MetaMask/smart-transactions-controllerMetaMask/swaps-controllerExtension controllers
The text was updated successfully, but these errors were encountered: