feat: Re-simulate active transactions every 3000 ms #5189
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. |
|
@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. |
jpuri
previously approved these changes
Jan 24, 2025
|
@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. |
OGPoyraz
force-pushed
the
3922-re-simulate-transactions-for-every-new-block
branch
from
f159aea to
ea69888
Compare
|
@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. |
OGPoyraz
changed the title
mcmire
reviewed
Jan 29, 2025
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/TransactionController.test.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
matthewwalsh0
requested changes
Jan 30, 2025
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
|
@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. |
OGPoyraz
changed the title
|
@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. |
matthewwalsh0
requested changes
Feb 8, 2025
| onTransactionsUpdate: (listener) => { | ||
| this.messagingSystem.subscribe( | ||
| 'TransactionController:stateChange', | ||
| (_newState, patches: Patch[]) => { |
There was a problem hiding this comment.
You're using the patches which is an argument specific to the stateChange event, but there is actually a third selector argument on subscribe itself that lets you filter the event data and only fires the event if that value changes.
https://github.com/MetaMask/core/blob/main/packages/base-controller/src/Messenger.ts#L341
|
|
||
| #start(transactionMeta: TransactionMeta) { | ||
| const { id: transactionId } = transactionMeta; | ||
| if (!transactionMeta.isActive || this.#timeoutIds.has(transactionId)) { |
There was a problem hiding this comment.
Minor, if we only call #start in one place after checking active, is there a need to check it again here?
| }; | ||
|
|
||
| // Start the first execution | ||
| const timeoutId = setTimeout(listener, RESIMULATE_INTERVAL_MS); |
There was a problem hiding this comment.
Minor, could we have a #queueUpdate method to remove the duplication in creating the timeouts?
|
|
||
| #stop(transactionMeta: TransactionMeta) { | ||
| const { id: transactionId } = transactionMeta; | ||
| if (transactionMeta.isActive || !this.#timeoutIds.has(transactionId)) { |
There was a problem hiding this comment.
Minor, also here, is the isActive validation needed if already checked before calling?
| (tx) => tx.id === transactionId, | ||
| ); | ||
|
|
||
| if (transactionMeta && transactionMeta.isActive) { |
There was a problem hiding this comment.
Minor, could this be transactionMeta?.isActive?
| this.#stop({ | ||
| id: transactionId, | ||
| isActive: false, | ||
| } as unknown as TransactionMeta); |
There was a problem hiding this comment.
Could we remove the cast and just have a transactionId argument on #stop?
| .finally(() => { | ||
| // Schedule the next execution | ||
| if (this.#timeoutIds.has(transactionId)) { | ||
| const timeoutId = setTimeout(listener, RESIMULATE_INTERVAL_MS); |
There was a problem hiding this comment.
It's very rare we'll have more than one transaction, but worth confirming this means the updates for different transactions won't be in sync.
This should be fine as the simulation isn't a batch request.
| } | ||
|
|
||
| this.#removeListener(transactionId); | ||
| log(`Stopped resimulating transaction ${transactionId} every 3 seconds`); |
There was a problem hiding this comment.
Minor, we're still hardcoding the 3.
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 adds
ResimulateHelper, which focuses ontransactionMeta.isActiveproperty 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.tsfile.References
Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3922
Extension PR: MetaMask/metamask-extension#29878
Changelog
@metamask/transaction-controllerisActiveproperty ontransactionMetaisActiveproperty is expected to set by client.isActiveistrue.setTransactionActivefunction to update theisActiveproperty ontransactionMeta.Checklist