Struct phronesis::phron_cli::PhronCli

pub struct PhronCli {
    unit_creation_delay: u64,
    public_validator_addresses: Option<Vec<String>>,
    validator_port: u16,
    no_backup: bool,
    backup_path: Option<PathBuf>,
    max_nonfinalized_blocks: u32,
    experimental_pruning: bool,
    phron_bit_rate_per_connection: u64,
    no_collection_of_extra_debugging_data: bool,
}

Fields

unit_creation_delay: u64

public_validator_addresses: Option<Vec<String>>

The addresses at which the node will be externally reachable for validator network purposes. Have to be provided for validators.

validator_port: u16

The port on which to listen to validator network connections.

no_backup: bool

Turn off backups, at the cost of limiting crash recoverability.

If backups are turned off and the node crashes, it most likely will not be able to continue the session during which it crashed. It will join AlephBFT consensus in the next session.

backup_path: Option<PathBuf>

The path to save backups to.

Backups created by the node are saved under this path. When restarted after a crash, the backups will be used to recover the node’s state, helping prevent auto-forks. The layout of the directory is unspecified. This flag must be specified unless backups are turned off with --no-backup, but note that that limits crash recoverability.

max_nonfinalized_blocks: u32

The maximum number of nonfinalized blocks, after which block production should be locally stopped. DO NOT CHANGE THIS, PRODUCING MORE OR FEWER BLOCKS MIGHT BE CONSIDERED MALICIOUS BEHAVIOUR AND PUNISHED ACCORDINGLY!

experimental_pruning: bool

Experimental flag, allows pruning

TURNING THIS FLAG ON, CAN LEAD TO MALICIOUS BEHAVIOUR AND CAN BE PUNISHED ACCORDINGLY!

phron_bit_rate_per_connection: u64

Maximum bit-rate per node in bytes per second of the alephbft validator network.

no_collection_of_extra_debugging_data: bool

Don’t spend some extra time to collect more debugging data (e.g. validator network details). By default collecting is enabled, as the impact on performance is negligible, if any.

Implementations

impl PhronCli

pub fn unit_creation_delay(&self) -> UnitCreationDelay

pub fn external_addresses(&self) -> Vec<String>

pub fn set_dummy_external_addresses(&mut self)

pub fn validator_port(&self) -> u16

pub fn _backup_path(&self) -> Option<PathBuf>

pub fn _no_backup(&self) -> bool

pub fn _max_nonfinalized_blocks(&self) -> u32

pub fn _experimental_pruning(&self) -> bool

pub fn phron_bit_rate_per_connection(&self) -> u64

pub fn no_collection_of_extra_debugging_data(&self) -> bool

Trait Implementations

impl Args for PhronCli

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.

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

Append to [Command] so it can update self.

impl Clone for PhronCli

fn clone(&self) -> PhronCli

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for PhronCli

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 PhronCli

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

Formats the value using the given formatter.

impl FromArgMatches for PhronCli

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 PhronCli

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.