chore: upgrade transaction controller to 35.0.0 #10263

matthewwalsh0 · 2024-07-06T17:26:27Z

Description

Upgrade the TransactionController from version 13.0.0 to 35.0.0.

Upgrade the ApprovalController from version 3.5.2 to 7.0.1.

Since both controllers are now at the latest version, the patches contain only the changes that are unique to mobile and not yet added to the main core branch.

See TransactionController patch here.

See ApprovalController patch here.

The following changes are included, organised by TransactionController version:

33.0.0

Added the AccountsController:getSelectedAccount action to the TransactionController messenger.
Removed the getSelectedAddress option in the TransactionController constructor.

29.0.0

Removed the gasFeeControllerEstimateType option from call to mergeGasFeeEstimates.

27.0.0

Disable resubmit via pendingTransactions.isResubmitEnabled callback.

25.0.0

Replaced all hub event listeners with subscriptions via the controller messenger.
Added ExtendedControllerMessenger with helper methods:
- subscribeOnceIf
- tryUnsubscribe
Replaced references to TransactionState with TransactionControllerState.
Removed use of config object in TransactionController constructor.
Removed direct update of TransactionMeta from events as they are now read only.
- Replaced with cloneDeep and updateTransaction.
Prevent duplicate calls to onUnapprovedTransaction in RootRPCMethodsUI.js due to unstable dependencies.
- Add useSwapsTransactions hook.
- Use useCallback in useMetrics.
Remove imports from dist to access CHAIN_IDS and ETHERSCAN_SUPPORTED_NETWORKS.

23.0.0

Added getNetworkClientRegistry callback to TransactionController constructor.
Added NetworkController:stateChange event to controller messenger.

17.0.0

Disabled direct swaps integration with disableSwaps option in TransactionController constructor.
Removed usage of legacy type clashing with gas fee & type validation:
- SET_INDIVIDUAL_TOKEN_TRANSACTION
- ETHER_TRANSACTION'
Cleared overlapping gas properties in transaction parameters to satisfy new gas fee validations.

14.0.0

Added getPermittedAccounts option to TransactionController constructor.
Updated getPermittedAccounts implementation to always allow internal origins:
- process.env.MM_FOX_CODE
- TransactionTypes.MMM

Related issues

Fixes: [Pending]

Manual testing steps

Full regression of all transaction flows, including:

Standard Transactions
Swaps
Smart Transactions
Gas Fee Update
Speed Up / Cancel
Layer 1 Fees

Screenshots/Recordings

Before

After

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

Fix swaps gas. Fix send origin. Use failed listener for notification errors. Always permit selected address for internal origins.

socket-security · 2024-07-10T19:52:51Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`+8`	2.12 MB	metamaskbot
npm/@metamask/[email protected]	None	`+7`	1.18 MB	metamaskbot
npm/@metamask/[email protected]	Transitive: environment	`+28`	4.54 MB	metamaskbot
npm/@metamask/[email protected]	None	`+6`	1.04 MB	metamaskbot
npm/@metamask/[email protected]	network Transitive: environment, filesystem	`+64`	14.2 MB	metamaskbot
npm/[email protected]	None	`0`	639 kB	pimterry

🚮 Removed packages: npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected]

View full report↗︎

socket-security · 2024-07-10T19:52:54Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/@keystonehq/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

matthewwalsh0 · 2024-07-11T07:18:51Z

@SocketSecurity ignore-all

github-actions · 2024-07-16T12:06:24Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 387304a
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/179e64d4-6e93-40b7-a34d-0e2360da32d0

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

matthewwalsh0 · 2024-07-16T13:49:08Z

Regression Tests

tommasini

This PR is amazing!! Thanks @matthewwalsh0
Left just one comment about the anys in the Engine file!

I have also a question, since we are on the latest version of transaction controller and approval controller, when do you think it will be possible to remove the patches completely?

tommasini · 2024-07-16T16:20:46Z

app/core/Engine.ts

      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
      // @ts-ignore
      getExternalPendingTransactions: (address: string) =>
        this.smartTransactionsController.getTransactions({
          addressFrom: address,
          status: SmartTransactionStatuses.PENDING,
        }),
-
+      sign: (transaction, from, transactionMeta) =>


Instead of any, should we type it as Transaction instead? Also I see TransactionController as any as well, wondering if we could type as TransactionController (if that makes sense)

Done, just did a bind to the method directly and cast to the correct type.

Enable simulation.

matthewwalsh0 · 2024-07-17T08:20:30Z

This PR is amazing!! Thanks @matthewwalsh0 Left just one comment about the anys in the Engine file!

I have also a question, since we are on the latest version of transaction controller and approval controller, when do you think it will be possible to remove the patches completely?

Thanks Tomas! I'd love to remove both patches as soon as possible once this branch is merged, since I didn't want to delay this work or introduce any more risk and change that would need to be tested.

pedronfigueiredo

LGTM!

sonarcloud · 2024-07-17T12:52:10Z

Quality Gate failed

Failed conditions
35.0% Coverage on New Code (required ≥ 40%)

