Add non-atomic ordered batch write method to KVStore traits#4379

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

Closed
joostjager wants to merge 4 commits into from
Closed

Add non-atomic ordered batch write method to KVStore traits #4379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ed79d9
Defer MonitorUpdatingPersister writes to flush()
joostjager Jan 15, 2026
eaa91ec
Add non-atomic ordered batch write method to KVStore traits
joostjager Feb 4, 2026
c8248bb
Use write_batch in MonitorUpdatingPersister flush()
joostjager Feb 5, 2026
6f20a00
Include ChannelManager in flush() write batch
joostjager Feb 5, 2026
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
131 changes: 65 additions & 66 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
None => {},
}

let mut futures = Joiner::new();
// Type A is unused but needed for inference - we use the same boxed future type as other slots
let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");

let fut = async {
kv_store
.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
channel_manager.get_cm().encode(),
)
.await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);

// Because persisting the ChannelManager is important to avoid accidental
// force-closures, go ahead and poll the future once before we do slightly more
// CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
// below. This will get it moving but won't block us for too long if the underlying
// future is actually async.
use core::future::Future;
let mut waker = dummy_waker();
let mut ctx = task::Context::from_waker(&mut waker);
match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
task::Poll::Ready(res) => futures.set_a_res(res),
task::Poll::Pending => futures.set_a(fut),
}

log_trace!(logger, "Done persisting ChannelManager.");
}
// Capture the number of pending monitor writes and whether manager needs persistence.
// We'll flush monitors and manager together in a single batch after other tasks complete.
let pending_monitor_writes = chain_monitor.pending_write_count();
let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

// Note that we want to archive stale ChannelMonitors and run a network graph prune once
// not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
res?;
}

// Flush monitors and manager together in a single batch.
// Any monitor writes that arrived after are left in the queue for the next iteration.
if pending_monitor_writes > 0 || needs_manager_persist {
log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
let manager_bytes = channel_manager.get_cm().encode();
match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
}
}

match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
sleeper(ONION_MESSAGE_HANDLER_TIMER)
}) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
}
log_trace!(logger, "Terminating background processor.");

// After we exit, ensure we persist the ChannelManager one final time - this avoids
// some races where users quit while channel updates were in-flight, with
// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
kv_store
.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
channel_manager.get_cm().encode(),
)
.await?;
// After we exit, ensure we persist the ChannelManager one final time along with any
// pending monitor writes - this avoids some races where users quit while channel updates
// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
// ChannelManager update.
let pending_monitor_writes = chain_monitor.pending_write_count();
let manager_bytes = channel_manager.get_cm().encode();
match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
Err(e) => {
log_error!(logger, "Failed final flush: {}", e);
return Err(e);
},
}

if let Some(ref scorer) = scorer {
kv_store
.write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
channel_manager.get_cm().timer_tick_occurred();
last_freshness_call = Instant::now();
}
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
(kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
channel_manager.get_cm().encode(),
))?;
log_trace!(logger, "Done persisting ChannelManager.");
// Capture the number of pending monitor writes and whether manager needs persistence.
let pending_monitor_writes = chain_monitor.pending_write_count();
let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

// Flush monitors and manager together in a single batch.
if pending_monitor_writes > 0 || needs_manager_persist {
log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
let manager_bytes = channel_manager.get_cm().encode();
match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
Ok(()) => {
log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
},
Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
}
}

if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
}
}

// After we exit, ensure we persist the ChannelManager one final time - this avoids
// some races where users quit while channel updates were in-flight, with
// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
channel_manager.get_cm().encode(),
)?;
// After we exit, ensure we persist the ChannelManager one final time along with any
// pending monitor writes - this avoids some races where users quit while channel updates
// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
// ChannelManager update.
let pending_monitor_writes = chain_monitor.pending_write_count();
let manager_bytes = channel_manager.get_cm().encode();
match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
Ok(()) => {
log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
},
Err(e) => {
log_error!(logger, "Failed final flush: {}", e);
return Err(e.into());
},
}

