fix: update transaction controllers to use selected account #4244
Conversation
This file contains 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
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
montelaidev
force-pushed
the
fix/ap381/update-transaction-controllers-to-use-selectedAccountId
branch
from
0e5df33
to
b874e4c
Compare
ccharly
reviewed
Jun 3, 2024
packages/transaction-controller/src/helpers/IncomingTransactionHelper.ts
Outdated
Show resolved
Hide resolved
montelaidev
changed the title
Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
ccharly
previously approved these changes
Jun 3, 2024
mcmire
reviewed
Jun 4, 2024
| @@ -1035,7 +1036,7 @@ export class TransactionController extends BaseController< | |||
| if (origin) { | |||
| await validateTransactionOrigin( | |||
| await this.getPermittedAccounts(origin), | |||
| this.getSelectedAddress(), | |||
| this.getSelectedAccount().address, | |||
There was a problem hiding this comment.
It looks like this controller takes a function that allows for getting the currently selected account. However, this is an old pattern and we are slowly trying to move all controllers to use the messenger pattern for intercommunication.
Since you're making a breaking change anyway, what are your thoughts on extending the TransactionControllerMessenger to allow the AccountsController:getSelectedAccount action? You can do this by importing AccountsControllerGetSelectedAccountAction from @metamask/accounts-controller and adding it to AllowedActions. Then you can remove the getSelectedAccount option from the constructor altogether and replace this line with:
Suggested change
| this.getSelectedAccount().address, | |
| this.messagingSystem.call('AccountsController:getSelectedAccount').address, |
legobeat
reviewed
Jun 4, 2024
| @@ -52,6 +52,7 @@ | |||
| "@metamask/controller-utils": "^11.0.0", | |||
| "@metamask/eth-query": "^4.0.0", | |||
| "@metamask/gas-fee-controller": "^17.0.0", | |||
| "@metamask/keyring-api": "6.4.0", | |||
There was a problem hiding this comment.
Noting that this is a type-only import and not under peerDependencies, this is a something that could be moved to devDependencies?
(If strict compatibility with the imported class is required, that indicates to me that it could also be a candidate for peerDependencies, if introducing that requirement here is indeed intended)
There was a problem hiding this comment.
Looking at the emitted type declaration file, it looks like the @metamask/keyring-api shows up there, so I believe this needs to be in dependencies, not devDependencies or peerDependencies so that it doesn't create a TypeScript error on build. Right?
There was a problem hiding this comment.
Unrelated, it looks like this is missing a ^:
Suggested change
| "@metamask/keyring-api": "6.4.0", | |
| "@metamask/keyring-api": "^6.4.0", |
There was a problem hiding this comment.
@mcmire I may be missing something but it seems to me that if we just consider the peerDependencies aspect in isolation, it should also be here.
And if the peerDependencies is satisifed, then there should be no TypeScript error on build, and therefore no need for dependencies since the types will be provided by the peerDependencies entry?
There was a problem hiding this comment.
I'm thinking if it's not added in peerDependencies, using code may run the risk of getting inconsistent type-checking results or plain incompatibilities, due to using the wrong version of @metamask/keyring-api for its type-checking?
Specifically here, it would be wrt the getSelectedAccount constructor option.
There was a problem hiding this comment.
I've removed the callback and used the messaging system instead to get the selected account. @metamask/keyring-api can just be a dev dependency for the tests.
This was referenced Jun 5, 2024
…use-selectedAccountId
ccharly
reviewed
Jun 6, 2024
packages/transaction-controller/src/TransactionControllerIntegration.test.ts
Outdated
Show resolved
Hide resolved
packages/transaction-controller/src/TransactionControllerIntegration.test.ts
Outdated
Show resolved
Hide resolved
…use-selectedAccountId
…use-selectedAccountId
ccharly
approved these changes
Jun 7, 2024
ccharly
reviewed
Jun 7, 2024
| @@ -99,6 +143,11 @@ const setupController = async ( | |||
| givenOptions: Partial< | |||
| ConstructorParameters<typeof TransactionController>[0] | |||
| > = {}, | |||
| mockData: { | |||
There was a problem hiding this comment.
Nit: We named it mocks in our previous PRs! So we could rename it if you want
…use-selectedAccountId
montelaidev
deleted the
fix/ap381/update-transaction-controllers-to-use-selectedAccountId
branch
legobeat
pushed a commit
that referenced
this pull request
Jun 11, 2024
This pr updates the transaction controller to use account id from the InternalAccount instead of an address Related to MetaMask/accounts-planning#381 - **BREAKING**: `getSelectedAddress` is replaced with `getSelectedAccount` in the `TransactionController` - **BREAKING**: `getCurrentAccount` returns an `InternalAccount` instead of a `string` in the `IncomingTransactionHelper` - [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 Fixes MetaMask/accounts-planning#381 --------- Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
legobeat
pushed a commit
that referenced
this pull request
Jun 11, 2024
This pr updates the transaction controller to use account id from the InternalAccount instead of an address Related to MetaMask/accounts-planning#381 - **BREAKING**: `getSelectedAddress` is replaced with `getSelectedAccount` in the `TransactionController` - **BREAKING**: `getCurrentAccount` returns an `InternalAccount` instead of a `string` in the `IncomingTransactionHelper` - [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 Fixes MetaMask/accounts-planning#381 --------- Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
legobeat
pushed a commit
that referenced
this pull request
Jun 11, 2024
This pr updates the transaction controller to use account id from the InternalAccount instead of an address Related to MetaMask/accounts-planning#381 - **BREAKING**: `getSelectedAddress` is replaced with `getSelectedAccount` in the `TransactionController` - **BREAKING**: `getCurrentAccount` returns an `InternalAccount` instead of a `string` in the `IncomingTransactionHelper` - [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 Fixes MetaMask/accounts-planning#381 --------- Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 25, 2024
The `@metamask/transaction-controller` package has been updated from v32 to v34. The `@metamask/user-operation-controller` package had to be bumped as well to avoid new peer dependency warnings. Primarily the only breaking changes in these ranges were peer dependency updates and an update to the minimum supported Node.js version. The new peer dependencies did not introduce any new warnings, they are all met. This update has resolved some pre-existing peer dependency warnings. The only functional change required was this update to the TransactionController in v33.0.0: ``` - **BREAKING:** The `TransactionController` messenger must now allow the `AccountsController:getSelectedAccount` action ([#4244](MetaMask/core#4244)) ... - **BREAKING:** Remove `getSelectedAddress` option from `TransactionController` ([#4244](MetaMask/core#4244)) - The AccountsController is used to get the currently selected address automatically. ``` That change has been applied. See the full changelogs here: * [`@metamask/transaction-controller`](https://github.com/MetaMask/core/blob/%40metamask/transaction-controller%4034.0.0/packages/transaction-controller/CHANGELOG.md) * [`@metamask/user-operation-controller`](https://github.com/MetaMask/core/blob/%40metamask/user-operation-controller%4013.0.0/packages/user-operation-controller/CHANGELOG.md) This helps unblock #9372
Gudahtt
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jul 25, 2024
## **Description** The `@metamask/transaction-controller` package has been updated from v32 to v34. The `@metamask/user-operation-controller` package had to be bumped as well to avoid new peer dependency warnings. Primarily the only breaking changes in these ranges were peer dependency updates and an update to the minimum supported Node.js version. The new peer dependencies did not introduce any new warnings, they are all met. This update has resolved some pre-existing peer dependency warnings. The only functional change required was this update to the TransactionController in v33.0.0: ``` - **BREAKING:** The `TransactionController` messenger must now allow the `AccountsController:getSelectedAccount` action ([#4244](MetaMask/core#4244)) ... - **BREAKING:** Remove `getSelectedAddress` option from `TransactionController` ([#4244](MetaMask/core#4244)) - The AccountsController is used to get the currently selected address automatically. ``` That change has been applied. See the full changelogs here: * [`@metamask/transaction-controller`](https://github.com/MetaMask/core/blob/%40metamask/transaction-controller%4034.0.0/packages/transaction-controller/CHANGELOG.md) * [`@metamask/user-operation-controller`](https://github.com/MetaMask/core/blob/%40metamask/user-operation-controller%4013.0.0/packages/user-operation-controller/CHANGELOG.md) [](https://codespaces.new/MetaMask/metamask-extension/pull/26124?quickstart=1) ## **Related issues** This helps unblock #9372 ## **Manual testing steps** N/A ## **Screenshots/Recordings** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. --------- Co-authored-by: MetaMask Bot <metamaskbot@users.noreply.github.com>
](https://codespaces.new/MetaMask/metamask-extension/pull/26124?quickstart=1){kind=link}
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
This pr updates the transaction controller to use account id from the InternalAccount instead of an address
References
Related to https://github.com/MetaMask/accounts-planning/issues/381
Changelog
@metamask/transaction-controllergetSelectedAddressis replaced withgetSelectedAccountin theTransactionControllergetCurrentAccountreturns anInternalAccountinstead of astringin theIncomingTransactionHelperChecklist
Fixes https://github.com/MetaMask/accounts-planning/issues/381