fix: clippy with no-default and docs in CI#104
Merged
karim-agha merged 3 commits intoflashbots:mainfrom Dec 28, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes compilation issues with --no-default-features and broken documentation, while adding CI steps to catch these issues in the future.
Key Changes:
- Added CI jobs for clippy with
--no-default-featuresand documentation building with--all-features - Fixed feature gating in
src/orderpool2/prioritized_pool/step.rsto prevent compilation errors when optimism feature is disabled - Corrected numerous broken documentation links and improved API documentation
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/sanity.yaml | Added new CI jobs for clippy without default features and documentation validation |
| src/orderpool2/prioritized_pool/step.rs | Added proper cfg(feature = "optimism") gates for Optimism-specific imports and implementations |
| src/payload/exec.rs | Changed execute_transaction and execute_bundle visibility to pub and updated doc references to RemoveRevertedTransactions |
| src/test_utils/platform.rs | Added proper doclink for rblib_test macro |
| src/test_utils/mod.rs | Fixed Platform doclink and added explicit links for Ethereum and Optimism |
| src/test_utils/exts/mock.rs | Fixed broken doclink to PipelineServiceBuilder and added link for PayloadJobGenerator |
| src/pool/setup.rs | Improved documentation with concrete feature list instead of broken HostNode link |
| src/platform/optimism/ext.rs | Added proper doclinks for Ecotone, Holocene, and Jovian hard forks |
| src/platform/mod.rs | Fixed EthereumNode doclink and made OpNode link conditional on optimism feature |
| src/pipelines/step/context.rs | Added proper doclink for BlockBuilder::apply_pre_execution_changes |
| src/pipelines/exec/scope.rs | Changed code block from rust to text for diagrammatic content |
| src/pipelines/exec/mod.rs | Added doclink for BlockBuilder::apply_pre_execution_changes |
| src/payload/ext/cached_state.rs | Removed reference to non-existent CachedStateMetrics parameter |
| src/payload/block.rs | Fixed doclink for PayloadJobGenerator::new_payload_job |
| src/lib.rs | Changed doc comment to regular comment for conditionally compiled test_utils module |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
julio4
approved these changes
Dec 28, 2025
Member
julio4
left a comment
There was a problem hiding this comment.
LGTM! Thanks a lot for contributing
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.
Noticed compilation is broken with
--no-default-featuresdue to missingcfg(feature="optimism")insrc/orderpool2/prioritized_pool/step.rs. This lead to adding missing CI steps, and noticing that documentation is also broken with default features and with--all-featuresSo:
--no-default-features--all-featuresand-D warningsRevertProtection)Executable::execute_transactionandExecutable::execute_bundleare now pubExecutable::execute