chore(assets-controllers): add isDeprecated to TokenDetectionController#9363
Draft
Prithpal-Sooriya wants to merge 3 commits into
Draft
chore(assets-controllers): add isDeprecated to TokenDetectionController#9363Prithpal-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 assets-unify-state supersedes this controller. When true, polling stops and all detection entry points become no-ops. 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, legacy asset controllers need an opt-in deprecation path so hosts can disable them whenAssetsControllersupersedes their behavior — without removing the controllers yet.This PR adds an optional
isDeprecatedconstructor callback toTokenDetectionController, following the same pattern already used byTokensController,CurrencyRateController,TokenListController, and the multichain controllers. WhenisDeprecated()returnstrue:detectTokens,addDetectedTokensViaWs,addDetectedTokensViaPolling,start,_executePoll, and event-driven restarts)This is behavior-preserving when the callback is omitted or returns
false(the default).References
Manual testing steps
N/A — behavior-preserving when
isDeprecatedis not provided.Screenshots/Recordings
N/A
Changed files
packages/assets-controllers/src/TokenDetectionController.tsisDeprecatedoption and guards at all entry pointspackages/assets-controllers/src/TokenDetectionController.test.tsisDeprecatedtest suite (9 tests)yarn workspace @metamask/assets-controllers run jest --no-coverage packages/assets-controllers/src/TokenDetectionController.test.ts -t "isDeprecated"— all passpackages/assets-controllers/CHANGELOG.mdChecklist