Struct fbbe::Arguments

pub struct Arguments {
    pub tx_cache_size: usize,
    pub fetch_parallelism: usize,
    pub bitcoind_addr: Option<SocketAddr>,
    pub network: Option<Network>,
    pub local_addr: Option<SocketAddr>,
    pub other_network: Vec<Network>,
}

Fields

tx_cache_size: usize

Number of transaction kept in memory in a least recently used cache to reduce the number of requests of transactions to bitcoin core

fetch_parallelism: usize

Some requests to the bitcoin core are concurrent, this set the desired parallelism. Note there is a limit of open files that this setting too high could trigger. See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#risks

bitcoind_addr: Option<SocketAddr>

default to “127.0.0.1:” where port depend on the network used, eg 8332 for mainnnet.

network: Option<Network>

default value: bitcoin

other possible values: testnet, signet

local_addr: Option<SocketAddr>

The socket address this service will bind on. Default value depends on the network:

• mainnet: “127.0.0.1:3000”
• testnet: “127.0.0.1:3001”
• signet: “127.0.0.1:3002”
• regtest: “127.0.0.1:3003”

other_network: Vec<Network>

If the setup involve multiple networks this must be set accordingly. An header with a link to all the network is generated. Links are prepended the network if it isn’t mainet (eg /testnet/t/xxx...) Note the routes are still working without the network, it is duty of a frontend to redirect the path to appropriate port. eg.

location = /testnet {
  return 302 /testnet/;
}
location /testnet/ {
  proxy_pass http://10.0.0.7:3001/;
}

Trait Implementations

impl Args for Arguments

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.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl CommandFactory for Arguments

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 Arguments

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 Arguments

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere 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<RichFormatter>>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<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.