Struct Command

pub struct Command {
    permissioned_seats: u16,
    registered_seats: u16,
    permissioned_file: Option<String>,
    registered_file: Option<String>,
    repetitions: u32,
    registered_pool_size: Option<u32>,
    ariadne_version: AriadneVersion,
    output_to_terminal: bool,
    target_dir: Option<String>,
}

Runs Ariadne selection and calculates various statistics for the selected committee.

This command writes output data as CSV either to standard output or a file with name <target-dir>/ariadne-simulation-<timestamp>.csv.

The following statistics are calculated for each committee:

• total_registered_stake: total stake of the registered candidate pool
• total_committee_stake: total stake of all selected committee members
• distinct_members: number of unique members in the committee
• max_single_member_seats: highest number of committee seats occupied by the same member
• safe_offline_members: highest number of members that can be offline without affecting the consensus. This number is calculated by greedily taking members with highest stake until more than 33% of seats are offline.
• top_safe_offline_stake: total stake of top stake candidates that can be offline without affecting the consensus
• bottom_safe_offline_stake: total stake of lowest stake candidates that can be offline without affecting the consensus

Additionally, all input parameters are saved with the data.

Fields

permissioned_seats: u16

Number of permissioned seats

registered_seats: u16

Number of registered seats

permissioned_file: Option<String>

File containing permissioned candidates, defaults to no permissioned candidates

registered_file: Option<String>

File containing registered candidates, defaults to no registered candidates

repetitions: u32

Number of committees to select. Each committee will have a separate row in the output CSV file

registered_pool_size: Option<u32>

Number of registered candidates to be sampled from the registered_file. Defaults to the size of registered_file

ariadne_version: AriadneVersion

Ariadne algorithm version

output_to_terminal: bool

Determines whether to output to standard output instead of a file

target_dir: Option<String>

Directory in which to save the output CSV file

Implementations

impl Command

pub fn execute(self, rng: ChaCha20Rng)

Executes the command using givern RNG

fn sample_registered( &self, potential_registered_candidates: Vec<(String, u128)>, rng: &mut ChaCha20Rng, ) -> (usize, Vec<(String, u128)>)

fn calculate_stats( &self, committee: &[String], registered_candidates: &[(String, u128)], ) -> SelectionStats

Trait Implementations

impl Args for Command

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 Command

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 Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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.