Struct Args 

pub(crate) struct Args {

    pub baseline_ref: String,
    pub feature_ref: String,
    pub datadir: DatadirArgs,
    pub blocks: u64,
    pub rpc_url: Option<String>,
    pub jwt_secret: Option<PathBuf>,
    pub output_dir: String,
    pub skip_git_validation: bool,
    pub metrics_port: u16,
    pub chain: Chain,
    pub sudo: bool,
    pub draw: bool,
    pub profile: bool,
    pub wait_time: Option<String>,
    pub warmup_blocks: Option<u64>,
    pub no_clear_cache: bool,
    pub logs: LogArgs,
    pub traces: TraceArgs,
    pub otlp_max_queue_size: usize,
    pub baseline_args: Option<String>,
    pub feature_args: Option<String>,
    pub reth_args: Vec<String>,
    pub features: String,
    pub disable_startup_sync_state_idle: Option<DisableStartupSyncStateIdle>,
}

Automated reth benchmark comparison between git references

Fields

baseline_ref: String

Git reference (branch or tag) to use as baseline for comparison

feature_ref: String

Git reference (branch or tag) to compare against the baseline

datadir: DatadirArgs

blocks: u64

Number of blocks to benchmark

rpc_url: Option<String>

RPC endpoint for fetching block data

jwt_secret: Option<PathBuf>

JWT secret file path

If not provided, defaults to <datadir>/<chain>/jwt.hex. If the file doesn’t exist, it will be created automatically.

output_dir: String

Output directory for benchmark results

skip_git_validation: bool

Skip git branch validation (useful for testing)

metrics_port: u16

Port for reth metrics endpoint

chain: Chain

The chain this node is running.

Possible values are either a built-in chain name or numeric chain ID.

sudo: bool

Run reth binary with sudo (for elevated privileges)

draw: bool

Generate comparison charts using Python script

profile: bool

Enable CPU profiling with samply during benchmark runs

wait_time: Option<String>

Wait time between engine API calls (passed to reth-bench)

warmup_blocks: Option<u64>

Number of blocks to run for cache warmup after clearing caches. If not specified, defaults to the same as –blocks

no_clear_cache: bool

Disable filesystem cache clearing before warmup phase. By default, filesystem caches are cleared before warmup to ensure consistent benchmarks.

logs: LogArgs

traces: TraceArgs

otlp_max_queue_size: usize

Maximum queue size for OTLP Batch Span Processor (traces). Higher values prevent trace drops when benchmarking many blocks.

baseline_args: Option<String>

Additional arguments to pass to baseline reth node command

Example: --baseline-args "--debug.tip 0xabc..."

feature_args: Option<String>

Additional arguments to pass to feature reth node command

Example: --feature-args "--debug.tip 0xdef..."

reth_args: Vec<String>

Additional arguments to pass to reth node command (applied to both baseline and feature)

All arguments after -- will be passed directly to the reth node command. Example: reth-bench-compare --baseline-ref main --feature-ref pr/123 -- --debug.tip 0xabc...

features: String

Comma-separated list of features to enable during reth compilation

Example: jemalloc,asm-keccak

disable_startup_sync_state_idle: Option<DisableStartupSyncStateIdle>

Disable automatic –debug.startup-sync-state-idle flag for specific runs. Can be “baseline”, “feature”, or “all”. By default, the flag is passed to warmup, baseline, and feature runs. When “baseline” is specified, the flag is NOT passed to warmup OR baseline. When “feature” is specified, the flag is NOT passed to feature. When “all” is specified, the flag is NOT passed to any run.

Implementations

impl Args

pub(crate) fn init_tracing(&self) -> Result<Option<FileWorkerGuard>>

Initializes tracing with the configured options.

pub(crate) fn build_additional_args( &self, ref_type: &str, base_args_str: Option<&String>, ) -> Vec<String>

Build additional arguments for a specific ref type, conditionally including –debug.startup-sync-state-idle based on the configuration

const fn get_default_rpc_url(chain: &Chain) -> &'static str

Get the default RPC URL for a given chain

pub(crate) fn get_rpc_url(&self) -> String

Get the RPC URL, using chain-specific default if not provided

pub(crate) fn jwt_secret_path(&self) -> PathBuf

Get the JWT secret path - either provided or derived from datadir

pub(crate) fn datadir_path(&self) -> PathBuf

Get the resolved datadir path using the chain

pub(crate) fn output_dir_path(&self) -> PathBuf

Get the expanded output directory path

pub(crate) fn get_warmup_blocks(&self) -> u64

Get the effective warmup blocks value - either specified or defaults to blocks

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for Args

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Args

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Args

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1320 bytes