Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 179 additions & 0 deletions src/builder.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,7 @@ use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::asynchronous::om_mailbox::OnionMessageMailbox;
use crate::peer_store::PeerStore;
use crate::probing::{HighCapacityStrategy, ProbingService, ProbingStrategy};
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
Expand DownExpand Up@@ -129,6 +130,56 @@ struct LiquiditySourceConfig {
lsps2_service: Option<LSPS2ServiceConfig>,
}

#[derive(Clone, Debug)]
struct ProbingServiceConfig {
/// Time in seconds between consecutive probing attempts.
probing_interval_secs: u64,

/// Amount in milli-satoshis used for each probe.
probing_amount_msat: u64,

/// Configuration for the probing strategy as a shareable trait-object.
strategy: ProbingStrategyConfig,
}

pub enum ProbingStrategyConfig {
Custom { strategy: Arc<dyn ProbingStrategy + Send + Sync> },
HighCapacity { max_targets_per_cycle: usize, target_cache_reuse_limit: usize },
}

impl fmt::Debug for ProbingStrategyConfig {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Custom { .. } => {
f.debug_struct("Custom").field("strategy", &"<ProbingStrategy>").finish()
},
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => f
.debug_struct("HighCapacity")
.field("max_targets", max_targets)
.field("max_reloads", max_reloads)
.finish(),
}
}
}

impl Clone for ProbingStrategyConfig {
fn clone(&self) -> Self {
match self {
Self::Custom { strategy } => Self::Custom { strategy: Arc::clone(strategy) },
Self::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Self::HighCapacity {
max_targets_per_cycle: *max_targets,
target_cache_reuse_limit: *max_reloads,
},
}
}
}

#[derive(Clone)]
enum LogWriterConfig {
File { log_file_path: Option<String>, max_log_level: Option<LogLevel> },
Expand DownExpand Up@@ -253,6 +304,7 @@ pub struct NodeBuilder {
async_payments_role: Option<AsyncPaymentsRole>,
runtime_handle: Option<tokio::runtime::Handle>,
pathfinding_scores_sync_config: Option<PathfindingScoresSyncConfig>,
probing_service_config: Option<ProbingServiceConfig>,
}

impl NodeBuilder {
Expand All@@ -271,6 +323,7 @@ impl NodeBuilder {
let log_writer_config = None;
let runtime_handle = None;
let pathfinding_scores_sync_config = None;
let probing_service_config = None;
Self {
config,
entropy_source_config,
Expand All@@ -281,6 +334,7 @@ impl NodeBuilder {
runtime_handle,
async_payments_role: None,
pathfinding_scores_sync_config,
probing_service_config,
}
}

Expand DownExpand Up@@ -488,6 +542,55 @@ impl NodeBuilder {
self
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::Custom { strategy: Arc::new(strategy) },
});
self
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&mut self, probing_interval_secs: u64, probing_amount_msat: u64,
max_targets_per_cycle: usize, target_cache_reuse_limit: usize,
) -> &mut Self {
self.probing_service_config = Some(ProbingServiceConfig {
probing_interval_secs,
probing_amount_msat,
strategy: ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle,
target_cache_reuse_limit,
},
});
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -744,6 +847,7 @@ impl NodeBuilder {
runtime,
logger,
Arc::new(vss_store),
self.probing_service_config.as_ref(),
)
}

Expand DownExpand Up@@ -778,6 +882,7 @@ impl NodeBuilder {
runtime,
logger,
kv_store,
self.probing_service_config.as_ref(),
)
}
}
Expand DownExpand Up@@ -977,6 +1082,51 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config);
}

/// Configures the probing service with a custom target selection strategy.
///
/// This allows full control over how probing targets are selected by providing
/// a custom implementation of the [`ProbingStrategy`] trait.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `strategy` - Custom [`ProbingStrategy`] implementation
///
/// [`ProbingStrategy`]: crate::probing::ProbingStrategy
pub fn set_probing_service_with_custom_strategy<T: ProbingStrategy + Send + Sync + 'static>(
&self, probing_interval_secs: u64, probing_amount_msat: u64, strategy: T,
) {
self.inner.write().unwrap().set_probing_service_with_custom_strategy(
probing_interval_secs,
probing_amount_msat,
strategy,
);
}

