fix: re-parse required tokens when token rates load after transaction added#8714
Draft
matthewwalsh0 wants to merge 4 commits intomainfrom
Draft
fix: re-parse required tokens when token rates load after transaction added#8714matthewwalsh0 wants to merge 4 commits intomainfrom
matthewwalsh0 wants to merge 4 commits intomainfrom
Conversation
This file contains hidden or 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
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
TransactionPayController.parseRequiredTokensreturns an empty array when token fiat rates are unavailable (getTokenFiatRatereturnsundefined). The result is stored intransactionData[id].tokensand surfaced to clients via the controller's state.Currently, the only retry trigger is a
txParams.datachange (handled by the existingpollTransactionChangessubscription). Clients that gatedataedits on having a resolved required token are therefore stuck: the rates never get re-checked because thedatanever changes, and thedatanever changes because the client refuses to encode an edit without a known target token'sdecimals. The required-token state remains empty for the lifetime of the confirmation, even aftermarketDataandcurrencyRatespopulate.This change adds a second subscription that re-runs
parseRequiredTokenswhen the rate sources update, but only for entries whosetokensarray is currently empty and whose underlying transaction is not finalized.Implementation
pollRateChangeshelper inutils/transaction.ts, sibling to the existingpollTransactionChanges.getTokenFiatRatereads from, gated on theassetsUnifyStatefeature flag:AssetsController:stateChange.TokenRatesController:stateChangeandCurrencyRateController:stateChange.transactionDatafrom controller state, skipping entries that already have non-emptytokensand transactions whose status is inFINALIZED_STATUSES. Remaining candidates are re-parsed via the existingonTransactionChangepath.TransactionPayControllerconstructor wirespollRateChangesnext to the existingpollTransactionChangescall, passing a() => this.stategetter.AllowedEvents:AssetsControllerStateChangeEvent,CurrencyRateStateChange,TokenRatesControllerStateChangeEvent.Out of scope
tokens.length === 0; entries that previously parsed successfully are not invalidated when rates change. Clients increasingly read aggregatedtotals?.targetAmount.usdrather than per-token amounts, so this hasn't been a problem in practice — but it remains a latent staleness exposure that this PR does not address.References
N/A.
Changelog
Checklist