Struct snarkos_cli::commands::Start

pub struct Start {

    pub network: u16,
    pub validator: bool,
    pub prover: bool,
    pub client: bool,
    pub private_key: Option<String>,
    pub private_key_file: Option<PathBuf>,
    pub node: Option<SocketAddr>,
    pub bft: Option<SocketAddr>,
    pub peers: String,
    pub validators: String,
    pub allow_external_peers: bool,
    pub rest: Option<SocketAddr>,
    pub rest_rps: u32,
    pub norest: bool,
    pub nodisplay: bool,
    pub verbosity: u8,
    pub logfile: PathBuf,
    pub metrics: bool,
    pub storage: Option<PathBuf>,
    pub cdn: Option<String>,
    pub nocdn: bool,
    pub dev: Option<u16>,
    pub dev_num_validators: Option<u16>,
    pub no_dev_txs: bool,
    pub dev_bonded_balances: Option<BondedBalances>,
}

Starts the snarkOS node.

Fields

network: u16

Specify the network ID of this node

validator: bool

Specify this node as a validator

prover: bool

Specify this node as a prover

client: bool

Specify this node as a client

private_key: Option<String>

Specify the account private key of the node

private_key_file: Option<PathBuf>

Specify the path to a file containing the account private key of the node

node: Option<SocketAddr>

Specify the IP address and port for the node server

bft: Option<SocketAddr>

Specify the IP address and port for the BFT

peers: String

Specify the IP address and port of the peer(s) to connect to

validators: String

Specify the IP address and port of the validator(s) to connect to

allow_external_peers: bool

If the flag is set, a node will allow untrusted peers to connect

rest: Option<SocketAddr>

Specify the IP address and port for the REST server

rest_rps: u32

Specify the requests per second (RPS) rate limit per IP for the REST server

norest: bool

If the flag is set, the node will not initialize the REST server

nodisplay: bool

If the flag is set, the node will not render the display

verbosity: u8

Specify the verbosity of the node [options: 0, 1, 2, 3, 4]

logfile: PathBuf

Specify the path to the file where logs will be stored

metrics: bool

Enables the metrics exporter

storage: Option<PathBuf>

Specify the path to a directory containing the storage database for the ledger

cdn: Option<String>

Enables the node to prefetch initial blocks from a CDN

nocdn: bool

If the flag is set, the node will not prefetch from a CDN

dev: Option<u16>

Enables development mode, specify a unique ID for this node

dev_num_validators: Option<u16>

If development mode is enabled, specify the number of genesis validators (default: 4)

no_dev_txs: bool

If developtment mode is enabled, specify whether node 0 should generate traffic to drive the network

dev_bonded_balances: Option<BondedBalances>

If development mode is enabled, specify the custom bonded balances as a JSON object (default: None)

Implementations

impl Start

pub fn parse(self) -> Result<String>

Starts the snarkOS node.

Trait Implementations

impl Args for Start

fn group_id() -> Option<Id>

Report the 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 Start

fn clone(&self) -> Start

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Start

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 Start

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

Formats the value using the given formatter.

impl FromArgMatches for Start

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 Start

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.