Struct ldk_node::Config

pub struct Config {
    pub storage_dir_path: String,
    pub log_dir_path: Option<String>,
    pub network: Network,
    pub listening_addresses: Option<Vec<SocketAddress>>,
    pub default_cltv_expiry_delta: u32,
    pub onchain_wallet_sync_interval_secs: u64,
    pub wallet_sync_interval_secs: u64,
    pub fee_rate_cache_update_interval_secs: u64,
    pub trusted_peers_0conf: Vec<PublicKey>,
    pub probing_liquidity_limit_multiplier: u64,
    pub log_level: LogLevel,
}

Represents the configuration of an Node instance.

Defaults

Parameter	Value
storage_dir_path	/tmp/ldk_node/
log_dir_path	None
network	Bitcoin
listening_addresses	None
default_cltv_expiry_delta	144
onchain_wallet_sync_interval_secs	80
wallet_sync_interval_secs	30
fee_rate_cache_update_interval_secs	600
trusted_peers_0conf	[]
probing_liquidity_limit_multiplier	3
log_level	Debug

Fields

storage_dir_path: String

The path where the underlying LDK and BDK persist their data.

log_dir_path: Option<String>

The path where logs are stored.

If set to None, logs can be found in the logs subdirectory in Config::storage_dir_path.

network: Network

The used Bitcoin network.

listening_addresses: Option<Vec<SocketAddress>>

The addresses on which the node will listen for incoming connections.

default_cltv_expiry_delta: u32

The default CLTV expiry delta to be used for payments.

onchain_wallet_sync_interval_secs: u64

The time in-between background sync attempts of the onchain wallet, in seconds.

Note: A minimum of 10 seconds is always enforced.

wallet_sync_interval_secs: u64

The time in-between background sync attempts of the LDK wallet, in seconds.

Note: A minimum of 10 seconds is always enforced.

fee_rate_cache_update_interval_secs: u64

The time in-between background update attempts to our fee rate cache, in seconds.

Note: A minimum of 10 seconds is always enforced.

trusted_peers_0conf: Vec<PublicKey>

A list of peers that we allow to establish zero confirmation channels to us.

Note: Allowing payments via zero-confirmation channels is potentially insecure if the funding transaction ends up never being confirmed on-chain. Zero-confirmation channels should therefore only be accepted from trusted peers.

probing_liquidity_limit_multiplier: u64

The liquidity factor by which we filter the outgoing channels used for sending probes.

Channels with available liquidity less than the required amount times this value won’t be used to send pre-flight probes.

log_level: LogLevel

The level at which we log messages.

Any messages below this level will be excluded from the logs.

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

fn default() -> Self

Returns the “default value” for a type.