Struct Options 

pub struct Options {

    pub orchestrator_url: Url,
    pub cliquenet_bind_address: NetAddr,
    pub cliquenet_advertise_address: Option<NetAddr>,
    pub public_api_url: Option<Url>,
    pub builder_urls: Vec<Url>,
    pub state_relay_server_url: Url,
    pub genesis_file: GenesisSource,
    pub key_set: KeySetOptions,
    modules: Vec<String>,
    pub l1_provider_url: Vec<Url>,
    pub l1_options: L1ClientOptions,
    pub is_da: bool,
    pub state_peers: Vec<Url>,
    pub config_peers: Option<Vec<Url>>,
    pub catchup_backoff: BackoffParams,
    pub catchup_base_timeout: Duration,
    pub local_catchup_timeout: Duration,
    pub http_catchup_delay: Duration,
    pub bootstrap_epoch_catchup_timeout: Duration,
    pub empty_block_delay: Duration,
    pub leader_trace_dir: Option<PathBuf>,
    pub logging: Config,
    pub identity: Identity,
    pub telemetry: TelemetryOptions,
    pub proposal_fetcher_config: ProposalFetcherConfig,
}

Fields

orchestrator_url: Url

URL of the HotShot orchestrator.

cliquenet_bind_address: NetAddr

The address to bind to for cliquenet (in host:port | ip:port form)

cliquenet_advertise_address: Option<NetAddr>

The address to advertise to other nodes for cliquenet (in host:port | ip:port form).

Only used for orchestrator-based setup (test networks). On real networks the address must be registered in the stake table contract instead.

public_api_url: Option<Url>

The URL we advertise to other nodes as being for our public API. Should be supplied in http://host:port form.

builder_urls: Vec<Url>

The URL of the builders to use for submitting transactions

state_relay_server_url: Url

URL of the Light Client State Relay Server

genesis_file: GenesisSource

Location of the TOML file containing genesis state.

Accepts a plain filesystem path or an http(s):// URL.

key_set: KeySetOptions

modules: Vec<String>

Add optional modules to the service.

Modules are added by specifying the name of the module followed by it’s arguments, as in

sequencer [options] – api –port 3000

to run the API module with port 3000.

To see a list of available modules and their arguments, use

sequencer – help

Multiple modules can be specified, provided they are separated by –

l1_provider_url: Vec<Url>

Url we will use for RPC communication with L1.

l1_options: L1ClientOptions

Configuration for the L1 client.

is_da: bool

Whether or not we are a DA node.

state_peers: Vec<Url>

Peer nodes use to fetch missing state

config_peers: Option<Vec<Url>>

Peer nodes use to fetch missing config

Typically, the network-wide config is fetched from the orchestrator on startup and then persisted and loaded from local storage each time the node restarts. However, if the persisted config is missing when the node restarts (for example, the node is being migrated to new persistent storage), it can instead be fetched directly from a peer.

catchup_backoff: BackoffParams

Exponential backoff for fetching missing state from peers.

catchup_base_timeout: Duration

Base timeout for catchup requests to peers.

This is the initial per peer timeout for HTTP requests during state catchup

local_catchup_timeout: Duration

Timeout for local catchup provider requests.

Remote providers are queried concurrently; this bounds the wait on a slow local provider (e.g. database) once remote providers have failed.

http_catchup_delay: Duration

HTTP catchup starts this long after request-response, if request-response is registered.

bootstrap_epoch_catchup_timeout: Duration

Per-step timeout for the startup stake-table catchup walk.

Bounds a single wait_for_stake_table call during bootstrap_epoch_window. The underlying peer leaf fetch is bounded to 3 attempts, so exceeding this means a slow or unresponsive peer set, not a retry loop. Exceeding it terminates the walk but does not cancel the catchup task, which is a detached tokio::spawn bounded by its own DEFAULT_CATCHUP_TIMEOUT watchdog.

empty_block_delay: Duration

How long a leader waits before proposing a block with no transactions in it.

leader_trace_dir: Option<PathBuf>

Directory for the leader-event trace leader_trace_node{N}.csv. Disabled when unset. Use local disk: a slow flush blocks consensus.

logging: Config

identity: Identity

telemetry: TelemetryOptions

proposal_fetcher_config: ProposalFetcherConfig

Implementations

impl Options

pub fn modules(&self) -> Modules

pub fn follower_params( &self, follower: &Follower, query: &Query, light_client_db: LightClientDbOptions, ) -> Result<FollowerParams>

--config-peers is left unset for init_follower_node to default it to the upstreams.

Trait Implementations

impl Args for Options

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 Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Options

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 Options

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

Formats the value using the given formatter.

impl FromArgMatches for Options

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 Options

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.