Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Re-simulate active transactions every 3000 ms #5189

Merged
merged 50 commits into from
Feb 13, 2025
Merged

feat: Re-simulate active transactions every 3000 ms #5189

merged 50 commits into from
Feb 13, 2025

Conversation

OGPoyraz
Copy link
Member

@OGPoyraz OGPoyraz commented Jan 23, 2025 •
edited
Loading

Explanation

This PR adds ResimulateHelper, which focuses on transactionMeta.isActive property and re-simulates transaction depending on that value.

In order to capsulate re-simulation logic, this PR also relocates other utility functions under the new created ResimulationHelper.ts file.

References

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3922
Extension PR: MetaMask/metamask-extension#29878

Changelog

@metamask/transaction-controller

  • ADDED: Adds ability of re-simulating transaction depending on the isActive property on transactionMeta
    • isActive property is expected to set by client.
    • Re-simulation of transactions will occur every 3 seconds if isActive is true.
  • Adds setTransactionActive function to update the isActive property on transactionMeta.

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
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@OGPoyraz
Copy link
Member Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

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": "21.0.2-preview-9df90b5",
  "@metamask-previews/address-book-controller": "6.0.2-preview-9df90b5",
  "@metamask-previews/announcement-controller": "7.0.2-preview-9df90b5",
  "@metamask-previews/approval-controller": "7.1.2-preview-9df90b5",
  "@metamask-previews/assets-controllers": "46.0.1-preview-9df90b5",
  "@metamask-previews/base-controller": "7.1.1-preview-9df90b5",
  "@metamask-previews/build-utils": "3.0.2-preview-9df90b5",
  "@metamask-previews/composable-controller": "10.0.0-preview-9df90b5",
  "@metamask-previews/controller-utils": "11.4.5-preview-9df90b5",
  "@metamask-previews/ens-controller": "15.0.1-preview-9df90b5",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-9df90b5",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-9df90b5",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-9df90b5",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-9df90b5",
  "@metamask-previews/keyring-controller": "19.0.4-preview-9df90b5",
  "@metamask-previews/logging-controller": "6.0.3-preview-9df90b5",
  "@metamask-previews/message-manager": "12.0.0-preview-9df90b5",
  "@metamask-previews/multichain": "2.1.0-preview-9df90b5",
  "@metamask-previews/multichain-transactions-controller": "0.0.1-preview-9df90b5",
  "@metamask-previews/name-controller": "8.0.2-preview-9df90b5",
  "@metamask-previews/network-controller": "22.1.1-preview-9df90b5",
  "@metamask-previews/notification-services-controller": "0.16.0-preview-9df90b5",
  "@metamask-previews/permission-controller": "11.0.5-preview-9df90b5",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-9df90b5",
  "@metamask-previews/phishing-controller": "12.3.1-preview-9df90b5",
  "@metamask-previews/polling-controller": "12.0.2-preview-9df90b5",
  "@metamask-previews/preferences-controller": "15.0.1-preview-9df90b5",
  "@metamask-previews/profile-sync-controller": "4.1.1-preview-9df90b5",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-9df90b5",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-9df90b5",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-9df90b5",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-9df90b5",
  "@metamask-previews/signature-controller": "23.2.0-preview-9df90b5",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-9df90b5",
  "@metamask-previews/transaction-controller": "43.0.0-preview-9df90b5",
  "@metamask-previews/user-operation-controller": "22.0.0-preview-9df90b5"
}

@OGPoyraz
Copy link
Member Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

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": "21.0.2-preview-4dd7520a",
  "@metamask-previews/address-book-controller": "6.0.2-preview-4dd7520a",
  "@metamask-previews/announcement-controller": "7.0.2-preview-4dd7520a",
  "@metamask-previews/approval-controller": "7.1.2-preview-4dd7520a",
  "@metamask-previews/assets-controllers": "46.0.1-preview-4dd7520a",
  "@metamask-previews/base-controller": "7.1.1-preview-4dd7520a",
  "@metamask-previews/build-utils": "3.0.2-preview-4dd7520a",
  "@metamask-previews/composable-controller": "10.0.0-preview-4dd7520a",
  "@metamask-previews/controller-utils": "11.4.5-preview-4dd7520a",
  "@metamask-previews/ens-controller": "15.0.1-preview-4dd7520a",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-4dd7520a",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-4dd7520a",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-4dd7520a",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-4dd7520a",
  "@metamask-previews/keyring-controller": "19.0.4-preview-4dd7520a",
  "@metamask-previews/logging-controller": "6.0.3-preview-4dd7520a",
  "@metamask-previews/message-manager": "12.0.0-preview-4dd7520a",
  "@metamask-previews/multichain": "2.1.0-preview-4dd7520a",
  "@metamask-previews/multichain-transactions-controller": "0.0.1-preview-4dd7520a",
  "@metamask-previews/name-controller": "8.0.2-preview-4dd7520a",
  "@metamask-previews/network-controller": "22.1.1-preview-4dd7520a",
  "@metamask-previews/notification-services-controller": "0.16.0-preview-4dd7520a",
  "@metamask-previews/permission-controller": "11.0.5-preview-4dd7520a",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-4dd7520a",
  "@metamask-previews/phishing-controller": "12.3.1-preview-4dd7520a",
  "@metamask-previews/polling-controller": "12.0.2-preview-4dd7520a",
  "@metamask-previews/preferences-controller": "15.0.1-preview-4dd7520a",
  "@metamask-previews/profile-sync-controller": "4.1.1-preview-4dd7520a",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-4dd7520a",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-4dd7520a",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-4dd7520a",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-4dd7520a",
  "@metamask-previews/signature-controller": "23.2.0-preview-4dd7520a",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-4dd7520a",
  "@metamask-previews/transaction-controller": "43.0.0-preview-4dd7520a",
  "@metamask-previews/user-operation-controller": "22.0.0-preview-4dd7520a"
}

@OGPoyraz OGPoyraz marked this pull request as ready for review January 24, 2025 12:47
@OGPoyraz OGPoyraz requested review from a team as code owners January 24, 2025 12:47
jpuri
jpuri previously approved these changes Jan 24, 2025
View reviewed changes
@OGPoyraz
Copy link
Member Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

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": "21.0.2-preview-f3d5e317",
  "@metamask-previews/address-book-controller": "6.0.2-preview-f3d5e317",
  "@metamask-previews/announcement-controller": "7.0.2-preview-f3d5e317",
  "@metamask-previews/approval-controller": "7.1.2-preview-f3d5e317",
  "@metamask-previews/assets-controllers": "46.0.1-preview-f3d5e317",
  "@metamask-previews/base-controller": "7.1.1-preview-f3d5e317",
  "@metamask-previews/build-utils": "3.0.2-preview-f3d5e317",
  "@metamask-previews/composable-controller": "10.0.0-preview-f3d5e317",
  "@metamask-previews/controller-utils": "11.4.5-preview-f3d5e317",
  "@metamask-previews/ens-controller": "15.0.1-preview-f3d5e317",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-f3d5e317",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-f3d5e317",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-f3d5e317",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-f3d5e317",
  "@metamask-previews/keyring-controller": "19.0.4-preview-f3d5e317",
  "@metamask-previews/logging-controller": "6.0.3-preview-f3d5e317",
  "@metamask-previews/message-manager": "12.0.0-preview-f3d5e317",
  "@metamask-previews/multichain": "2.1.0-preview-f3d5e317",
  "@metamask-previews/multichain-transactions-controller": "0.0.1-preview-f3d5e317",
  "@metamask-previews/name-controller": "8.0.2-preview-f3d5e317",
  "@metamask-previews/network-controller": "22.1.1-preview-f3d5e317",
  "@metamask-previews/notification-services-controller": "0.16.0-preview-f3d5e317",
  "@metamask-previews/permission-controller": "11.0.5-preview-f3d5e317",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-f3d5e317",
  "@metamask-previews/phishing-controller": "12.3.1-preview-f3d5e317",
  "@metamask-previews/polling-controller": "12.0.2-preview-f3d5e317",
  "@metamask-previews/preferences-controller": "15.0.1-preview-f3d5e317",
  "@metamask-previews/profile-sync-controller": "4.1.1-preview-f3d5e317",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-f3d5e317",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-f3d5e317",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-f3d5e317",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-f3d5e317",
  "@metamask-previews/signature-controller": "23.2.0-preview-f3d5e317",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-f3d5e317",
  "@metamask-previews/transaction-controller": "43.0.0-preview-f3d5e317",
  "@metamask-previews/user-operation-controller": "22.0.0-preview-f3d5e317"
}

