Struct Start

pub struct Start {

    pub network: u16,
    pub prover: bool,
    pub client: bool,
    pub validator: bool,
    pub private_key: Option<String>,
    pub private_key_file: Option<PathBuf>,
    pub node: Option<SocketAddr>,
    pub bft: Option<SocketAddr>,
    pub peers: Option<String>,
    pub validators: Option<String>,
    pub allow_external_peers: bool,
    pub rotate_external_peers: bool,
    pub rest: Option<SocketAddr>,
    pub rest_rps: u32,
    pub jwt_secret: Option<String>,
    pub jwt_timestamp: Option<i64>,
    pub norest: bool,
    pub nodisplay: bool,
    pub verbosity: u8,
    pub log_filter: Option<String>,
    pub logfile: PathBuf,
    pub storage: Option<PathBuf>,
    pub cdn: Option<String>,
    pub nocdn: bool,
    pub dev: Option<u16>,
    pub dev_num_validators: 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 [options: 0 = mainnet, 1 = testnet, 2 = canary]

prover: bool

Start the node as a prover.

client: bool

Start the node as a client (default).

Client are “full nodes”, i.e, validate and execute all blocks they receive, but they do not participate in AleoBFT consensus.

validator: bool

Start the node as a validator.

Validators are “full nodes”, like clients, but also participate in AleoBFT.

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>

Set the IP address and port used for P2P communication.

bft: Option<SocketAddr>

Set the IP address and port used for BFT communication. This argument is only allowed for validator nodes.

peers: Option<String>

Specify the IP address and port of the peer(s) to connect to (as a comma-separated list).

These peers will be set as “trusted”, which means the node will not disconnect from them when performing peer rotation.

Setting peers to “” has the same effect as not setting the flag at all, except when using --dev.

validators: Option<String>

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

allow_external_peers: bool

Allow untrusted peers (not listed in --peers) to connect.

The flag will be ignored by client and prover nodes, as tis behavior is always enabled for these types of nodes.

rotate_external_peers: bool

If the flag is set, a client will periodically evict more external peers

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

jwt_secret: Option<String>

Specify the JWT secret for the REST server (16B, base64-encoded).

jwt_timestamp: Option<i64>

Specify the JWT creation timestamp; can be any time in the last 10 years.

norest: bool

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

nodisplay: bool

Write log message to stdout instead of showing a terminal UI.

This is useful, for example, for running a node as a service instead of in the foreground or to pipe its output into a file.

verbosity: u8

Specify the log verbosity of the node. [options: 0 (lowest log level) to 6 (highest level)]

log_filter: Option<String>

Set a custom log filtering scheme, e.g., “off,snarkos_bft=trace”, to show all log messages of snarkos_bft but nothing else.

logfile: PathBuf

Specify the path to the file where logs will be stored

storage: Option<PathBuf>

Specify the path to a directory containing the storage database for the ledger. This flag overrides the default path, even when --dev is set.

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 used to set up test networks.

The purpose of this flag is to run multiple nodes on the same machine and in the same working directory. To do this, set the value to a unique ID within the test work. For example if there are four nodes in the network, pass --dev 0 for the first node, --dev 1 for the second, and so forth.

If you do not explicitly set the --peers flag, this will also populate the set of trusted peers, so that the network is fully connected. Additionally, if you do not set the --rest or the --norest flags, it will also set the REST port to 3030 for the first node, 3031 for the second, and so forth.

dev_num_validators: u16

If development mode is enabled, specify the number of genesis validator.

no_dev_txs: bool

If development 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.

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 duplicate 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.