Struct hotshot_orchestrator::client::ValidatorArgs

pub struct ValidatorArgs {
    pub url: Url,
    pub advertise_address: Option<String>,
    pub builder_address: Option<SocketAddr>,
    pub network_config_file: Option<String>,
}

Arguments passed to the validator

Fields

url: Url

The address the orchestrator runs on

advertise_address: Option<String>

The optional advertise address to use for Libp2p

builder_address: Option<SocketAddr>

Optional address to run builder on. Address must be accessible by other nodes

network_config_file: Option<String>

An optional network config file to save to/load from Allows for rejoining the network on a complete state loss

Implementations

impl ValidatorArgs

pub fn from_multi_args(multi_args: MultiValidatorArgs, node_index: u16) -> Self

Constructs ValidatorArgs from MultiValidatorArgs and a node index.

If network_config_file is present in MultiValidatorArgs, it appends the node index to it to create a unique file name for each node.

Arguments

• multi_args - A MultiValidatorArgs instance containing the base arguments for the construction.
• node_index - A u16 representing the index of the node for which the args are being constructed.

Returns

This function returns a new instance of ValidatorArgs.

Examples

// NOTE this is a toy example,
// the user will need to construct a multivalidatorargs since `new` does not exist
let multi_args = MultiValidatorArgs::new();
let node_index = 1;
let instance = Self::from_multi_args(multi_args, node_index);

Trait Implementations

impl Args for ValidatorArgs

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 Clone for ValidatorArgs

fn clone(&self) -> ValidatorArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ValidatorArgs

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 ValidatorArgs

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

Formats the value using the given formatter.

impl FromArgMatches for ValidatorArgs

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 ValidatorArgs

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.