Refactor: fix docs, clean up code quality #843
Draft
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.
📝 Summary
Based on #842. Draft until #842 is merged
Improves and corrects documentation in the live_builder, particularly around Order propagation through the OrderPool. Functionality does not change. Most significant API change is around
BlobTypeOrderFilter, by moving constructors from free functions to assoc functionsOrderPooldocumentationCopyimpl forReplacementData<KeyType>Copyimpl forNonceKeyBlobTypeOrderFilterconstruction idiomatic for Rusttrace!event toBlobTypeOrderFilterwhen filtering an orderrule_nametoBlobTypeOrderFilterto ensure behavior is clear in tracing eventFromimpls forReplaceableOrderEvent, and remove some relevant.cloneinvocationsAutoRemovingOrderPoolSubscriptionIdto useWeakto prevent them from holdingOrderPoolmemory alloc for dying subscriptionsFuturesUnorderedinstead ofVec<JoinHandle<()>>in the order pool to ensure parallelization of handle reaping✅ I have completed the following steps:
make lintmake test