if let Some(ref scorer) = scorer {
kv_store.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down
78 changes: 57 additions & 21 deletions lightning/src/chain/chainmonitor.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
/// the monitor already exists in the archive.
fn archive_persisted_channel(&self, monitor_name: MonitorName);

/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
/// [`Self::update_persisted_channel`], which have completed.
/// Returns the number of pending writes in the queue.
///
/// Returning an update here is equivalent to calling
/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
/// hidden in the docs.
#[doc(hidden)]
fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
Vec::new()
/// This can be used to capture the queue size before persisting the channel manager,
/// then pass that count to [`Self::flush`] to only flush those specific updates.
fn pending_write_count(&self) -> usize {
0
}

/// Flushes pending writes to the underlying storage.
///
/// The `count` parameter specifies how many pending monitor writes to flush.
/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
///
/// The channel manager is always written first in the batch, before any monitor writes,
/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
///
/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
/// from persist methods), this method should write queued data to storage.
///
/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
FE::Target: FeeEstimator,
{
persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
&self, monitor_name: MonitorName,
monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
) -> ChannelMonitorUpdateStatus {
let notifier = Arc::clone(&self.event_notifier);
self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
self.persister.queue_new_channel(monitor_name, monitor);
ChannelMonitorUpdateStatus::InProgress
}

fn update_persisted_channel(
&self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
) -> ChannelMonitorUpdateStatus {
let notifier = Arc::clone(&self.event_notifier);
self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
ChannelMonitorUpdateStatus::InProgress
}

fn archive_persisted_channel(&self, monitor_name: MonitorName) {
self.persister.spawn_async_archive_persisted_channel(monitor_name);
}

fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
self.persister.get_and_clear_completed_updates()
fn pending_write_count(&self) -> usize {
self.persister.pending_write_count()
}

fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
_our_peerstorage_encryption_key: PeerStorageKey,
) -> Self {
let event_notifier = Arc::new(Notifier::new());
Self {
monitors: RwLock::new(new_hash_map()),
chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
_entropy_source,
pending_monitor_events: Mutex::new(Vec::new()),
highest_chain_height: AtomicUsize::new(0),
event_notifier: Arc::clone(&event_notifier),
persister: AsyncPersister { persister, event_notifier },
event_notifier: Arc::new(Notifier::new()),
persister: AsyncPersister { persister },
pending_send_only_events: Mutex::new(Vec::new()),
#[cfg(peer_storage)]
our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
.collect()
}

/// Returns the number of pending writes in the persister queue.
///
/// This can be used to capture the queue size before persisting the channel manager,
/// then pass that count to [`Self::flush`] to only flush those specific updates.
pub fn pending_write_count(&self) -> usize {
self.persister.pending_write_count()
}

/// Flushes pending writes to the underlying storage.
///
/// The `count` parameter specifies how many pending monitor writes to flush.
/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
///
/// The channel manager is always written first in the batch, before any monitor writes,
/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
///
/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
/// from persist methods), this method writes queued data to storage and signals
/// completion to the channel manager via [`Self::channel_monitor_updated`].
pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
let completed = self.persister.flush(count, channel_manager_bytes)?;
for (channel_id, update_id) in completed {
let _ = self.channel_monitor_updated(channel_id, update_id);
}
Ok(())
}

#[cfg(any(test, feature = "_test_utils"))]
pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
fn release_pending_monitor_events(
&self,
) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
let _ = self.channel_monitor_updated(channel_id, update_id);
}
let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
for monitor_state in self.monitors.read().unwrap().values() {
let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
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 non-atomic ordered batch write method to KVStore traits#4379

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

 Closed

joostjager
wants to merge
4
commits into

from

 Closed


Add non-atomic ordered batch write method to KVStore traits
#4379
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6ed79d9

Defer MonitorUpdatingPersister writes to flush()


joostjager Jan 15, 2026
eaa91ec

Add non-atomic ordered batch write method to KVStore traits


joostjager Feb 4, 2026
c8248bb

Use write_batch in MonitorUpdatingPersister flush()


joostjager Feb 5, 2026
6f20a00

Include ChannelManager in flush() write batch


joostjager Feb 5, 2026

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


131 changes: 65 additions & 66 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,11 +57,10 @@ use lightning::sign::{
use lightning::util::async_poll::MaybeSend;
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, NETWORK_GRAPH_PERSISTENCE_KEY,
	NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
	SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
	SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
use lightning::util::wakers::Future;
Expand DownExpand Up@@ -1150,39 +1149,13 @@ where
 None => {},
 }

 let mut futures = Joiner::new();
 // Type A is unused but needed for inference - we use the same boxed future type as other slots
 let mut futures: Joiner<lightning::io::Error, core::pin::Pin<Box<dyn core::future::Future<Output = Result<(), lightning::io::Error>> + Send + 'static>>, _, _, _, _> = Joiner::new();

 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");

 let fut = async {
 kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
 };
 // TODO: Once our MSRV is 1.68 we should be able to drop the Box
 let mut fut = Box::pin(fut);

 // Because persisting the ChannelManager is important to avoid accidental
 // force-closures, go ahead and poll the future once before we do slightly more
 // CPU-intensive tasks in the form of NetworkGraph pruning or scorer time-stepping
 // below. This will get it moving but won't block us for too long if the underlying
 // future is actually async.
 use core::future::Future;
 let mut waker = dummy_waker();
 let mut ctx = task::Context::from_waker(&mut waker);
 match core::pin::Pin::new(&mut fut).poll(&mut ctx) {
 task::Poll::Ready(res) => futures.set_a_res(res),
 task::Poll::Pending => futures.set_a(fut),
 }

 log_trace!(logger, "Done persisting ChannelManager.");
 }
 // Capture the number of pending monitor writes and whether manager needs persistence.
 // We'll flush monitors and manager together in a single batch after other tasks complete.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Note that we want to archive stale ChannelMonitors and run a network graph prune once
 // not long after startup before falling back to their usual infrequent runs. This avoids
