mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-04-08 03:01:12 -04:00
chore: add and fix more lints, improve docs (#4765)
This commit is contained in:
@@ -1,17 +1,13 @@
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
//! A basic payload generator for reth.
|
||||
|
||||
#![doc(
|
||||
html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",
|
||||
html_favicon_url = "https://avatars0.githubusercontent.com/u/97369466?s=256",
|
||||
issue_tracker_base_url = "https://github.com/paradigmxzy/reth/issues/"
|
||||
)]
|
||||
#![warn(missing_docs, unreachable_pub)]
|
||||
#![warn(missing_debug_implementations, missing_docs, unreachable_pub, rustdoc::all)]
|
||||
#![deny(unused_must_use, rust_2018_idioms)]
|
||||
#![doc(test(
|
||||
no_crate_inject,
|
||||
attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
|
||||
))]
|
||||
|
||||
//! A basic payload generator for reth.
|
||||
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
||||
|
||||
use crate::metrics::PayloadBuilderMetrics;
|
||||
use futures_core::ready;
|
||||
@@ -63,6 +59,7 @@ use tracing::{debug, trace};
|
||||
mod metrics;
|
||||
|
||||
/// The [`PayloadJobGenerator`] that creates [`BasicPayloadJob`]s.
|
||||
#[derive(Debug)]
|
||||
pub struct BasicPayloadJobGenerator<Client, Pool, Tasks, Builder = ()> {
|
||||
/// The client that can interact with the chain.
|
||||
client: Client,
|
||||
@@ -185,7 +182,7 @@ where
|
||||
}
|
||||
|
||||
/// Restricts how many generator tasks can be executed at once.
|
||||
#[derive(Clone)]
|
||||
#[derive(Debug, Clone)]
|
||||
struct PayloadTaskGuard(Arc<Semaphore>);
|
||||
|
||||
// === impl PayloadTaskGuard ===
|
||||
@@ -270,6 +267,7 @@ impl Default for BasicPayloadJobGeneratorConfig {
|
||||
}
|
||||
|
||||
/// A basic payload job that continuously builds a payload with the best transactions from the pool.
|
||||
#[derive(Debug)]
|
||||
pub struct BasicPayloadJob<Client, Pool, Tasks, Builder> {
|
||||
/// The configuration for how the payload will be created.
|
||||
config: PayloadConfig,
|
||||
@@ -534,7 +532,7 @@ impl Drop for Cancelled {
|
||||
}
|
||||
|
||||
/// Static config for how to build a payload.
|
||||
#[derive(Clone)]
|
||||
#[derive(Clone, Debug)]
|
||||
struct PayloadConfig {
|
||||
/// Pre-configured block environment.
|
||||
initialized_block_env: BlockEnv,
|
||||
@@ -576,6 +574,7 @@ pub enum BuildOutcome {
|
||||
/// This struct encapsulates the essential components and configuration required for the payload
|
||||
/// building process. It holds references to the Ethereum client, transaction pool, cached reads,
|
||||
/// payload configuration, cancellation status, and the best payload achieved so far.
|
||||
#[derive(Debug)]
|
||||
pub struct BuildArguments<Pool, Client> {
|
||||
client: Client,
|
||||
pool: Pool,
|
||||
|
||||
Reference in New Issue
Block a user