Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Feb 3, 2026
Merged

Add AChainMonitor trait and use it in background processor #4371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 58 additions & 43 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
'a,
UL: UtxoLookup,
CF: chain::Filter,
T: BroadcasterInterface,
F: FeeEstimator,
G: Deref<Target = NetworkGraph<L>>,
L: Logger,
P: Deref,
EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
EventHandler: Fn(Event) -> EventHandlerFuture,
ES: EntropySource,
M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
M: Deref,
CM: Deref,
OM: Deref,
PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
D: Deref,
O: OutputSpender,
K: KVStore,
OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
OS: Deref<
Target = OutputSweeper<
<M::Target as AChainMonitor>::Broadcaster,
D,
<M::Target as AChainMonitor>::FeeEstimator,
<M::Target as AChainMonitor>::Filter,
K,
L,
O,
>,
>,
S: Deref<Target = SC>,
SC: for<'b> WriteableScore<'b>,
SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
CM::Target: AChannelManager,
OM::Target: AOnionMessenger,
PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
channel_manager.get_cm().timer_tick_occurred();
log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
chain_monitor.rebroadcast_pending_claims();
chain_monitor.get_cm().rebroadcast_pending_claims();

let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

loop {
channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
chain_monitor.process_pending_events_async(async_event_handler).await;
chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
if let Some(om) = &onion_messenger {
om.get_om().process_pending_events_async(async_event_handler).await
}
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
let fut = Selector {
a: sleeper(sleep_delay),
b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
c: chain_monitor.get_update_future(),
c: chain_monitor.get_cm().get_update_future(),
d: om_fut,
e: lm_fut,
f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
};
if archive_timer_elapsed {
log_trace!(logger, "Archiving stale ChannelMonitors.");
chain_monitor.archive_fully_resolved_channel_monitors();
chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
have_archived = true;
log_trace!(logger, "Archived stale ChannelMonitors.");
}
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
Some(false) => {
log_trace!(logger, "Rebroadcasting monitor's pending claims");
chain_monitor.rebroadcast_pending_claims();
chain_monitor.get_cm().rebroadcast_pending_claims();
},
Some(true) => break,
None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
UL: UtxoLookup,
CF: chain::Filter,
T: BroadcasterInterface,
F: FeeEstimator,
G: Deref<Target = NetworkGraph<L>>,
L: Logger,
P: Deref,
EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
EventHandler: Fn(Event) -> EventHandlerFuture,
ES: EntropySource,
M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
M: Deref,
CM: Deref,
OM: Deref,
PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
D: Deref,
O: OutputSpender,
K: Deref,
OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
OS: Deref<
Target = OutputSweeperSync<
<M::Target as AChainMonitor>::Broadcaster,
D,
<M::Target as AChainMonitor>::FeeEstimator,
<M::Target as AChainMonitor>::Filter,
K,
L,
O,
>,
>,
S: Deref<Target = SC>,
SC: for<'b> WriteableScore<'b>,
SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
CM::Target: AChannelManager,
OM::Target: AOnionMessenger,
PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
pub fn start<
'a,
UL: 'static + UtxoLookup,
CF: 'static + chain::Filter,
T: 'static + BroadcasterInterface,
F: 'static + FeeEstimator + Send,
G: 'static + Deref<Target = NetworkGraph<L>>,
L: 'static + Deref + Send,
P: 'static + Deref,
EH: 'static + EventHandler + Send,
ES: 'static + EntropySource + Send,
M: 'static
+ Deref<
Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
>
+ Send
+ Sync,
M: 'static + Deref + Send + Sync,
CM: 'static + Deref + Send,
OM: 'static + Deref + Send,
PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
D: 'static + Deref,
O: 'static + OutputSpender,
K: 'static + Deref + Send,
OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
OS: 'static
+ Deref<
Target = OutputSweeperSync<
<M::Target as AChainMonitor>::Broadcaster,
D,
<M::Target as AChainMonitor>::FeeEstimator,
<M::Target as AChainMonitor>::Filter,
K,
L,
O,
>,
>
+ Send,
>(
kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
) -> Self
where
L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
CM::Target: AChannelManager,
OM::Target: AOnionMessenger,
PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
channel_manager.get_cm().timer_tick_occurred();
log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
chain_monitor.rebroadcast_pending_claims();
chain_monitor.get_cm().rebroadcast_pending_claims();

let mut last_freshness_call = Instant::now();
let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

loop {
channel_manager.get_cm().process_pending_events(&event_handler);
chain_monitor.process_pending_events(&event_handler);
chain_monitor.get_cm().process_pending_events(&event_handler);
if let Some(om) = &onion_messenger {
om.get_om().process_pending_events(&event_handler)
};
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
let gv_fut = gossip_sync.validation_completion_future();
let always_futures = [
channel_manager.get_cm().get_event_or_persistence_needed_future(),
chain_monitor.get_update_future(),
chain_monitor.get_cm().get_update_future(),
];
let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
if archive_timer_elapsed {
log_trace!(logger, "Archiving stale ChannelMonitors.");
chain_monitor.archive_fully_resolved_channel_monitors();
chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
have_archived = true;
last_archive_call = Instant::now();
log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
}
if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
log_trace!(logger, "Rebroadcasting monitor's pending claims");
chain_monitor.rebroadcast_pending_claims();
chain_monitor.get_cm().rebroadcast_pending_claims();
last_rebroadcast_call = Instant::now();
}
}
Expand Down
60 changes: 60 additions & 0 deletions lightning/src/chain/chainmonitor.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
/// A type implementing [`EcdsaChannelSigner`].
type Signer: EcdsaChannelSigner + Sized;
/// A type implementing [`chain::Filter`].
type Filter: chain::Filter;
/// A type implementing [`BroadcasterInterface`].
type Broadcaster: BroadcasterInterface;
/// A type implementing [`FeeEstimator`].
type FeeEstimator: FeeEstimator;
/// A type implementing [`Logger`].
type Logger: Logger;
/// A type that derefs to [`Persist`].
type Persister: Deref<Target = Self::PersisterTarget>;
/// The target of [`Self::Persister`].
type PersisterTarget: Persist<Self::Signer> + ?Sized;
/// A type implementing [`EntropySource`].
type EntropySource: EntropySource;
/// Returns a reference to the actual [`ChainMonitor`] object.
fn get_cm(
&self,
) -> &ChainMonitor<
Self::Signer,
Self::Filter,
Self::Broadcaster,
Self::FeeEstimator,
Self::Logger,
Self::Persister,
Self::EntropySource,
>;
}

