fix: update tokens controllers to use selectedAccountId instead of selectedAddress by montelaidev · Pull Request #4219 · MetaMask/core

montelaidev · 2024-04-26T08:58:48Z

Explanation

This PR updates the selectedAccount to selectedAccountId in the token controllers

References

Fixeshttps://github.com/MetaMask/accounts-planning/issues/381

Changelog

`@metamask/assets-controllers`

BREAKING:
- TokenBalancesController messenger must allow the action AccountsController:getSelectedAccount and remove PreferencesController:getState.
- TokenDetectionController messenger must allow the action AccountsController:getAccount.
- TokenDetectionController messenger must allow the event AccountsController:selectedEvmAccountChange and remove AccountsController:selectedAccountChange.
- TokenDetectionController removes selectedAddress constructor argument.
- TokenRatesController messenger must allow the action AccountsController:getAccount, AccountsController:getSelectedAccount and remove PreferencesController:getState.
- TokenRatesController messenger must allow the event AccountsController:selectedEvmAccountChange and remove PreferencesController:stateChange.
- TokensController messenger must allow the action AccountsController:getAccount, AccountsController:getSelectedAccount.
- TokensController messenger must allow the event AccountsController:selectedEvmAccountChange.
- TokensController removes selectedAddress constructor argument.

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

montelaidev · 2024-04-26T08:59:21Z

@metamaskbot publish-preview

montelaidev · 2024-04-29T08:25:31Z

@metamaskbot publish-preview

montelaidev · 2024-04-29T13:02:46Z

@metamaskbot publish-preview

github-actions · 2024-04-29T13:06:30Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
"@metamask-previews/accounts-controller": "13.0.0-preview-cb17e99",
"@metamask-previews/address-book-controller": "4.0.1-preview-cb17e99",
"@metamask-previews/announcement-controller": "6.1.0-preview-cb17e99",
"@metamask-previews/approval-controller": "6.0.1-preview-cb17e99",
"@metamask-previews/assets-controllers": "28.0.0-preview-cb17e99",
"@metamask-previews/base-controller": "5.0.1-preview-cb17e99",
"@metamask-previews/build-utils": "2.0.1-preview-cb17e99",
"@metamask-previews/composable-controller": "6.0.1-preview-cb17e99",
"@metamask-previews/controller-utils": "9.1.0-preview-cb17e99",
"@metamask-previews/ens-controller": "10.0.1-preview-cb17e99",
"@metamask-previews/eth-json-rpc-provider": "3.0.1-preview-cb17e99",
"@metamask-previews/gas-fee-controller": "15.1.0-preview-cb17e99",
"@metamask-previews/json-rpc-engine": "8.0.1-preview-cb17e99",
"@metamask-previews/json-rpc-middleware-stream": "7.0.1-preview-cb17e99",
"@metamask-previews/keyring-controller": "15.0.0-preview-cb17e99",
"@metamask-previews/logging-controller": "3.0.1-preview-cb17e99",
"@metamask-previews/message-manager": "8.0.1-preview-cb17e99",
"@metamask-previews/name-controller": "6.0.1-preview-cb17e99",
"@metamask-previews/network-controller": "18.1.0-preview-cb17e99",
"@metamask-previews/notification-controller": "5.0.1-preview-cb17e99",
"@metamask-previews/permission-controller": "9.0.2-preview-cb17e99",
"@metamask-previews/permission-log-controller": "2.0.1-preview-cb17e99",
"@metamask-previews/phishing-controller": "9.0.1-preview-cb17e99",
"@metamask-previews/polling-controller": "6.0.1-preview-cb17e99",
"@metamask-previews/preferences-controller": "10.0.0-preview-cb17e99",
"@metamask-previews/queued-request-controller": "0.9.0-preview-cb17e99",
"@metamask-previews/rate-limit-controller": "5.0.1-preview-cb17e99",
"@metamask-previews/selected-network-controller": "12.0.1-preview-cb17e99",
"@metamask-previews/signature-controller": "15.0.0-preview-cb17e99",
"@metamask-previews/transaction-controller": "28.1.0-preview-cb17e99",
"@metamask-previews/user-operation-controller": "8.0.1-preview-cb17e99"
}

