chore(assets-controllers): add isDeprecated to TokenDetectionController#9362
Draft
Prithpal-Sooriya wants to merge 3 commits into
Draft
chore(assets-controllers): add isDeprecated to TokenDetectionController#9362Prithpal-Sooriya wants to merge 3 commits into
Prithpal-Sooriya wants to merge 3 commits into
Conversation
Add an optional isDeprecated constructor callback so hosts can disable token detection when AssetsController supersedes this controller via the assets-unify-state feature flag. When deprecated, polling is stopped and all detection entry points become no-ops without tearing down the controller. Co-authored-by: Prithpal Sooriya <prithpal.sooriya@gmail.com>
Co-authored-by: Prithpal Sooriya <prithpal.sooriya@gmail.com>
…roller tests Co-authored-by: Prithpal Sooriya <prithpal.sooriya@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
As part of the
assets-unify-staterollout,AssetsControllersupersedes legacy per-chain controllers.TokenDetectionControllerneeds the same opt-out mechanism already added toTokenListController,TokensController,TokenBalancesController, and related controllers.This PR adds an optional
isDeprecatedconstructor callback toTokenDetectionController. When it returnstrue, the controller stops polling, blocks network activity, and becomes a no-op at every entry point (start,detectTokens,_executePoll,addDetectedTokensViaWs, andaddDetectedTokensViaPolling). The callback is re-evaluated on each entry point so hosts can toggle deprecation at runtime without reconstructing the controller.References
Manual testing steps
N/A — behavior-preserving when
isDeprecatedis omitted (defaults tofalse).Screenshots/Recordings
N/A
Changed files
packages/assets-controllers/src/TokenDetectionController.tsisDeprecatedoption and#enforceDisabledState()guards on all detection entry pointsyarn eslinton changed filespackages/assets-controllers/src/TokenDetectionController.test.tsisDeprecatedtest suite (9 cases)yarn workspace @metamask/assets-controllers run jest --no-coverage packages/assets-controllers/src/TokenDetectionController.test.ts -t "isDeprecated"packages/assets-controllers/CHANGELOG.mdisDeprecatedoption under UnreleasedChecklist