/// Configures the probing service with the built-in high-capacity strategy.
///
/// Targets peers with the highest total channel capacity to assess liquidity
/// on the most significant network routes.
///
/// # Parameters
/// * `probing_interval_secs` - Seconds between probing cycles
/// * `probing_amount_msat` - Amount in milli-satoshis per probe
/// * `max_targets_per_cycle` - Maximum peers to probe each cycle
/// * `target_cache_reuse_limit` - Number of cycles to reuse targets before refreshing.
/// Acts as a cache: targets are reloaded from the network graph only after this many cycles,
/// reducing overhead while adapting to network changes.
pub fn set_probing_service_with_high_capacity_strategy(
&self, probing_interval_secs: u64, probing_amount_msat: u64, max_targets_per_cycle: usize,
target_cache_reuse_limit: usize,
) {
self.inner.write().unwrap().set_probing_service_with_high_capacity_strategy(
probing_interval_secs,
probing_amount_msat,
max_targets_per_cycle,
target_cache_reuse_limit,
);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -1142,6 +1292,7 @@ fn build_with_store_internal(
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, seed_bytes: [u8; 64], runtime: Arc<Runtime>,
logger: Arc<Logger>, kv_store: Arc<DynStore>,
probing_service_config: Option<&ProbingServiceConfig>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1767,6 +1918,33 @@ fn build_with_store_internal(

let pathfinding_scores_sync_url = pathfinding_scores_sync_config.map(|c| c.url.clone());

let probing_service = if let Some(pro_ser) = probing_service_config {
let strategy: Arc<dyn ProbingStrategy + Send + Sync> = match &pro_ser.strategy {
ProbingStrategyConfig::Custom { strategy } => Arc::clone(strategy),
ProbingStrategyConfig::HighCapacity {
max_targets_per_cycle: max_targets,
target_cache_reuse_limit: max_reloads,
} => Arc::new(HighCapacityStrategy::new(
Arc::clone(&network_graph),
*max_targets,
*max_reloads,
)),
};
Some(Arc::new(ProbingService::new(
pro_ser.probing_interval_secs,
pro_ser.probing_amount_msat,
Arc::clone(&strategy),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
Arc::clone(&is_running),
Arc::clone(&payment_store),
)))
} else {
None
};

Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1797,6 +1975,7 @@ fn build_with_store_internal(
node_metrics,
om_mailbox,
async_payments_role,
probing_service,
})
}

Expand Down
35 changes: 35 additions & 0 deletions src/graph.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ use lightning::routing::gossip::RoutingFees;
#[cfg(not(feature = "uniffi"))]
use lightning::routing::gossip::{ChannelInfo, NodeInfo};

use std::cmp::Reverse;
use std::collections::{BinaryHeap, HashMap};

use crate::types::Graph;

/// Represents the network as nodes and channels between them.
Expand DownExpand Up@@ -48,6 +51,38 @@ impl NetworkGraph {
pub fn node(&self, node_id: &NodeId) -> Option<NodeInfo> {
self.inner.read_only().nodes().get(node_id).cloned().map(|n| n.into())
}

/// Selects nodes with the highest total channel capacity in the network.
pub fn select_highest_capacity_nodes(&self, quantity_nodes: usize) -> Vec<NodeId> {
// Calculate total capacity for each node by summing all their channel capacities
let node_capacities = self.inner.read_only().channels().unordered_iter().fold(
HashMap::new(),
|mut acc, (_, chan_info)| {
let cap = chan_info.capacity_sats.unwrap_or(0);
*acc.entry(chan_info.node_one).or_insert(0) += cap;
*acc.entry(chan_info.node_two).or_insert(0) += cap;
acc
},
);

// Use a min-heap to efficiently track the top N nodes by capacity
node_capacities
.into_iter()
.fold(BinaryHeap::with_capacity(quantity_nodes), |mut top_heap, (node_id, cap)| {
if top_heap.len() < quantity_nodes {
top_heap.push(Reverse((cap, node_id)));
} else if let Some(Reverse((min_cap, _))) = top_heap.peek() {
if cap > *min_cap {
top_heap.pop();
top_heap.push(Reverse((cap, node_id)));
}
}
top_heap
})
.into_iter()
.map(|Reverse((_, node_id))| node_id)
.collect()
}
}

/// Details about a channel (both directions).
Expand Down
30 changes: 30 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -96,6 +96,7 @@ pub mod logger;
mod message_handler;
pub mod payment;
mod peer_store;
mod probing;
mod runtime;
mod scoring;
mod tx_broadcaster;
Expand DownExpand Up@@ -149,6 +150,8 @@ use payment::{
UnifiedQrPayment,
};
use peer_store::{PeerInfo, PeerStore};
use probing::ProbingService;
pub use probing::ProbingStrategy;
use rand::Rng;
use runtime::Runtime;
use types::{
Expand DownExpand Up@@ -196,6 +199,7 @@ pub struct Node {
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<Logger>>>,
payment_store: Arc<PaymentStore>,
probing_service: Option<Arc<ProbingService>>,
is_running: Arc<RwLock<bool>>,
node_metrics: Arc<RwLock<NodeMetrics>>,
om_mailbox: Option<Arc<OnionMessageMailbox>>,
Expand DownExpand Up@@ -625,6 +629,32 @@ impl Node {
});
}

if let Some(probing_service) = self.probing_service.as_ref() {
let mut stop_probing_service = self.stop_sender.subscribe();
let probing_service = Arc::clone(probing_service);
let probing_logger = Arc::clone(&self.logger);

self.runtime.spawn_cancellable_background_task(async move {
let mut interval = tokio::time::interval(Duration::from_secs(
probing_service.probing_interval_secs,
));
loop {
tokio::select! {
_ = stop_probing_service.changed() => {
log_debug!(
probing_logger,
"Stopping probing service.",
);
return;
}
_ = interval.tick() => {
probing_service.handle_probing();
}
}
}
});
}

log_info!(self.logger, "Startup complete.");
*is_running_lock = true;
Ok(())
Expand Down
Loading
Loading