impl<
ChannelSigner: EcdsaChannelSigner,
C: chain::Filter,
T: BroadcasterInterface,
F: FeeEstimator,
L: Logger,
P: Deref,
ES: EntropySource,
> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
P::Target: Persist<ChannelSigner>,
{
type Signer = ChannelSigner;
type Filter = C;
type Broadcaster = T;
type FeeEstimator = F;
type Logger = L;
type Persister = P;
type PersisterTarget = P::Target;
type EntropySource = ES;
fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
self
}
}

#[cfg(test)]
mod tests {
use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
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
Add AChainMonitor trait and use it in background processor#4371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Feb 3, 2026
 Merged


Add AChainMonitor trait and use it in background processor
#4371
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


101 changes: 58 additions & 43 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,9 +30,11 @@ mod fwd_batch;

use fwd_batch::BatchDelay;

#[cfg(not(c_bindings))]
use lightning::chain;
#[cfg(not(c_bindings))]
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::chain::chainmonitor::AChainMonitor;
#[cfg(feature = "std")]
use lightning::events::EventHandler;
#[cfg(feature = "std")]
Expand All@@ -50,9 +52,9 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
use lightning::sign::{
	ChangeDestinationSource, ChangeDestinationSourceSync, EntropySource, OutputSpender,
};
#[cfg(not(c_bindings))]
use lightning::sign::EntropySource;
use lightning::sign::{ChangeDestinationSource, ChangeDestinationSourceSync, OutputSpender};
#[cfg(not(c_bindings))]
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
Expand DownExpand Up@@ -118,6 +120,7 @@ use alloc::vec::Vec;
///
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::timer_tick_occurred`]: lightning::ln::channelmanager::ChannelManager::timer_tick_occurred
/// [`ChainMonitor::rebroadcast_pending_claims`]: lightning::chain::chainmonitor::ChainMonitor::rebroadcast_pending_claims
/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
/// [`Event`]: lightning::events::Event
/// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
Expand DownExpand Up@@ -923,16 +926,11 @@ use futures_util::{dummy_waker, Joiner, OptionalSelector, Selector, SelectorOutp
pub async fn process_events_async<
	'a,
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -942,7 +940,17 @@ pub async fn process_events_async<
	D: Deref,
	O: OutputSpender,
	K: KVStore,
	OS: Deref<Target = OutputSweeper<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeper<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -955,7 +963,7 @@ pub async fn process_events_async<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1004,7 +1012,7 @@ where
	log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
	channel_manager.get_cm().timer_tick_occurred();
	log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
	chain_monitor.rebroadcast_pending_claims();
	chain_monitor.get_cm().rebroadcast_pending_claims();

	let mut last_freshness_call = sleeper(FRESHNESS_TIMER);
	let mut last_onion_message_handler_call = sleeper(ONION_MESSAGE_HANDLER_TIMER);
Expand All@@ -1022,7 +1030,7 @@ where

	loop {
 channel_manager.get_cm().process_pending_events_async(async_event_handler).await;
 chain_monitor.process_pending_events_async(async_event_handler).await;
 chain_monitor.get_cm().process_pending_events_async(async_event_handler).await;
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events_async(async_event_handler).await
 }
Expand DownExpand Up@@ -1072,7 +1080,7 @@ where
 let fut = Selector {
 a: sleeper(sleep_delay),
 b: channel_manager.get_cm().get_event_or_persistence_needed_future(),
 c: chain_monitor.get_update_future(),
 c: chain_monitor.get_cm().get_update_future(),
 d: om_fut,
 e: lm_fut,
 f: gv_fut,
Expand DownExpand Up@@ -1164,7 +1172,7 @@ where
 };
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 log_trace!(logger, "Archived stale ChannelMonitors.");
 }
Expand DownExpand Up@@ -1354,7 +1362,7 @@ where
 match check_and_reset_sleeper(&mut last_rebroadcast_call, || sleeper(REBROADCAST_TIMER)) {
 Some(false) => {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 },
 Some(true) => break,
 None => {},
Expand DownExpand Up@@ -1416,16 +1424,11 @@ fn check_and_reset_sleeper<
/// synchronous background persistence.
pub async fn process_events_async_with_kv_store_sync<
	UL: UtxoLookup,
	CF: chain::Filter,
	T: BroadcasterInterface,
	F: FeeEstimator,
	G: Deref<Target = NetworkGraph<L>>,
	L: Logger,
	P: Deref,
	EventHandlerFuture: core::future::Future<Output = Result<(), ReplayEvent>>,
	EventHandler: Fn(Event) -> EventHandlerFuture,
	ES: EntropySource,
	M: Deref<Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>>,
	M: Deref,
	CM: Deref,
	OM: Deref,
	PGS: Deref<Target = P2PGossipSync<G, UL, L>>,
Expand All@@ -1435,7 +1438,17 @@ pub async fn process_events_async_with_kv_store_sync<
	D: Deref,
	O: OutputSpender,
	K: Deref,
	OS: Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>>,
	OS: Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
	>,
	S: Deref<Target = SC>,
	SC: for<'b> WriteableScore<'b>,
	SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
Expand All@@ -1448,7 +1461,7 @@ pub async fn process_events_async_with_kv_store_sync<
	sleeper: Sleeper, mobile_interruptable_platform: bool, fetch_time: FetchTime,
) -> Result<(), lightning::io::Error>
where
P::Target: Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
	CM::Target: AChannelManager,
	OM::Target: AOnionMessenger,
	PM::Target: APeerManager,
Expand DownExpand Up@@ -1523,20 +1536,10 @@ impl BackgroundProcessor {
	pub fn start<
 'a,
 UL: 'static + UtxoLookup,
 CF: 'static + chain::Filter,
 T: 'static + BroadcasterInterface,
 F: 'static + FeeEstimator + Send,
 G: 'static + Deref<Target = NetworkGraph<L>>,
 L: 'static + Deref + Send,
 P: 'static + Deref,
 EH: 'static + EventHandler + Send,
 ES: 'static + EntropySource + Send,
 M: 'static
 + Deref<
 Target = ChainMonitor<<CM::Target as AChannelManager>::Signer, CF, T, F, L, P, ES>,
 >
 + Send
 + Sync,
 M: 'static + Deref + Send + Sync,
 CM: 'static + Deref + Send,
 OM: 'static + Deref + Send,
 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send,
Expand All@@ -1548,15 +1551,27 @@ impl BackgroundProcessor {
 D: 'static + Deref,
 O: 'static + OutputSpender,
 K: 'static + Deref + Send,
 OS: 'static + Deref<Target = OutputSweeperSync<T, D, F, CF, K, L, O>> + Send,
 OS: 'static
 + Deref<
 Target = OutputSweeperSync<
 <M::Target as AChainMonitor>::Broadcaster,
 D,
 <M::Target as AChainMonitor>::FeeEstimator,
 <M::Target as AChainMonitor>::Filter,
 K,
 L,
 O,
 >,
 >
 + Send,
	>(
 kv_store: K, event_handler: EH, chain_monitor: M, channel_manager: CM,
 onion_messenger: Option<OM>, gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM,
 liquidity_manager: Option<LM>, sweeper: Option<OS>, logger: L, scorer: Option<S>,
	) -> Self
	where
 L::Target: 'static + Logger,
P::Target: 'static + Persist<<CM::Target as AChannelManager>::Signer>,
M::Target: AChainMonitor<Signer = <CM::Target as AChannelManager>::Signer, Logger = L>,
 CM::Target: AChannelManager,
 OM::Target: AOnionMessenger,
 PM::Target: APeerManager,
Expand DownExpand Up@@ -1596,7 +1611,7 @@ impl BackgroundProcessor {
 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 channel_manager.get_cm().timer_tick_occurred();
 log_trace!(logger, "Rebroadcasting monitor's pending claims on startup");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();

 let mut last_freshness_call = Instant::now();
 let mut last_onion_message_handler_call = Instant::now();
Expand All@@ -1615,7 +1630,7 @@ impl BackgroundProcessor {

 loop {
 channel_manager.get_cm().process_pending_events(&event_handler);
 chain_monitor.process_pending_events(&event_handler);
 chain_monitor.get_cm().process_pending_events(&event_handler);
 if let Some(om) = &onion_messenger {
 om.get_om().process_pending_events(&event_handler)
 };
Expand DownExpand Up@@ -1648,7 +1663,7 @@ impl BackgroundProcessor {
 let gv_fut = gossip_sync.validation_completion_future();
 let always_futures = [
 channel_manager.get_cm().get_event_or_persistence_needed_future(),
 chain_monitor.get_update_future(),
 chain_monitor.get_cm().get_update_future(),
 ];
 let futures = always_futures.into_iter().chain(om_fut).chain(lm_fut).chain(gv_fut);
 let sleeper = Sleeper::from_futures(futures);
Expand DownExpand Up@@ -1701,7 +1716,7 @@ impl BackgroundProcessor {
 let archive_timer_elapsed = last_archive_call.elapsed() > archive_timer;
 if archive_timer_elapsed {
 log_trace!(logger, "Archiving stale ChannelMonitors.");
 chain_monitor.archive_fully_resolved_channel_monitors();
 chain_monitor.get_cm().archive_fully_resolved_channel_monitors();
 have_archived = true;
 last_archive_call = Instant::now();
 log_trace!(logger, "Archived stale ChannelMonitors.");
Expand DownExpand Up@@ -1786,7 +1801,7 @@ impl BackgroundProcessor {
 }
 if last_rebroadcast_call.elapsed() > REBROADCAST_TIMER {
 log_trace!(logger, "Rebroadcasting monitor's pending claims");
 chain_monitor.rebroadcast_pending_claims();
 chain_monitor.get_cm().rebroadcast_pending_claims();
 last_rebroadcast_call = Instant::now();
 }
 }
Expand Down

60 changes: 60 additions & 0 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1488,6 +1488,66 @@ where
	}
}

/// A trivial trait which describes any [`ChainMonitor`].
///
/// This is not exported to bindings users as general cover traits aren't useful in other
/// languages.
pub trait AChainMonitor {
	/// A type implementing [`EcdsaChannelSigner`].
	type Signer: EcdsaChannelSigner + Sized;
	/// A type implementing [`chain::Filter`].
	type Filter: chain::Filter;
	/// A type implementing [`BroadcasterInterface`].
	type Broadcaster: BroadcasterInterface;
	/// A type implementing [`FeeEstimator`].
	type FeeEstimator: FeeEstimator;
	/// A type implementing [`Logger`].
	type Logger: Logger;
	/// A type that derefs to [`Persist`].
	type Persister: Deref<Target = Self::PersisterTarget>;
	/// The target of [`Self::Persister`].
	type PersisterTarget: Persist<Self::Signer> + ?Sized;
	/// A type implementing [`EntropySource`].
	type EntropySource: EntropySource;
	/// Returns a reference to the actual [`ChainMonitor`] object.
	fn get_cm(
 &self,
	) -> &ChainMonitor<
 Self::Signer,
 Self::Filter,
 Self::Broadcaster,
 Self::FeeEstimator,
 Self::Logger,
 Self::Persister,
 Self::EntropySource,
	>;
}

impl<
 ChannelSigner: EcdsaChannelSigner,
 C: chain::Filter,
 T: BroadcasterInterface,
 F: FeeEstimator,
 L: Logger,
 P: Deref,
 ES: EntropySource,
	> AChainMonitor for ChainMonitor<ChannelSigner, C, T, F, L, P, ES>
where
	P::Target: Persist<ChannelSigner>,
{
	type Signer = ChannelSigner;
	type Filter = C;
	type Broadcaster = T;
	type FeeEstimator = F;
	type Logger = L;
	type Persister = P;
	type PersisterTarget = P::Target;
	type EntropySource = ES;
	fn get_cm(&self) -> &ChainMonitor<ChannelSigner, C, T, F, L, P, ES> {
 self
	}
}

#[cfg(test)]
mod tests {
	use crate::chain::channelmonitor::ANTI_REORG_DELAY;
Expand Down
Loading