Struct breez_sdk_core::Config

pub struct Config {
    pub breezserver: String,
    pub chainnotifier_url: String,
    pub mempoolspace_url: Option<String>,
    pub working_dir: String,
    pub network: Network,
    pub payment_timeout_sec: u32,
    pub default_lsp_id: Option<String>,
    pub api_key: Option<String>,
    pub maxfee_percent: f64,
    pub exemptfee_msat: u64,
    pub node_config: NodeConfig,
}

Configuration for the Breez Services

Use Config::production or Config::staging for default configs of the different supported environments.

Fields

breezserver: String

chainnotifier_url: String

mempoolspace_url: Option<String>

If set, this is the mempool.space URL that will be used.

If not set, a list of mempool.space URLs will be used to provide fault-tolerance. If calls to the first URL fail, then the call will be repeated to the next URL, and so on.

Note that, if specified, the URL has to be in the format: https://mempool.space/api

working_dir: String

Directory in which all SDK files (DB, log) are stored. Defaults to “.”, otherwise if it’s customized, the folder should exist before starting the SDK.

network: Network

payment_timeout_sec: u32

default_lsp_id: Option<String>

api_key: Option<String>

maxfee_percent: f64

Maps to the CLN maxfeepercent config when paying invoices (lightning-pay)

exemptfee_msat: u64

Maps to the CLN exemptfee config when paying invoices (lightning-pay)

node_config: NodeConfig

Implementations

impl Config

pub fn production(api_key: String, node_config: NodeConfig) -> Self

pub fn staging(api_key: String, node_config: NodeConfig) -> Self

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoDart for Config

fn into_dart(self) -> DartAbi

Consumes Self and Performs the conversion.

impl IntoIntoDart<Config> for Config

fn into_into_dart(self) -> Self

impl IntoDartExceptPrimitive for Config