See analysis details on SonarCloud

sleepytanya · 2024-07-18T04:34:41Z

@matthewwalsh0
Error when confirming test dapp transactions - Invalid transaction envelope type: specified type "0x0" but including maxFeePerGas and maxPriorityFeePerGas requires type: "0x2"

iphone.mov

matthewwalsh0 added 9 commits July 4, 2024 13:31

Update patch and address breaking changes

74eed6c

Update patch script

40823db

Add getGlobalEthQuery method

7a83f6c

Upgrade patch to 33.0.1

ccb95a8

Fix submit history update

cc48624

Add tryUnsubscribe method

e451c64

Fix swaps gas. Fix send origin. Use failed listener for notification errors. Always permit selected address for internal origins.

Fix initial unit tests

1bd50cb

Fix unit tests

65753eb

Merge branch 'main' into chore/upgrade-transaction-controller-33-0-1

f6d63d3

matthewwalsh0 added the team-confirmations Push issues to confirmations team label Jul 10, 2024

matthewwalsh0 added 3 commits July 10, 2024 21:55

Fix patches

bda1c50

Fix duplication and linting

649d33c

Fix unit test

19b720c

matthewwalsh0 added the Run Smoke E2E Triggers smoke e2e on Bitrise label Jul 11, 2024

Merge branch 'main' into chore/upgrade-transaction-controller-33-0-1

f36a519

matthewwalsh0 added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 11, 2024

Fix linting

51eb8ed

matthewwalsh0 added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 11, 2024

matthewwalsh0 added 4 commits July 13, 2024 07:51

Fix allowance E2E test

899e07d

Fix confirmation E2E tests

64bac9e

Merge branch 'main' into chore/upgrade-transaction-controller-33-0-1

4689287

Fix yarn lock

eb927a4

matthewwalsh0 added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 15, 2024

Add unit tests for extended controller messenger

5c42375

Upgrade to version 35

55f350a

matthewwalsh0 changed the title ~~chore: upgrade transaction controller to 33.0.1~~ chore: upgrade transaction controller to 35.0.0 Jul 16, 2024

Upgrade approval controller to 7.0.1

387304a

matthewwalsh0 added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Jul 16, 2024

MetaMask deleted a comment from github-actions bot Jul 16, 2024

matthewwalsh0 marked this pull request as ready for review July 16, 2024 12:41

matthewwalsh0 requested review from a team as code owners July 16, 2024 12:41

tommasini reviewed Jul 16, 2024

View reviewed changes

Add nonce tracker patch

0090cc8

Enable simulation.

pedronfigueiredo previously approved these changes Jul 17, 2024

View reviewed changes

Merge branch 'main' into chore/upgrade-transaction-controller-33-0-1

0d935d3

matthewwalsh0 dismissed pedronfigueiredo’s stale review via 0d935d3 July 17, 2024 12:38

vinistevam approved these changes Jul 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: upgrade transaction controller to 35.0.0 #10263

chore: upgrade transaction controller to 35.0.0 #10263

matthewwalsh0 commented Jul 6, 2024 •

edited

Loading

socket-security bot commented Jul 10, 2024 •

edited

Loading

socket-security bot commented Jul 10, 2024 •

edited

Loading

matthewwalsh0 commented Jul 11, 2024

github-actions bot commented Jul 16, 2024 •

edited by metamaskbot

Loading

matthewwalsh0 commented Jul 16, 2024

tommasini left a comment

tommasini Jul 16, 2024

matthewwalsh0 Jul 16, 2024

matthewwalsh0 commented Jul 17, 2024

pedronfigueiredo left a comment

sonarcloud bot commented Jul 17, 2024

sleepytanya commented Jul 18, 2024

chore: upgrade transaction controller to 35.0.0 #10263

Are you sure you want to change the base?

chore: upgrade transaction controller to 35.0.0 #10263

Conversation

matthewwalsh0 commented Jul 6, 2024 • edited Loading

Description

33.0.0

29.0.0

27.0.0

25.0.0

23.0.0

17.0.0

14.0.0

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

socket-security bot commented Jul 10, 2024 • edited Loading

socket-security bot commented Jul 10, 2024 • edited Loading

Next steps

matthewwalsh0 commented Jul 11, 2024

github-actions bot commented Jul 16, 2024 • edited by metamaskbot Loading

Bitrise

matthewwalsh0 commented Jul 16, 2024

tommasini left a comment

Choose a reason for hiding this comment

tommasini Jul 16, 2024

Choose a reason for hiding this comment

matthewwalsh0 Jul 16, 2024

Choose a reason for hiding this comment

matthewwalsh0 commented Jul 17, 2024

pedronfigueiredo left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Jul 17, 2024

Quality Gate failed

sleepytanya commented Jul 18, 2024

matthewwalsh0 commented Jul 6, 2024 •

edited

Loading

socket-security bot commented Jul 10, 2024 •

edited

Loading

socket-security bot commented Jul 10, 2024 •

edited

Loading

github-actions bot commented Jul 16, 2024 •

edited by metamaskbot

Loading