fixup: Serialise ChannelMonitors and send them over inside Peer Storage

Author: adi2011

lightning-background-processor/src/lib.rs

@@ -1887,7 +1887,9 @@ mod tests {
 				Arc::clone(&logger),
 				Arc::clone(&fee_estimator),
 				Arc::clone(&kv_store),
+				#[cfg(peer_storage)]
 				Arc::clone(&keys_manager),
+				#[cfg(peer_storage)]
 				keys_manager.get_peer_storage_key(),
 			));
 			let best_block = BestBlock::from_network(network);

lightning/src/chain/chainmonitor.rs

@@ -38,12 +38,17 @@ use crate::chain::transaction::{OutPoint, TransactionData};
 use crate::chain::{ChannelMonitorUpdateStatus, Filter, WatchedOutput};
 use crate::events::{self, Event, EventHandler, ReplayEvent};
 use crate::ln::channel_state::ChannelDetails;
-use crate::ln::msgs::{self, BaseMessageHandler, Init, MessageSendEvent, SendOnlyMessageHandler};
+#[cfg(peer_storage)]
+use crate::ln::msgs::PeerStorage;
+use crate::ln::msgs::{BaseMessageHandler, Init, MessageSendEvent, SendOnlyMessageHandler};
+#[cfg(peer_storage)]
 use crate::ln::our_peer_storage::{DecryptedOurPeerStorage, PeerStorageMonitorHolder};
 use crate::ln::types::ChannelId;
 use crate::prelude::*;
 use crate::sign::ecdsa::EcdsaChannelSigner;
-use crate::sign::{EntropySource, PeerStorageKey};
+use crate::sign::EntropySource;
+#[cfg(peer_storage)]
+use crate::sign::PeerStorageKey;
 use crate::sync::{Mutex, MutexGuard, RwLock, RwLockReadGuard};
 use crate::types::features::{InitFeatures, NodeFeatures};
 use crate::util::errors::APIError;
@@ -53,6 +58,8 @@ use crate::util::persist::MonitorName;
 use crate::util::ser::{VecWriter, Writeable};
 use crate::util::wakers::{Future, Notifier};
 use bitcoin::secp256k1::PublicKey;
+#[cfg(peer_storage)]
+use core::iter::Cycle;
 use core::ops::Deref;
 use core::sync::atomic::{AtomicUsize, Ordering};
 
@@ -268,6 +275,8 @@ pub struct ChainMonitor<
 	logger: L,
 	fee_estimator: F,
 	persister: P,
+
+	#[cfg(peer_storage)]
 	entropy_source: ES,
 	/// "User-provided" (ie persistence-completion/-failed) [`MonitorEvent`]s. These came directly
 	/// from the user and not from a [`ChannelMonitor`].
@@ -282,7 +291,9 @@ pub struct ChainMonitor<
 	/// Messages to send to the peer. This is currently used to distribute PeerStorage to channel partners.
 	pending_send_only_events: Mutex<Vec<MessageSendEvent>>,
 
+	#[cfg(peer_storage)]
 	our_peerstorage_encryption_key: PeerStorageKey,
+	_phantom: std::marker::PhantomData<ES>,
 }
 
 impl<
@@ -479,6 +490,27 @@ where
 	/// [`NodeSigner`]: crate::sign::NodeSigner
 	/// [`NodeSigner::get_peer_storage_key`]: crate::sign::NodeSigner::get_peer_storage_key
 	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+	#[cfg(not(peer_storage))]
+	pub fn new(
+		chain_source: Option<C>, broadcaster: T, logger: L, feeest: F, persister: P,
+	) -> Self {
+		Self {
+			monitors: RwLock::new(new_hash_map()),
+			chain_source,
+			broadcaster,
+			logger,
+			fee_estimator: feeest,
+			persister,
+			pending_monitor_events: Mutex::new(Vec::new()),
+			highest_chain_height: AtomicUsize::new(0),
+			event_notifier: Notifier::new(),
+			pending_send_only_events: Mutex::new(Vec::new()),
+			_phantom: std::marker::PhantomData,
+		}
+	}
+
+	/// Adding `entropy_source` and `our_peerstorage_encryption_key` for compiling with peer_storage attr.
+	#[cfg(peer_storage)]
 	pub fn new(
 		chain_source: Option<C>, broadcaster: T, logger: L, feeest: F, persister: P,
 		entropy_source: ES, our_peerstorage_encryption_key: PeerStorageKey,
@@ -496,6 +528,7 @@ where
 			event_notifier: Notifier::new(),
 			pending_send_only_events: Mutex::new(Vec::new()),
 			our_peerstorage_encryption_key,
+			_phantom: std::marker::PhantomData,
 		}
 	}
 
@@ -808,59 +841,80 @@ where
 
 	/// This function collects the counterparty node IDs from all monitors into a `HashSet`,
 	/// ensuring unique IDs are returned.