montelaidev · 2024-04-30T14:16:36Z

Tested on extension https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/78306/workflows/59549a3e-34ce-4e66-a90a-fead14da074d

…nternal-accounts

mcmire · 2024-06-05T17:53:00Z

 */
 constructor({
-selectedAddress,
+selectedAccountId,


Similar comment as here — what are your thoughts on using the messenger to get the current value of this later on in the constructor rather than having the controller take this as an argument?

mcmire · 2024-06-05T17:54:13Z

- onPreferencesStateChange,
+ selectedAccountId,
+ getInternalAccount,
+ onSelectedAccountChange,


Similar comment as above, but in addition, instead of continuing with the callback pattern is it possible to listen to the AccountsController:selectedAccountChange event instead?

mcmire · 2024-06-05T17:54:23Z

 constructor({
 chainId: initialChainId,
-selectedAddress,
+selectedAccountId,


Similar comment as above.

…ns-controllers-to-use-internal-accounts

…uctor

ccharly · 2024-06-14T09:18:43Z

+ const selectedAccount = this.messagingSystem.call(
+ 'AccountsController:getAccount',
+ this.#selectedAccountId,
+ );


Suggested change
constselectedAccount=this.messagingSystem.call(
'AccountsController:getAccount',
this.#selectedAccountId,
);
constselectedAddress=this.#getSelectedAddress();
And use selectedAddress afterward

WDYT about this suggestion ⬆️?

ccharly · 2024-06-18T12:51:10Z

+ const selectedAccount = this.messagingSystem.call(
+ 'AccountsController:getAccount',
+ this.#selectedAccountId,
+ );


WDYT about this suggestion ⬆️?

…ns-controllers-to-use-internal-accounts

montelaidev · 2024-06-18T15:00:45Z

@metamaskbot publish-preview

github-actions · 2024-06-18T15:04:11Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
"@metamask-previews/accounts-controller": "17.0.0-preview-8ab89f22",
"@metamask-previews/address-book-controller": "5.0.0-preview-8ab89f22",
"@metamask-previews/announcement-controller": "7.0.0-preview-8ab89f22",
"@metamask-previews/approval-controller": "7.0.0-preview-8ab89f22",
"@metamask-previews/assets-controllers": "33.0.0-preview-8ab89f22",
"@metamask-previews/base-controller": "6.0.0-preview-8ab89f22",
"@metamask-previews/build-utils": "3.0.0-preview-8ab89f22",
"@metamask-previews/chain-controller": "0.1.0-preview-8ab89f22",
"@metamask-previews/composable-controller": "7.0.0-preview-8ab89f22",
"@metamask-previews/controller-utils": "11.0.0-preview-8ab89f22",
"@metamask-previews/ens-controller": "12.0.0-preview-8ab89f22",
"@metamask-previews/eth-json-rpc-provider": "4.0.0-preview-8ab89f22",
"@metamask-previews/gas-fee-controller": "17.0.0-preview-8ab89f22",
"@metamask-previews/json-rpc-engine": "9.0.0-preview-8ab89f22",
"@metamask-previews/json-rpc-middleware-stream": "8.0.0-preview-8ab89f22",
"@metamask-previews/keyring-controller": "17.1.0-preview-8ab89f22",
"@metamask-previews/logging-controller": "5.0.0-preview-8ab89f22",
"@metamask-previews/message-manager": "10.0.0-preview-8ab89f22",
"@metamask-previews/name-controller": "8.0.0-preview-8ab89f22",
"@metamask-previews/network-controller": "19.0.0-preview-8ab89f22",
"@metamask-previews/notification-controller": "6.0.0-preview-8ab89f22",
"@metamask-previews/notification-services-controller": "0.0.0-preview-8ab89f22",
"@metamask-previews/permission-controller": "10.0.0-preview-8ab89f22",
"@metamask-previews/permission-log-controller": "3.0.0-preview-8ab89f22",
"@metamask-previews/phishing-controller": "10.0.0-preview-8ab89f22",
"@metamask-previews/polling-controller": "8.0.0-preview-8ab89f22",
"@metamask-previews/preferences-controller": "13.0.0-preview-8ab89f22",
"@metamask-previews/profile-sync-controller": "0.0.0-preview-8ab89f22",
"@metamask-previews/queued-request-controller": "0.12.0-preview-8ab89f22",
"@metamask-previews/rate-limit-controller": "6.0.0-preview-8ab89f22",
"@metamask-previews/selected-network-controller": "15.0.2-preview-8ab89f22",
"@metamask-previews/signature-controller": "18.0.0-preview-8ab89f22",
"@metamask-previews/transaction-controller": "33.0.0-preview-8ab89f22",
"@metamask-previews/user-operation-controller": "12.0.0-preview-8ab89f22"
}

ccharly

Good job :) this was a big one! :)

…nternal-accounts

montelaidev · 2024-06-20T15:21:03Z

@metamaskbot publish-preview

…lectedAddress (#4219) ## Explanation This PR updates the `selectedAccount` to `selectedAccountId` in the token controllers ## References FixesMetaMask/accounts-planning#381 ## Changelog ### `@metamask/assets-controllers` - **BREAKING**: `TokenBalancesController` update `PreferencesConrtollerGetStateAction` to `AccountsControllerGetSelectedAccountAction` - **BREAKING**: `TokenDetectionController` change `selectedAddress` to `selectedAccountId` - **ADDED**: `TokenDetectionController` add `getAccountAction` - **BREAKING**: `TokenRatesController` change `selectedAddress` to `selectedAccountId` - **BREAKING**: `onPreferencesStateChange` arg removed and `getInternalAccount` and `onSelectedAccountChange` added in `TokenRatesController` - **ADDED**: `getAccountAction` added in`TokensController` - **BREAKING**: Changed `selectedAddress` to `selectedAccountId` and `PreferencesControllerStateChangeEvent` to `AccountsControllerSelectedEvmAccountChangeEvent` in the `TokensController` - **ADDED**: `getAccountAction` added in`TokensController` ## 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

montelaidev force-pushed the fix/ap381/update-tokens-controllers-to-use-internal-accounts branch from 78ef3b5 to 6c0595dCompare April 29, 2024 08:24

refactor: selectedAddress to selectedAccountId
1e319a0

montelaidev force-pushed the fix/ap381/update-tokens-controllers-to-use-internal-accounts branch from cb17e99 to 1e319a0Compare June 5, 2024 12:51

montelaidev self-assigned this Jun 5, 2024

montelaidev added the team-accounts label Jun 5, 2024

montelaidev added 3 commits June 6, 2024 00:09

fix: add more tests
c8ac590

fix: lower branch coverage
87b6a32

Merge branch 'main' into fix/ap381/update-tokens-controllers-to-use-i…
b58e44c
…nternal-accounts

montelaidev marked this pull request as ready for review June 5, 2024 16:11

montelaidev requested review from a team, ccharly and gantunesr June 5, 2024 16:11

mcmire reviewed Jun 5, 2024
View reviewed changes

mcmire mentioned this pull request Jun 5, 2024
upgrade TokenRatesController to BaseControllerV2 #4314
Merged
3 tasks

gantunesr reviewed Jun 6, 2024
View reviewed changes

montelaidev added 9 commits June 8, 2024 00:05

Merge remote-tracking branch 'origin/main' into fix/ap381/update-toke…
b853f09
…ns-controllers-to-use-internal-accounts

refactor: token detection test
22ee782

refactor: token balances test
f8d1303

refactor: token rates tests
5800381

Merge remote-tracking branch 'origin/main' into fix/ap381/update-toke…
9253b27
…ns-controllers-to-use-internal-accounts

fix: test
d38c696

refactor: TokensController to not require selectedAccountId in constr…
03aac22
…uctor

fix: lint
5f3f15b

fix: test names
b0f09ea

montelaidev requested a review from gantunesr June 14, 2024 07:37

ccharly reviewed Jun 14, 2024
View reviewed changes

refactor: create new helper
fd652a3

montelaidev mentioned this pull request Jun 18, 2024
Master pr for ap381 #4291
Closed

ccharly reviewed Jun 18, 2024
View reviewed changes

montelaidev added 2 commits June 18, 2024 18:41

fix: remove empty line
e3d389b

refactor: variable names and helper method
63c2b82

ccharly reviewed Jun 18, 2024
View reviewed changes

montelaidev added 3 commits June 18, 2024 21:13

refactor: use helper
8882ab2

Merge remote-tracking branch 'origin/main' into fix/ap381/update-toke…
e7f0888
…ns-controllers-to-use-internal-accounts

fix: test
8ab89f2

ccharly reviewed Jun 20, 2024
View reviewed changes

Comment threadpackages/assets-controllers/src/TokenDetectionController.ts Outdated
Comment threadpackages/assets-controllers/src/TokenDetectionController.ts Outdated
Comment threadpackages/assets-controllers/src/TokenRatesController.test.ts Outdated

montelaidev added 2 commits June 20, 2024 16:40

fix: test name
12814e7

feat: add #getSelectedAddress helper
1c40133

ccharly reviewed Jun 20, 2024
View reviewed changes

Comment threadpackages/assets-controllers/src/TokenRatesController.ts Outdated

montelaidev added 2 commits June 20, 2024 16:44

refactor: create const to be used in getTOkenAddresses
58d8a42

fix: reduce getAccountHandler calls
c7805b9

ccharly reviewed Jun 20, 2024
View reviewed changes

fix: refactor test vars
692d1c2

ccharly approved these changes Jun 20, 2024
View reviewed changes

Merge branch 'main' into fix/ap381/update-tokens-controllers-to-use-i…
82cf639
…nternal-accounts

montelaidev merged commit ca683e8 into mainJun 20, 2024

montelaidev deleted the fix/ap381/update-tokens-controllers-to-use-internal-accounts branch June 20, 2024 13:18

montelaidev mentioned this pull request Jun 25, 2024
Release/166.0.0 #4460
Merged
3 tasks

sahar-fehri mentioned this pull request Sep 20, 2024
fix: fix detect tokens performance MetaMask/metamask-mobile#11321
Merged
7 tasks

mcmire mentioned this pull request Apr 29, 2026
Enable PR link validation in changelogs by default #8637
Draft
4 tasks

Uh oh!

Uh oh!

Conversation

montelaidev commented Apr 26, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

@metamask/assets-controllers

Checklist

Uh oh!

montelaidev commented Apr 26, 2024

Uh oh!

montelaidev commented Apr 29, 2024

Uh oh!

montelaidev commented Apr 29, 2024

Uh oh!

github-actionsBot commented Apr 29, 2024

Uh oh!

montelaidev commented Apr 30, 2024

Uh oh!

mcmireJun 5, 2024

Choose a reason for hiding this comment

Uh oh!

mcmireJun 5, 2024

Choose a reason for hiding this comment

Uh oh!

mcmireJun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ccharlyJun 14, 2024

Choose a reason for hiding this comment

Uh oh!

ccharlyJun 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ccharlyJun 18, 2024

Choose a reason for hiding this comment

Uh oh!

montelaidev commented Jun 18, 2024

Uh oh!

github-actionsBot commented Jun 18, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ccharly left a comment

Choose a reason for hiding this comment

montelaidev commented Apr 26, 2024•
edited
Loading

`@metamask/assets-controllers`