@OGPoyraz OGPoyraz force-pushed the 3922-re-simulate-transactions-for-every-new-block branch from f159aea to ea69888 Compare January 29, 2025 12:57
@OGPoyraz
Copy link
Member Author

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

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": "21.0.2-preview-bd04b248",
  "@metamask-previews/address-book-controller": "6.0.2-preview-bd04b248",
  "@metamask-previews/announcement-controller": "7.0.2-preview-bd04b248",
  "@metamask-previews/approval-controller": "7.1.2-preview-bd04b248",
  "@metamask-previews/assets-controllers": "46.0.1-preview-bd04b248",
  "@metamask-previews/base-controller": "7.1.1-preview-bd04b248",
  "@metamask-previews/build-utils": "3.0.2-preview-bd04b248",
  "@metamask-previews/composable-controller": "10.0.0-preview-bd04b248",
  "@metamask-previews/controller-utils": "11.4.5-preview-bd04b248",
  "@metamask-previews/ens-controller": "15.0.1-preview-bd04b248",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-bd04b248",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-bd04b248",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-bd04b248",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-bd04b248",
  "@metamask-previews/keyring-controller": "19.0.4-preview-bd04b248",
  "@metamask-previews/logging-controller": "6.0.3-preview-bd04b248",
  "@metamask-previews/message-manager": "12.0.0-preview-bd04b248",
  "@metamask-previews/multichain": "2.1.0-preview-bd04b248",
  "@metamask-previews/multichain-transactions-controller": "0.0.1-preview-bd04b248",
  "@metamask-previews/name-controller": "8.0.2-preview-bd04b248",
  "@metamask-previews/network-controller": "22.1.1-preview-bd04b248",
  "@metamask-previews/notification-services-controller": "0.17.0-preview-bd04b248",
  "@metamask-previews/permission-controller": "11.0.5-preview-bd04b248",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-bd04b248",
  "@metamask-previews/phishing-controller": "12.3.1-preview-bd04b248",
  "@metamask-previews/polling-controller": "12.0.2-preview-bd04b248",
  "@metamask-previews/preferences-controller": "15.0.1-preview-bd04b248",
  "@metamask-previews/profile-sync-controller": "4.1.1-preview-bd04b248",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-bd04b248",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-bd04b248",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-bd04b248",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-bd04b248",
  "@metamask-previews/signature-controller": "23.2.0-preview-bd04b248",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-bd04b248",
  "@metamask-previews/transaction-controller": "43.0.0-preview-bd04b248",
  "@metamask-previews/user-operation-controller": "22.0.0-preview-bd04b248"
}

@OGPoyraz
Copy link
Member Author

OGPoyraz commented Feb 3, 2025

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 3, 2025

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": "22.0.0-preview-43593c4e",
  "@metamask-previews/address-book-controller": "6.0.2-preview-43593c4e",
  "@metamask-previews/announcement-controller": "7.0.2-preview-43593c4e",
  "@metamask-previews/approval-controller": "7.1.2-preview-43593c4e",
  "@metamask-previews/assets-controllers": "47.0.0-preview-43593c4e",
  "@metamask-previews/base-controller": "7.1.1-preview-43593c4e",
  "@metamask-previews/build-utils": "3.0.2-preview-43593c4e",
  "@metamask-previews/composable-controller": "10.0.0-preview-43593c4e",
  "@metamask-previews/controller-utils": "11.4.5-preview-43593c4e",
  "@metamask-previews/earn-controller": "0.0.0-preview-43593c4e",
  "@metamask-previews/ens-controller": "15.0.1-preview-43593c4e",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-43593c4e",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-43593c4e",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-43593c4e",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-43593c4e",
  "@metamask-previews/keyring-controller": "19.0.5-preview-43593c4e",
  "@metamask-previews/logging-controller": "6.0.3-preview-43593c4e",
  "@metamask-previews/message-manager": "12.0.0-preview-43593c4e",
  "@metamask-previews/multichain": "2.1.0-preview-43593c4e",
  "@metamask-previews/multichain-transactions-controller": "0.1.0-preview-43593c4e",
  "@metamask-previews/name-controller": "8.0.2-preview-43593c4e",
  "@metamask-previews/network-controller": "22.1.1-preview-43593c4e",
  "@metamask-previews/notification-services-controller": "0.18.0-preview-43593c4e",
  "@metamask-previews/permission-controller": "11.0.5-preview-43593c4e",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-43593c4e",
  "@metamask-previews/phishing-controller": "12.3.1-preview-43593c4e",
  "@metamask-previews/polling-controller": "12.0.2-preview-43593c4e",
  "@metamask-previews/preferences-controller": "15.0.1-preview-43593c4e",
  "@metamask-previews/profile-sync-controller": "5.0.0-preview-43593c4e",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-43593c4e",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-43593c4e",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-43593c4e",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-43593c4e",
  "@metamask-previews/signature-controller": "23.2.0-preview-43593c4e",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-43593c4e",
  "@metamask-previews/transaction-controller": "44.0.0-preview-43593c4e",
  "@metamask-previews/user-operation-controller": "23.0.0-preview-43593c4e"
}

