Struct Config

pub struct Config {
    pub liquid_electrum_url: String,
    pub bitcoin_electrum_url: String,
    pub mempoolspace_url: String,
    pub working_dir: String,
    pub cache_dir: Option<String>,
    pub network: LiquidNetwork,
    pub payment_timeout_sec: u64,
    pub zero_conf_min_fee_rate_msat: u32,
    pub zero_conf_max_amount_sat: Option<u64>,
    pub breez_api_key: Option<String>,
    pub external_input_parsers: Option<Vec<ExternalInputParser>>,
    pub use_default_external_input_parsers: bool,
}

Configuration for the Liquid SDK

Fields

liquid_electrum_url: String

bitcoin_electrum_url: String

mempoolspace_url: String

The mempool.space API URL, has to be in the format: https://mempool.space/api

working_dir: String

Directory in which the DB and log files are stored.

Prefix can be a relative or absolute path to this directory.

cache_dir: Option<String>

Directory in which the Liquid wallet cache is stored. Defaults to working_dir

network: LiquidNetwork

payment_timeout_sec: u64

Send payment timeout. See LiquidSdk::send_payment

zero_conf_min_fee_rate_msat: u32

Zero-conf minimum accepted fee-rate in millisatoshis per vbyte

zero_conf_max_amount_sat: Option<u64>

Maximum amount in satoshi to accept zero-conf payments with Defaults to DEFAULT_ZERO_CONF_MAX_SAT

breez_api_key: Option<String>

The Breez API key used for making requests to their mempool service

external_input_parsers: Option<Vec<ExternalInputParser>>

A set of external input parsers that are used by LiquidSdk::parse when the input is not recognized. See ExternalInputParser for more details on how to configure external parsing.

use_default_external_input_parsers: bool

The SDK includes some default external input parsers (DEFAULT_EXTERNAL_INPUT_PARSERS). Set this to false in order to prevent their use.

Implementations

impl Config

pub fn mainnet(breez_api_key: String) -> Self

pub fn testnet(breez_api_key: Option<String>) -> Self

pub fn zero_conf_max_amount_sat(&self) -> u64

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 Debug for Config

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

Formats the value using the given formatter.

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) -> Config

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl IntoDartExceptPrimitive for Config