Struct Args 

pub struct Args {

    signing_key: Option<PathBuf>,
    pub signing_share: Option<PathBuf>,
    pub listen_address: SocketAddr,
    pub metrics_address: SocketAddr,
    pub max_message_size_bytes: usize,
    pub worker_threads: usize,
    pub message_backlog: usize,
    pub mailbox_size: usize,
    pub deque_size: usize,
    pub fee_recipient: Option<Address>,
    pub wait_for_peer_response: SignedDuration,
    pub wait_for_notarizations: SignedDuration,
    pub wait_for_proposal: SignedDuration,
    pub wait_to_rebroadcast_nullify: SignedDuration,
    pub views_to_track: u64,
    pub inactive_views_until_leader_skip: u64,
    pub time_to_build_proposal: SignedDuration,
    pub time_to_build_subblock: SignedDuration,
    pub allow_unregistered_handshakes: bool,
    pub subblock_broadcast_interval: SignedDuration,
    loaded_signing_key: OnceLock<Option<SigningKey>>,
}

Command line arguments for configuring the consensus layer of a tempo node.

Fields

signing_key: Option<PathBuf>

The file containing the ed25519 signing key for p2p communication.

signing_share: Option<PathBuf>

The file containing a share of the bls12-381 threshold signing key.

listen_address: SocketAddr

The socket address that will be bound to listen for consensus communication from other nodes.

metrics_address: SocketAddr

The socket address that will be bound to export consensus specific metrics.

max_message_size_bytes: usize

worker_threads: usize

The number of worker threads assigned to consensus.

message_backlog: usize

The maximum number of messages that can be cute on the various consensus p2p channels before blocking.

mailbox_size: usize

The overall number of items that can be received on the various consensus p2p channels before blocking.

deque_size: usize

The maximum number of blocks that will be buffered per peer. Used to send and receive blocks over the p2p network of the consensus layer.

fee_recipient: Option<Address>

The fee recipien that will be specified by this node. Will use the coinbase address in genesis if not set.

wait_for_peer_response: SignedDuration

wait_for_notarizations: SignedDuration

The amount of time to wait for a quorum of notarizations in a view before attempting to skip the view.

wait_for_proposal: SignedDuration

Amount of time to wait to receive a proposal from the leader of the current view.

wait_to_rebroadcast_nullify: SignedDuration

The amount of time to wait before retrying a nullify broadcast if stuck in a view.

views_to_track: u64

The number of views (like voting rounds) to track. Also called an activity timeout.

inactive_views_until_leader_skip: u64

The number of views (voting rounds) a validator is allowed to be inactive until it is immediately skipped should leader selection pick it as a proposer. Also called a skip timeout.

time_to_build_proposal: SignedDuration

The amount of time this node will use to construct a block as a proposal. This value should be well below consensus.wait-for-proposal to account for the leader to enter the view, build and broadcast the proposal, and have the other peers receive the proposal.

time_to_build_subblock: SignedDuration

The amount of time this node will use to construct a subblock before sending it to the next proposer. This value should be well below consensus.time-to-build-proposal to ensure the subblock is received before the build is complete.

allow_unregistered_handshakes: bool

Reduces security by disabling IP-based connection filtering. Connections are still authenticated via public key cryptography, but anyone can attempt handshakes, increasing exposure to DoS attacks. Only enable in trusted network environments.

subblock_broadcast_interval: SignedDuration

The interval at which to broadcast subblocks to the next proposer. Each built subblock is immediately broadcasted to the next proposer (if it’s known). We broadcast subblock every subblock-broadcast-interval to ensure the next proposer is aware of the subblock even if they were slightly behind the chain once we sent it in the first time.

loaded_signing_key: OnceLock<Option<SigningKey>>

Cache for the signing key loaded from CLI-provided file.

Implementations

impl Args

pub(crate) fn signing_key(&self) -> Result<Option<SigningKey>>

Returns the signing key loaded from specified file.

pub fn public_key(&self) -> Result<Option<PublicKey>>

Returns the public key derived from the configured signing key, if any.

Trait Implementations

impl Args for Args

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 Args

fn clone(&self) -> Args

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 PartialEq for Args

fn eq(&self, other: &Args) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Args

impl StructuralPartialEq for Args

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 640 bytes