+	#[cfg(peer_storage)]
 	fn all_counterparty_node_ids(&self) -> HashSet<PublicKey> {
 		let mon = self.monitors.read().unwrap();
 		mon.values().map(|monitor| monitor.monitor.get_counterparty_node_id()).collect()
 	}
 
 	#[cfg(peer_storage)]
 	fn send_peer_storage(&self, their_node_id: PublicKey) {
-		#[allow(unused_mut)]
 		let mut monitors_list: Vec<PeerStorageMonitorHolder> = Vec::new();
 		let random_bytes = self.entropy_source.get_secure_random_bytes();
 
 		const MAX_PEER_STORAGE_SIZE: usize = 65531;
 		const USIZE_LEN: usize = core::mem::size_of::<usize>();
-		let mut usize_bytes = [0u8; USIZE_LEN];
-		usize_bytes.copy_from_slice(&random_bytes[0..USIZE_LEN]);
-		let random_usize = usize::from_le_bytes(usize_bytes);
-
-		let mut curr_size = 0;
-		let monitors = self.monitors.read().unwrap();
-		let mut stored_chanmon_idx = alloc::collections::BTreeSet::<usize>::new();
-		// Used as a fallback reference if the set is empty
-		let zero = 0;
+		let mut random_bytes_cycle_iter = random_bytes.iter().cycle();
+
+		let mut current_size = 0;
+		let monitors_lock = self.monitors.read().unwrap();
+		let mut channel_ids = monitors_lock.keys().copied().collect();
+
+		fn next_random_id(
+			channel_ids: &mut Vec<ChannelId>,
+			random_bytes_cycle_iter: &mut Cycle<core::slice::Iter<u8>>,
+		) -> Option<ChannelId> {
+			if channel_ids.is_empty() {
+				return None;
+			}
+			let random_idx = {
+				let mut usize_bytes = [0u8; USIZE_LEN];
+				usize_bytes.iter_mut().for_each(|b| {
+					*b = *random_bytes_cycle_iter.next().expect("A cycle never ends")
+				});
+				// Take one more to introduce a slight misalignment.
+				random_bytes_cycle_iter.next().expect("A cycle never ends");
+				usize::from_le_bytes(usize_bytes) % channel_ids.len()
+			};
+			Some(channel_ids.swap_remove(random_idx))
+		}
 
-		while curr_size < MAX_PEER_STORAGE_SIZE
-			&& *stored_chanmon_idx.last().unwrap_or(&zero) < monitors.len()
+		while let Some(channel_id) = next_random_id(&mut channel_ids, &mut random_bytes_cycle_iter)
 		{
-			let idx = random_usize % monitors.len();
-			stored_chanmon_idx.insert(idx + 1);
-			let (cid, mon) = monitors.iter().skip(idx).next().unwrap();
+			let monitor_holder = if let Some(monitor_holder) = monitors_lock.get(&channel_id) {
+				monitor_holder
+			} else {
+				debug_assert!(
+					false,
+					"Tried to access non-existing monitor, this should never happen"
+				);
+				break;
+			};
 
-			let mut ser_chan = VecWriter(Vec::new());
-			let min_seen_secret = mon.monitor.get_min_seen_secret();
-			let counterparty_node_id = mon.monitor.get_counterparty_node_id();
+			let mut serialized_channel = VecWriter(Vec::new());
+			let min_seen_secret = monitor_holder.monitor.get_min_seen_secret();
+			let counterparty_node_id = monitor_holder.monitor.get_counterparty_node_id();
 			{
-				let chan_mon = mon.monitor.inner.lock().unwrap();
+				let inner_lock = monitor_holder.monitor.inner.lock().unwrap();
 
-				write_chanmon_internal(&chan_mon, true, &mut ser_chan)
+				write_chanmon_internal(&inner_lock, true, &mut serialized_channel)
 					.expect("can not write Channel Monitor for peer storage message");
 			}
 			let peer_storage_monitor = PeerStorageMonitorHolder {
-				channel_id: *cid,
+				channel_id,
 				min_seen_secret,
 				counterparty_node_id,
-				monitor_bytes: ser_chan.0,
+				monitor_bytes: serialized_channel.0,
 			};
 
-			// Adding size of peer_storage_monitor.
-			curr_size += peer_storage_monitor.serialized_length();
+			let serialized_length = peer_storage_monitor.serialized_length();
 
-			if curr_size > MAX_PEER_STORAGE_SIZE {
-				break;
+			if current_size + serialized_length > MAX_PEER_STORAGE_SIZE {
+				continue;
+			} else {
+				current_size += serialized_length;
+				monitors_list.push(peer_storage_monitor);
 			}
-			monitors_list.push(peer_storage_monitor);
 		}
 
 		let serialised_channels = monitors_list.encode();
@@ -870,7 +924,7 @@ where
 		log_debug!(self.logger, "Sending Peer Storage to {}", log_pubkey!(their_node_id));
 		let send_peer_storage_event = MessageSendEvent::SendPeerStorage {
 			node_id: their_node_id,
-			msg: msgs::PeerStorage { data: cipher.into_vec() },
+			msg: PeerStorage { data: cipher.into_vec() },
 		};
 
 		self.pending_send_only_events.lock().unwrap().push(send_peer_storage_event)

lightning/src/util/test_utils.rs

@@ -471,7 +471,9 @@ impl<'a> TestChainMonitor<'a> {
 				logger,
 				fee_estimator,
 				persister,
+				#[cfg(peer_storage)]
 				keys_manager,
+				#[cfg(peer_storage)]
 				keys_manager.get_peer_storage_key(),
 			),
 			keys_manager,