transaction-pool: Improve transaction status documentation and add helpers #3215
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
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
The documentation is improved by having doc links to the states that the transaction pool enumarates. This is to ensure that a rename would cause the `docs` check to fail. Also, the `FinalityTimeout` only happens when the maximum number of watchers has been reached. Contrary to the documentation that states a lagging finality gadget. Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
lexnv
added
A1-insubstantial
bkchr
approved these changes
Feb 5, 2024
| /// finalized. The `FinalityTimeout` event will be emitted when the block did not reach finality | ||
| /// within 512 blocks. This either indicates that finality is not available for your chain, | ||
| /// or that finality gadget is lagging behind. If you choose to wait for finality longer, you can | ||
| /// re-subscribe for a particular transaction hash manually again. |
There was a problem hiding this comment.
I think description of FinalityTimeout is worth keeping. It reflects current implementation.
I am not sure if transaction is retriable when finality timeout event was reported. It could be the case, but it also could mean that transaction was actually finalized. Maybe it is worth putting more info on this.
michalkucharczyk
approved these changes
Feb 5, 2024
Signed-off-by: Alexandru Vasile <[email protected]>
skunert
approved these changes
Feb 6, 2024
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
…lpers (paritytech#3215) This PR improves the transaction status documentation. - Added doc references for describing the main states - Extra comment wrt pool ready / future queues - `FinalityTimeout` no longer describes a lagging finality gadget, it signals that the maximum number of finality gadgets has been reached A few helper methods are added to indicate when: - a final event is generated by the transaction pool for a given event - a final event is provided, although the transaction might become valid at a later time and could be re-submitted The helper methods are used and taken from paritytech#3079 to help us better keep it in sync. cc @paritytech/subxt-team --------- Signed-off-by: Alexandru Vasile <[email protected]>
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.
This PR improves the transaction status documentation.
FinalityTimeoutno longer describes a lagging finality gadget, it signals that the maximum number of finality gadgets has been reachedA few helper methods are added to indicate when:
The helper methods are used and taken from #3079 to help us better keep it in sync.
cc @paritytech/subxt-team