Expand DownExpand Up@@ -1349,6 +1322,17 @@ where
 res?;
 }

 // Flush monitors and manager together in a single batch.
 // Any monitor writes that arrived after are left in the queue for the next iteration.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 match check_and_reset_sleeper(&mut last_onion_message_handler_call, || {
 sleeper(ONION_MESSAGE_HANDLER_TIMER)
 }) {
Expand DownExpand Up@@ -1402,17 +1386,20 @@ where
	}
	log_trace!(logger, "Terminating background processor.");

	// After we exit, ensure we persist the ChannelManager one final time - this avoids
	// some races where users quit while channel updates were in-flight, with
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	// After we exit, ensure we persist the ChannelManager one final time along with any
	// pending monitor writes - this avoids some races where users quit while channel updates
	// were in-flight, with ChannelMonitor update(s) persisted without a corresponding
	// ChannelManager update.
	let pending_monitor_writes = chain_monitor.pending_write_count();
	let manager_bytes = channel_manager.get_cm().encode();
	match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes),
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e);
 },
	}

	if let Some(ref scorer) = scorer {
 kv_store
 .write(
Expand DownExpand Up@@ -1722,15 +1709,20 @@ impl BackgroundProcessor {
 channel_manager.get_cm().timer_tick_occurred();
 last_freshness_call = Instant::now();
 }
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
 // Capture the number of pending monitor writes and whether manager needs persistence.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let needs_manager_persist = channel_manager.get_cm().get_and_clear_needs_persistence();

 // Flush monitors and manager together in a single batch.
 if pending_monitor_writes > 0 || needs_manager_persist {
 log_trace!(logger, "Persisting ChannelManager and flushing {} monitor writes...", pending_monitor_writes);
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Flushed ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => log_error!(logger, "Failed to flush chain monitor: {}", e),
 }
 }

 if let Some(liquidity_manager) = liquidity_manager.as_ref() {
Expand DownExpand Up@@ -1844,15 +1836,22 @@ impl BackgroundProcessor {
 }
 }

 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_KEY,
 channel_manager.get_cm().encode(),
 )?;
 // After we exit, ensure we persist the ChannelManager one final time along with any
 // pending monitor writes - this avoids some races where users quit while channel updates
 // were in-flight, with ChannelMonitor update(s) persisted without a corresponding
 // ChannelManager update.
 let pending_monitor_writes = chain_monitor.pending_write_count();
 let manager_bytes = channel_manager.get_cm().encode();
 match chain_monitor.flush(pending_monitor_writes, manager_bytes) {
 Ok(()) => {
 log_trace!(logger, "Final flush: ChannelManager and {} monitor writes", pending_monitor_writes)
 },
 Err(e) => {
 log_error!(logger, "Failed final flush: {}", e);
 return Err(e.into());
 },
 }

 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand Down

78 changes: 57 additions & 21 deletions
lightning/src/chain/chainmonitor.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ use crate::chain::channelmonitor::{
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Filter, WatchedOutput};
use crate::events::{self, Event, EventHandler, ReplayEvent};
use crate::io;
use crate::ln::channel_state::ChannelDetails;
#[cfg(peer_storage)]
use crate::ln::msgs::PeerStorage;
Expand DownExpand Up@@ -198,16 +199,27 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
	/// the monitor already exists in the archive.
	fn archive_persisted_channel(&self, monitor_name: MonitorName);

	/// Fetches the set of [`ChannelMonitorUpdate`]s, previously persisted with
	/// [`Self::update_persisted_channel`], which have completed.
	/// Returns the number of pending writes in the queue.
	///
	/// Returning an update here is equivalent to calling
	/// [`ChainMonitor::channel_monitor_updated`]. Because of this, this method is defaulted and
	/// hidden in the docs.
	#[doc(hidden)]
	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 Vec::new()
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	fn pending_write_count(&self) -> usize {
 0
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For implementations that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method should write queued data to storage.
	///
	/// Returns the list of completed monitor updates (channel_id, update_id) that were flushed.
	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error>;
}

struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
Expand DownExpand Up@@ -272,7 +284,6 @@ pub struct AsyncPersister<
	FE::Target: FeeEstimator,
{
	persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, BI, FE>,
	event_notifier: Arc<Notifier>,
}

impl<
Expand DownExpand Up@@ -320,26 +331,28 @@ where
 &self, monitor_name: MonitorName,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_persist_new_channel(monitor_name, monitor, notifier);
 self.persister.queue_new_channel(monitor_name, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn update_persisted_channel(
 &self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
 monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
	) -> ChannelMonitorUpdateStatus {
 let notifier = Arc::clone(&self.event_notifier);
 self.persister.spawn_async_update_channel(monitor_name, monitor_update, monitor, notifier);
 self.persister.queue_channel_update(monitor_name, monitor_update, monitor);
 ChannelMonitorUpdateStatus::InProgress
	}

	fn archive_persisted_channel(&self, monitor_name: MonitorName) {
 self.persister.spawn_async_archive_persisted_channel(monitor_name);
	}

	fn get_and_clear_completed_updates(&self) -> Vec<(ChannelId, u64)> {
 self.persister.get_and_clear_completed_updates()
	fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<Vec<(ChannelId, u64)>, io::Error> {
 crate::util::persist::poll_sync_future(self.persister.flush(count, channel_manager_bytes))
	}
}

Expand DownExpand Up@@ -440,7 +453,6 @@ impl<
 persister: MonitorUpdatingPersisterAsync<K, S, L, ES, SP, T, F>, _entropy_source: ES,
 _our_peerstorage_encryption_key: PeerStorageKey,
	) -> Self {
 let event_notifier = Arc::new(Notifier::new());
 Self {
 monitors: RwLock::new(new_hash_map()),
 chain_source,
Expand All@@ -450,8 +462,8 @@ impl<
 _entropy_source,
 pending_monitor_events: Mutex::new(Vec::new()),
 highest_chain_height: AtomicUsize::new(0),
 event_notifier: Arc::clone(&event_notifier),
 persister: AsyncPersister { persister, event_notifier },
 event_notifier: Arc::new(Notifier::new()),
 persister: AsyncPersister { persister },
 pending_send_only_events: Mutex::new(Vec::new()),
 #[cfg(peer_storage)]
 our_peerstorage_encryption_key: _our_peerstorage_encryption_key,
Expand DownExpand Up@@ -742,6 +754,33 @@ where
 .collect()
	}

	/// Returns the number of pending writes in the persister queue.
	///
	/// This can be used to capture the queue size before persisting the channel manager,
	/// then pass that count to [`Self::flush`] to only flush those specific updates.
	pub fn pending_write_count(&self) -> usize {
 self.persister.pending_write_count()
	}

	/// Flushes pending writes to the underlying storage.
	///
	/// The `count` parameter specifies how many pending monitor writes to flush.
	/// The `channel_manager_bytes` parameter contains the serialized channel manager to persist.
	///
	/// The channel manager is always written first in the batch, before any monitor writes,
	/// to ensure proper ordering (manager state should be at least as recent as monitors on disk).
	///
	/// For persisters that queue writes (returning [`ChannelMonitorUpdateStatus::InProgress`]
	/// from persist methods), this method writes queued data to storage and signals
	/// completion to the channel manager via [`Self::channel_monitor_updated`].
	pub fn flush(&self, count: usize, channel_manager_bytes: Vec<u8>) -> Result<(), io::Error> {
 let completed = self.persister.flush(count, channel_manager_bytes)?;
 for (channel_id, update_id) in completed {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 Ok(())
	}

	#[cfg(any(test, feature = "_test_utils"))]
	pub fn remove_monitor(&self, channel_id: &ChannelId) -> ChannelMonitor<ChannelSigner> {
 self.monitors.write().unwrap().remove(channel_id).unwrap().monitor
Expand DownExpand Up@@ -1497,9 +1536,6 @@ where
	fn release_pending_monitor_events(
 &self,
	) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, PublicKey)> {
 for (channel_id, update_id) in self.persister.get_and_clear_completed_updates() {
 let _ = self.channel_monitor_updated(channel_id, update_id);
 }
 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
 for monitor_state in self.monitors.read().unwrap().values() {
 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
Expand Down
Loading