Struct ServerOpts

pub(crate) struct ServerOpts {

    pub(crate) data_dir: PathBuf,
    pub(crate) bitcoin_network: Network,
    pub(crate) bitcoind_url: Option<SafeUrl>,
    pub(crate) esplora_url: Option<SafeUrl>,
    pub(crate) bind_p2p: SocketAddr,
    pub(crate) bind_api: SocketAddr,
    pub(crate) bind_ui: SocketAddr,
    pub(crate) p2p_url: Option<SafeUrl>,
    pub(crate) api_url: Option<SafeUrl>,
    pub(crate) enable_iroh: bool,
    pub(crate) iroh_dns: Option<SafeUrl>,
    pub(crate) iroh_relays: Vec<SafeUrl>,
    pub(crate) db_checkpoint_retention: u64,
    pub(crate) bind_tokio_console: Option<SocketAddr>,
    pub(crate) with_jaeger: bool,
    pub(crate) bind_metrics: Option<SocketAddr>,
    pub(crate) force_api_secrets: ApiSecrets,
}

Fields

data_dir: PathBuf

Path to folder containing federation config files

bitcoin_network: Network

The bitcoin network of the federation

bitcoind_url: Option<SafeUrl>

Bitcoind RPC URL, e.g. http://user:pass@127.0.0.1:8332

esplora_url: Option<SafeUrl>

Esplora HTTP base URL, e.g. https://mempool.space/api

bind_p2p: SocketAddr

Address we bind to for p2p consensus communication

Should be 0.0.0.0:8173 most of the time, as p2p connectivity is public and direct, and the port should be open it in the firewall.

bind_api: SocketAddr

Address we bind to for the API

Should be 0.0.0.0:8174 most of the time, as api connectivity is public and direct, and the port should be open it in the firewall.

bind_ui: SocketAddr

Address we bind to for exposing the Web UI

Built-in web UI is exposed as an HTTP port, and typically should have TLS terminated by Nginx/Traefik/etc. and forwarded to the locally bind port.

p2p_url: Option<SafeUrl>

Our external address for communicating with our peers

fedimint://<fqdn>:8173 for TCP/TLS p2p connectivity (legacy/standard).

Ignored when Iroh stack is used. (newer/experimental)

api_url: Option<SafeUrl>

Our API address for clients to connect to us

Typically wss://<fqdn>/ws/ for TCP/TLS connectivity (legacy/standard)

Ignored when Iroh stack is used. (newer/experimental)

enable_iroh: bool

iroh_dns: Option<SafeUrl>

Optional URL of the Iroh DNS server

iroh_relays: Vec<SafeUrl>

Optional URLs of the Iroh relays to use for registering

db_checkpoint_retention: u64

Number of checkpoints from the current session to retain on disk

bind_tokio_console: Option<SocketAddr>

Enable tokio console logging

with_jaeger: bool

Enable jaeger for tokio console logging

bind_metrics: Option<SocketAddr>

Enable prometheus metrics

force_api_secrets: ApiSecrets

Comma separated list of API secrets.

Setting it will enforce API authentication and make the Federation “private”.

The first secret in the list is the “active” one that the peer will use itself to connect to other peers. Any further one is accepted by this peer, e.g. for the purposes of smooth rotation of secret between users.

Note that the value provided here will override any other settings that the user might want to set via UI at runtime, etc. In the future, managing secrets might be possible via Admin UI and defaults will be provided via FM_DEFAULT_API_SECRETS.

Trait Implementations

impl Args for ServerOpts

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 CommandFactory for ServerOpts

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 FromArgMatches for ServerOpts

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 ServerOpts

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.