@OGPoyraz OGPoyraz changed the title feat: Re-simulate focused transactions every 3000 ms feat: Re-simulate active transactions every 3000 ms Feb 3, 2025
@OGPoyraz
Copy link
Member Author

OGPoyraz commented Feb 3, 2025

@metamaskbot publish-preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 3, 2025

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": "22.0.0-preview-d21875e1",
  "@metamask-previews/address-book-controller": "6.0.2-preview-d21875e1",
  "@metamask-previews/announcement-controller": "7.0.2-preview-d21875e1",
  "@metamask-previews/approval-controller": "7.1.2-preview-d21875e1",
  "@metamask-previews/assets-controllers": "47.0.0-preview-d21875e1",
  "@metamask-previews/base-controller": "7.1.1-preview-d21875e1",
  "@metamask-previews/build-utils": "3.0.2-preview-d21875e1",
  "@metamask-previews/composable-controller": "10.0.0-preview-d21875e1",
  "@metamask-previews/controller-utils": "11.4.5-preview-d21875e1",
  "@metamask-previews/earn-controller": "0.0.0-preview-d21875e1",
  "@metamask-previews/ens-controller": "15.0.1-preview-d21875e1",
  "@metamask-previews/eth-json-rpc-provider": "4.1.7-preview-d21875e1",
  "@metamask-previews/gas-fee-controller": "22.0.2-preview-d21875e1",
  "@metamask-previews/json-rpc-engine": "10.0.2-preview-d21875e1",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.6-preview-d21875e1",
  "@metamask-previews/keyring-controller": "19.0.5-preview-d21875e1",
  "@metamask-previews/logging-controller": "6.0.3-preview-d21875e1",
  "@metamask-previews/message-manager": "12.0.0-preview-d21875e1",
  "@metamask-previews/multichain": "2.1.0-preview-d21875e1",
  "@metamask-previews/multichain-transactions-controller": "0.1.0-preview-d21875e1",
  "@metamask-previews/name-controller": "8.0.2-preview-d21875e1",
  "@metamask-previews/network-controller": "22.1.1-preview-d21875e1",
  "@metamask-previews/notification-services-controller": "0.18.0-preview-d21875e1",
  "@metamask-previews/permission-controller": "11.0.5-preview-d21875e1",
  "@metamask-previews/permission-log-controller": "3.0.2-preview-d21875e1",
  "@metamask-previews/phishing-controller": "12.3.1-preview-d21875e1",
  "@metamask-previews/polling-controller": "12.0.2-preview-d21875e1",
  "@metamask-previews/preferences-controller": "15.0.1-preview-d21875e1",
  "@metamask-previews/profile-sync-controller": "5.0.0-preview-d21875e1",
  "@metamask-previews/queued-request-controller": "9.0.0-preview-d21875e1",
  "@metamask-previews/rate-limit-controller": "6.0.2-preview-d21875e1",
  "@metamask-previews/remote-feature-flag-controller": "1.3.0-preview-d21875e1",
  "@metamask-previews/selected-network-controller": "21.0.0-preview-d21875e1",
  "@metamask-previews/signature-controller": "23.2.0-preview-d21875e1",
  "@metamask-previews/token-search-discovery-controller": "1.0.0-preview-d21875e1",
  "@metamask-previews/transaction-controller": "44.0.0-preview-d21875e1",
  "@metamask-previews/user-operation-controller": "23.0.0-preview-d21875e1"
}

matthewwalsh0
matthewwalsh0 requested changes Feb 8, 2025
View reviewed changes
packages/transaction-controller/src/TransactionController.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
packages/transaction-controller/src/helpers/ResimulateHelper.ts Outdated Show resolved Hide resolved
@OGPoyraz OGPoyraz enabled auto-merge (squash) February 13, 2025 10:35
@OGPoyraz OGPoyraz merged commit 19e242a into main Feb 13, 2025
130 checks passed
@OGPoyraz OGPoyraz deleted the 3922-re-simulate-transactions-for-every-new-block branch February 13, 2025 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcmire mcmire mcmire left review comments

@matthewwalsh0 matthewwalsh0 matthewwalsh0 approved these changes

@jpuri jpuri jpuri left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@OGPoyraz @mcmire @jpuri @matthewwalsh0