Struct NarwhalProtocol

pub struct NarwhalProtocol {
    working_dir: PathBuf,
}

All configurations information to run a narwhal client or validator.

Fields

working_dir: PathBuf

Implementations

impl NarwhalProtocol

pub fn new(settings: &Settings) -> Self

Make a new instance of the Narwhal protocol commands generator.

Trait Implementations

impl ProtocolCommands<NarwhalBenchmarkType> for NarwhalProtocol

fn protocol_dependencies(&self) -> Vec<&'static str>

The list of dependencies to install (e.g., through apt-get).

fn db_directories(&self) -> Vec<PathBuf>

The directories of all databases (that should be erased before each run).

fn genesis_command<'a, I>(&self, instances: I) -> String

where I: Iterator<Item = &'a Instance>,

The command to generate the genesis and all configuration files. This command is run on each remote machine.

fn monitor_command<I>(&self, _instances: I) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

fn node_command<I>( &self, instances: I, parameters: &BenchmarkParameters<NarwhalBenchmarkType>, ) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The command to run a node. The function returns a vector of commands along with the associated instance on which to run the command.

fn client_command<I>( &self, _instances: I, _parameters: &BenchmarkParameters<NarwhalBenchmarkType>, ) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The command to run a client. The function returns a vector of commands along with the associated instance on which to run the command.

impl ProtocolMetrics for NarwhalProtocol

const BENCHMARK_DURATION: &'static str = "narwhal_benchmark_duration"

The name of the metric reporting the total duration of the benchmark (in seconds).

const TOTAL_TRANSACTIONS: &'static str = "worker_req_latency_by_route_count"

The name of the metric reporting the total number of finalized transactions

const LATENCY_BUCKETS: &'static str = "batch_execution_latency"

The name of the metric reporting the latency buckets.

const LATENCY_SUM: &'static str = "batch_execution_latency_sum"

The name of the metric reporting the sum of the end-to-end latency of all finalized transactions.

const LATENCY_SQUARED_SUM: &'static str = "narwhal_client_latency_squared_s"

The name of the metric reporting the square of the sum of the end-to-end latency of all finalized transactions.

fn nodes_metrics_path<I>(&self, instances: I) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The network path where the nodes expose prometheus metrics.

fn clients_metrics_path<I>(&self, _instances: I) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The network path where the clients expose prometheus metrics.

fn nodes_metrics_command<I>(&self, instances: I) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The command to retrieve the metrics from the nodes.

fn clients_metrics_command<I>(&self, instances: I) -> Vec<(Instance, String)>

where I: IntoIterator<Item = Instance>,

The command to retrieve the metrics from the clients.