-
Notifications
You must be signed in to change notification settings - Fork 660
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.
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
fork-aware transaction pool added #4639
Open
michalkucharczyk
wants to merge
331
commits into
master
Choose a base branch
from
mku-fork-aware-tx-pool
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+11,880
−1,569
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
This was referenced Sep 20, 2024
Filed here: #5489 |
This was referenced Sep 23, 2024
The CI pipeline was cancelled due to failure one of the required jobs. |
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.
Fork-Aware Transaction Pool Implementation
This PR introduces a fork-aware transaction pool (fatxpool) enhancing transaction management by maintaining the valid state of txpool for different forks.
High-level overview
The high level overview was added to
sc_transaction_pool::fork_aware_txpool
module. Use:to build the doc. It should give a good overview and nice entry point into the new pool's mechanics.
Quick overview (documentation excerpt)
View
For every fork, a view is created. The view is a persisted state of the transaction pool computed and updated at the tip of the fork. The view is built around the existing
ValidatedPool
structure.A view is created on every new best block notification. To create a view, one of the existing views is chosen and cloned.
When the chain progresses, the view is kept in the cache (
retracted_views
) to allow building blocks upon intermediary blocks in the fork.The views are deleted on finalization: views lower than the finalized block are removed.
The views are updated with the transactions from the mempool—all transactions are sent to the newly created views.
A maintain process is also executed for the newly created views—basically resubmitting and pruning transactions from the appropriate tree route.
View store
View store is the helper structure that acts as a container for all the views. It provides some convenient methods.
Submitting transactions
Every transaction is submitted to every view at the tips of the forks. Retracted views are not updated.
Every transaction also goes into the mempool.
Internal mempool
Shortly, the main purpose of an internal mempool is to prevent a transaction from being lost. That could happen when a transaction is invalid on one fork and could be valid on another. It also allows the txpool to accept transactions when no blocks have been reported yet.
The mempool removes its transactions when they get finalized. Transactions are also periodically verified on every finalized event and removed from the mempool if no longer valid.
Events
Transaction events from multiple views are merged and filtered to avoid duplicated events.
Ready
/Future
/Inblock
events are originated in the Views and are de-duplicated and forwarded to external listeners.Finalized
events are originated in fork-aware-txpool logic.Invalid
events requires special care and can be originated in both view and fork-aware-txpool logic.Light maintain
Sometime transaction pool does not have enough time to prepare fully maintained view with all retracted transactions being revalidated. To avoid providing empty ready transaction set to block builder (what would result in empty block) the light maintain was implemented. It simply removes the imported transactions from ready iterator.
Revalidation
Revalidation is performed for every view. The revalidation process is started after a trigger is executed. The revalidation work is terminated just after a new best block / finalized event is notified to the transaction pool.
The revalidation result is applied to the newly created view which is built upon the revalidated view.
Additionally, parts of the mempool are also revalidated to make sure that no transactions are stuck in the mempool.
Logs
The most important log allowing to understand the state of the txpool is:
It is logged after the maintenance is done.
The
debug
level enables per-transaction logging, allowing to keep track of all transaction-related actions that happened in txpool.Integration notes
For teams having a custom node, the new txpool needs to be instantiated, typically in
service.rs
file, here is an example:polkadot-sdk/cumulus/polkadot-parachain/polkadot-parachain-lib/src/common/spec.rs
Lines 159 to 168 in 8be61ec
To enable new transaction pool the following cli arg shall be specified:
--pool-type=fork-aware
. If it works, there shall be information printed in the log:For debugging the following debugs shall be enabled:
note: trace for txpool enables per-transaction logging.
Future work
The current implementation seems to be stable, however further improvements are required.
Here is the umbrella issue for future work:
fatxpool
: Master issue for upcoming work #5472Partially fixes: #1202