Struct GatewayOpts 

pub struct GatewayOpts {

    pub mode: LightningMode,
    pub data_dir: PathBuf,
    listen: SocketAddr,
    api_addr: SafeUrl,
    bcrypt_password_hash: String,
    network: Network,
    num_route_hints: u32,
    lightning_module_mode: LightningModuleMode,
    pub db_backend: DatabaseBackend,
    pub bitcoind_username: Option<String>,
    pub bitcoind_password: Option<String>,
    pub bitcoind_url: Option<SafeUrl>,
    pub esplora_url: Option<SafeUrl>,
}

Command line parameters for starting the gateway. mode, data_dir, listen, and api_addr are all required.

Fields

mode: LightningMode

data_dir: PathBuf

Path to folder containing gateway config and data files

listen: SocketAddr

Gateway webserver listen address

api_addr: SafeUrl

Public URL from which the webserver API is reachable

bcrypt_password_hash: String

Gateway webserver authentication bcrypt password hash

network: Network

Bitcoin network this gateway will be running on

num_route_hints: u32

Number of route hints to return in invoices

lightning_module_mode: LightningModuleMode

The Lightning module to use: LNv1, LNv2, or both

db_backend: DatabaseBackend

Database backend to use.

bitcoind_username: Option<String>

The username to use when connecting to bitcoind

bitcoind_password: Option<String>

The password to use when connecting to bitcoind

bitcoind_url: Option<SafeUrl>

Bitcoind RPC URL, e.g. http://127.0.0.1:8332 This should not include authentication parameters, they should be included in FM_BITCOIND_USERNAME and FM_BITCOIND_PASSWORD

esplora_url: Option<SafeUrl>

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

Implementations

impl GatewayOpts

pub fn to_gateway_parameters(&self) -> Result<GatewayParameters>

Converts the command line parameters into a helper struct the Gateway uses to store runtime parameters.

Trait Implementations

impl Args for GatewayOpts

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 GatewayOpts

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 GatewayOpts

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 GatewayOpts

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.