-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move
Config and associated consts to config.rs
... as we're about to add a bunch more stuff, it improves readability to split these out to their own module.
- Loading branch information
Showing
4 changed files
with
154 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| use std::time::Duration; | ||
|
|
||
| use lightning::ln::msgs::SocketAddress; | ||
| use lightning::util::logger::Level as LogLevel; | ||
|
|
||
| use bitcoin::secp256k1::PublicKey; | ||
| use bitcoin::Network; | ||
|
|
||
| // Config defaults | ||
| const DEFAULT_STORAGE_DIR_PATH: &str = "/tmp/ldk_node/"; | ||
| const DEFAULT_NETWORK: Network = Network::Bitcoin; | ||
| const DEFAULT_CLTV_EXPIRY_DELTA: u32 = 144; | ||
| const DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS: u64 = 80; | ||
| const DEFAULT_LDK_WALLET_SYNC_INTERVAL_SECS: u64 = 30; | ||
| const DEFAULT_FEE_RATE_CACHE_UPDATE_INTERVAL_SECS: u64 = 60 * 10; | ||
| const DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER: u64 = 3; | ||
| const DEFAULT_LOG_LEVEL: LogLevel = LogLevel::Debug; | ||
|
|
||
| // The 'stop gap' parameter used by BDK's wallet sync. This seems to configure the threshold | ||
| // number of derivation indexes after which BDK stops looking for new scripts belonging to the wallet. | ||
| pub(crate) const BDK_CLIENT_STOP_GAP: usize = 20; | ||
|
|
||
| // The number of concurrent requests made against the API provider. | ||
| pub(crate) const BDK_CLIENT_CONCURRENCY: u8 = 4; | ||
|
|
||
| // The default Esplora server we're using. | ||
| pub(crate) const DEFAULT_ESPLORA_SERVER_URL: &str = "https://blockstream.info/api"; | ||
|
|
||
| // The timeout after which we abandon retrying failed payments. | ||
| pub(crate) const LDK_PAYMENT_RETRY_TIMEOUT: Duration = Duration::from_secs(10); | ||
|
|
||
| // The time in-between peer reconnection attempts. | ||
| pub(crate) const PEER_RECONNECTION_INTERVAL: Duration = Duration::from_secs(10); | ||
|
|
||
| // The time in-between RGS sync attempts. | ||
| pub(crate) const RGS_SYNC_INTERVAL: Duration = Duration::from_secs(60 * 60); | ||
|
|
||
| // The time in-between node announcement broadcast attempts. | ||
| pub(crate) const NODE_ANN_BCAST_INTERVAL: Duration = Duration::from_secs(60 * 60); | ||
|
|
||
| // The lower limit which we apply to any configured wallet sync intervals. | ||
| pub(crate) const WALLET_SYNC_INTERVAL_MINIMUM_SECS: u64 = 10; | ||
|
|
||
| // The length in bytes of our wallets' keys seed. | ||
| pub(crate) const WALLET_KEYS_SEED_LEN: usize = 64; | ||
|
|
||
| #[derive(Debug, Clone)] | ||
| /// 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 | | ||
| /// | ||
| /// [`Node`]: crate::Node | ||
| pub struct Config { | ||
| /// The path where the underlying LDK and BDK persist their data. | ||
| pub storage_dir_path: String, | ||
| /// The path where logs are stored. | ||
| /// | ||
| /// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`]. | ||
| pub log_dir_path: Option<String>, | ||
| /// The used Bitcoin network. | ||
| pub network: Network, | ||
| /// The addresses on which the node will listen for incoming connections. | ||
| pub listening_addresses: Option<Vec<SocketAddress>>, | ||
| /// The default CLTV expiry delta to be used for payments. | ||
| pub default_cltv_expiry_delta: u32, | ||
| /// The time in-between background sync attempts of the onchain wallet, in seconds. | ||
| /// | ||
| /// **Note:** A minimum of 10 seconds is always enforced. | ||
| pub onchain_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. | ||
| pub wallet_sync_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. | ||
| pub fee_rate_cache_update_interval_secs: u64, | ||
| /// 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. | ||
| pub trusted_peers_0conf: Vec<PublicKey>, | ||
| /// 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. | ||
| pub probing_liquidity_limit_multiplier: u64, | ||
| /// The level at which we log messages. | ||
| /// | ||
| /// Any messages below this level will be excluded from the logs. | ||
| pub log_level: LogLevel, | ||
| } | ||
|
|
||
| impl Default for Config { | ||
| fn default() -> Self { | ||
| Self { | ||
| storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(), | ||
| log_dir_path: None, | ||
| network: DEFAULT_NETWORK, | ||
| listening_addresses: None, | ||
| default_cltv_expiry_delta: DEFAULT_CLTV_EXPIRY_DELTA, | ||
| onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS, | ||
| wallet_sync_interval_secs: DEFAULT_LDK_WALLET_SYNC_INTERVAL_SECS, | ||
| fee_rate_cache_update_interval_secs: DEFAULT_FEE_RATE_CACHE_UPDATE_INTERVAL_SECS, | ||
| trusted_peers_0conf: Vec::new(), | ||
| probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER, | ||
| log_level: DEFAULT_LOG_LEVEL, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Returns a [`Config`] object populated with default values. | ||
| /// | ||
| /// See the documentation of [`Config`] for more information on the used defaults. | ||
| /// | ||
| /// This is mostly meant for use in bindings, in Rust this is synonymous with | ||
| /// [`Config::default()`]. | ||
| pub fn default_config() -> Config { | ||
| Config::default() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters