fix: update transaction controllers to use selected account #4244
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,8 @@ import { | |
| InfuraNetworkType, | ||
| NetworkType, | ||
| } from '@metamask/controller-utils'; | ||
| import type { InternalAccount } from '@metamask/keyring-api'; | ||
| import { EthAccountType, EthMethod } from '@metamask/keyring-api'; | ||
| import { | ||
| NetworkController, | ||
| NetworkClientType, | ||
|
|
@@ -25,6 +27,7 @@ import assert from 'assert'; | |
| import nock from 'nock'; | ||
| import type { SinonFakeTimers } from 'sinon'; | ||
| import { useFakeTimers } from 'sinon'; | ||
| import { v4 } from 'uuid'; | ||
|
|
||
| import { advanceTime } from '../../../tests/helpers'; | ||
| import { mockNetwork } from '../../../tests/mock-network'; | ||
|
|
@@ -64,7 +67,46 @@ type UnrestrictedControllerMessenger = ControllerMessenger< | |
| | TransactionControllerEvents | ||
| >; | ||
|
|
||
| const createMockInternalAccount = ({ | ||
| id = v4(), | ||
| address = '0x2990079bcdee240329a520d2444386fc119da21a', | ||
| name = 'Account 1', | ||
| importTime = Date.now(), | ||
| lastSelected = Date.now(), | ||
| }: { | ||
| id?: string; | ||
| address?: string; | ||
| name?: string; | ||
| importTime?: number; | ||
| lastSelected?: number; | ||
| } = {}): InternalAccount => { | ||
| return { | ||
| id, | ||
| address, | ||
| options: {}, | ||
| methods: [ | ||
| EthMethod.PersonalSign, | ||
| EthMethod.Sign, | ||
| EthMethod.SignTransaction, | ||
| EthMethod.SignTypedDataV1, | ||
| EthMethod.SignTypedDataV3, | ||
| EthMethod.SignTypedDataV4, | ||
| ], | ||
| type: EthAccountType.Eoa, | ||
| metadata: { | ||
| name, | ||
| keyring: { type: 'HD Key Tree' }, | ||
| importTime, | ||
| lastSelected, | ||
| }, | ||
| } as InternalAccount; | ||
| }; | ||
|
|
||
| const ACCOUNT_MOCK = '0x6bf137f335ea1b8f193b8f6ea92561a60d23a207'; | ||
| const INTERNAL_ACCOUNT_MOCK = createMockInternalAccount({ | ||
| address: ACCOUNT_MOCK, | ||
| }); | ||
|
|
||
| const ACCOUNT_2_MOCK = '0x08f137f335ea1b8f193b8f6ea92561a60d23a211'; | ||
| const ACCOUNT_3_MOCK = '0xe688b84b23f322a994a53dbf8e15fa82cdb71127'; | ||
| const infuraProjectId = 'fake-infura-project-id'; | ||
|
|
@@ -167,7 +209,8 @@ const setupController = async ( | |
| getNetworkClientRegistry: | ||
| networkController.getNetworkClientRegistry.bind(networkController), | ||
| getPermittedAccounts: async () => [ACCOUNT_MOCK], | ||
| getSelectedAccount: () => | ||
| createMockInternalAccount({ address: '0xdeadbeef' }), | ||
| hooks: {}, | ||
| isMultichainEnabled: false, | ||
| messenger, | ||
|
|
@@ -802,7 +845,7 @@ describe('TransactionController Integration', () => { | |
| await setupController({ | ||
| isMultichainEnabled: true, | ||
| getPermittedAccounts: async () => [ACCOUNT_MOCK], | ||
| getSelectedAccount: () => INTERNAL_ACCOUNT_MOCK, | ||
| }); | ||
| const otherNetworkClientIdOnGoerli = | ||
| await networkController.upsertNetworkConfiguration( | ||
|
|
@@ -883,7 +926,7 @@ describe('TransactionController Integration', () => { | |
| await setupController({ | ||
| isMultichainEnabled: true, | ||
| getPermittedAccounts: async () => [ACCOUNT_MOCK], | ||
| getSelectedAccount: () => INTERNAL_ACCOUNT_MOCK, | ||
| }); | ||
|
|
||
| const addTx1 = await transactionController.addTransaction( | ||
|
|
@@ -1140,10 +1183,13 @@ describe('TransactionController Integration', () => { | |
| }); | ||
|
|
||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { networkController, transactionController } = | ||
| await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| isMultichainEnabled: true, | ||
| }); | ||
|
|
||
|
|
@@ -1209,6 +1255,9 @@ describe('TransactionController Integration', () => { | |
|
|
||
| it('should start the global incoming transaction helper when no networkClientIds provided', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| mockNetwork({ | ||
| networkClientConfiguration: buildInfuraNetworkClientConfiguration( | ||
|
|
@@ -1226,7 +1275,7 @@ describe('TransactionController Integration', () => { | |
| .reply(200, ETHERSCAN_TRANSACTION_RESPONSE_MOCK); | ||
|
|
||
| const { transactionController } = await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| }); | ||
|
|
||
| transactionController.startIncomingTransactionPolling(); | ||
|
|
@@ -1314,10 +1363,13 @@ describe('TransactionController Integration', () => { | |
| }); | ||
|
|
||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { networkController, transactionController } = | ||
| await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| isMultichainEnabled: true, | ||
| }); | ||
|
|
||
|
|
@@ -1410,10 +1462,13 @@ describe('TransactionController Integration', () => { | |
| describe('stopIncomingTransactionPolling', () => { | ||
| it('should not poll for new incoming transactions for the given networkClientId', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { networkController, transactionController } = | ||
| await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| }); | ||
|
|
||
| const networkClients = networkController.getNetworkClientRegistry(); | ||
|
|
@@ -1454,9 +1509,12 @@ describe('TransactionController Integration', () => { | |
|
|
||
| it('should stop the global incoming transaction helper when no networkClientIds provided', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { transactionController } = await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| }); | ||
|
|
||
| mockNetwork({ | ||
|
|
@@ -1490,10 +1548,13 @@ describe('TransactionController Integration', () => { | |
| describe('stopAllIncomingTransactionPolling', () => { | ||
| it('should not poll for incoming transactions on any network client', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { networkController, transactionController } = | ||
| await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| }); | ||
|
|
||
| const networkClients = networkController.getNetworkClientRegistry(); | ||
|
|
@@ -1534,10 +1595,13 @@ describe('TransactionController Integration', () => { | |
| describe('updateIncomingTransactions', () => { | ||
| it('should add incoming transactions to state with the correct chainId for the given networkClientId without waiting for the next block', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { networkController, transactionController } = | ||
| await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| isMultichainEnabled: true, | ||
| }); | ||
|
|
||
|
|
@@ -1600,9 +1664,12 @@ describe('TransactionController Integration', () => { | |
|
|
||
| it('should update the incoming transactions for the gloablly selected network when no networkClientIds provided', async () => { | ||
| const selectedAddress = ETHERSCAN_TRANSACTION_BASE_MOCK.to; | ||
| const selectedAccountMock = createMockInternalAccount({ | ||
| address: selectedAddress, | ||
| }); | ||
|
|
||
| const { transactionController } = await setupController({ | ||
| getSelectedAccount: () => selectedAccountMock, | ||
| }); | ||
|
|
||
| mockNetwork({ | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,21 @@ const BLOCK_TRACKER_MOCK = { | |
|
|
||
| const CONTROLLER_ARGS_MOCK = { | ||
| blockTracker: BLOCK_TRACKER_MOCK, | ||
| getCurrentAccount: () => { | ||
| return { | ||
| id: '58def058-d35f-49a1-a7ab-e2580565f6f5', | ||
| address: ADDRESS_MOCK, | ||
| type: 'eip155:eoa' as const, | ||
| options: {}, | ||
| methods: [], | ||
| metadata: { | ||
| name: 'Account 1', | ||
| keyring: { type: 'HD Key Tree' }, | ||
| importTime: 1631619180000, | ||
| lastSelected: 1631619180000, | ||
| }, | ||
| }; | ||
| }, | ||
| getLastFetchedBlockNumbers: () => ({}), | ||
| getChainId: () => CHAIN_ID_MOCK, | ||
| remoteTransactionSource: {} as RemoteTransactionSource, | ||
|
|
@@ -546,7 +560,8 @@ describe('IncomingTransactionHelper', () => { | |
| remoteTransactionSource: createRemoteTransactionSourceMock([ | ||
| TRANSACTION_MOCK_2, | ||
| ]), | ||
| // @ts-expect-error testing undefined | ||
| getCurrentAccount: () => undefined, | ||
| }); | ||
|
|
||
| const { blockNumberListener } = await emitBlockTrackerLatestEvent( | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noting that this is a type-only import and not under
peerDependencies, this is a something that could be moved todevDependencies?(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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the emitted type declaration file, it looks like the
@metamask/keyring-apishows up there, so I believe this needs to be independencies, notdevDependenciesorpeerDependenciesso that it doesn't create a TypeScript error on build. Right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated, it looks like this is missing a
^:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mcmire I may be missing something but it seems to me that if we just consider the
peerDependenciesaspect in isolation, it should also be here.And if the
peerDependenciesis satisifed, then there should be no TypeScript error on build, and therefore no need fordependenciessince the types will be provided by thepeerDependenciesentry?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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-apifor its type-checking?Specifically here, it would be wrt the
getSelectedAccountconstructor option.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed the callback and used the messaging system instead to get the selected account.
@metamask/keyring-apican just be a dev dependency for the tests.