Add ManagerPersister for persisting ChannelManagers

Author: valentinewallace

lightning-persister/src/lib.rs

@@ -1,3 +1,4 @@
+pub mod manager;
 pub(crate) mod utils;
 
 extern crate lightning;

lightning-persister/src/manager.rs

@@ -0,0 +1,242 @@
+use crate::utils;
+use crate::utils::DiskWriteable;
+use lightning::chain;
+use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
+use lightning::chain::keysinterface::{ChannelKeys, KeysInterface};
+use lightning::ln::channelmanager::ChannelManager;
+use lightning::util::logger::Logger;
+use lightning::util::ser::Writeable;
+use std::fs;
+use std::mem;
+use std::sync::Arc;
+use std::sync::mpsc::{self, Sender, TryRecvError};
+use std::thread;
+use std::time::{Duration, SystemTime};
+
+impl<ChanSigner: ChannelKeys + Writeable, M: chain::Watch<Keys=ChanSigner>, T: BroadcasterInterface, K: KeysInterface<ChanKeySigner=ChanSigner>, F: FeeEstimator, L: Logger> DiskWriteable for Arc<ChannelManager<ChanSigner, Arc<M>, Arc<T>, Arc<K>, Arc<F>, Arc<L>>> {
+	fn write_to_file(&self, writer: &mut fs::File) -> Result<(), std::io::Error> {
+		self.write(writer)
+	}
+}
+
+/// ManagerPersister runs a background thread that monitors whether the ChannelManager it's given on
+/// start has new updates to persist. If it does, then it writes said ChannelManager to disk/backups.
+pub struct ManagerPersister {
+	#[cfg(test)]
+	path_to_manager: String,
+
+	#[cfg(test)]
+	pub thread_terminator: Sender<()>,
+	#[cfg(not(test))]
+	/// Used to send a message to the thread in ManagerPersister::start() to exit the thread.
+	thread_terminator: Sender<()>,
+}
+
+impl ManagerPersister {
+	/// Start the background thread that checks whether new updates are available for the ChannelManager,
+	/// and writes it to disk if so.
+	/// We also call ChannelManager::timer_chan_freshness_every_min(), since we're already eating the
+	/// cost of running a thread, we may as well pack as many operations into it as make sense.
+	pub fn start<ChanSigner: 'static + ChannelKeys + Writeable, M: 'static + chain::Watch<Keys=ChanSigner>, T: 'static + BroadcasterInterface, K: 'static + KeysInterface<ChanKeySigner=ChanSigner>, F: 'static + FeeEstimator, L: 'static + Logger>(filepath: String, filename: String, manager: Arc<ChannelManager<ChanSigner, Arc<M>, Arc<T>, Arc<K>, Arc<F>, Arc<L>>>) -> Self {
+		let (sender, receiver) = mpsc::channel();
+		#[cfg(test)]
+		let saved_filepath = filepath.clone();
+
+		let mutcond = Arc::clone(&manager.persistence_lock);
+		// See ChannelMananger::persistence_lock for more documentation on the persistence process.
+		thread::spawn(move || {
+			let &(ref mtx, ref cvar) = &*mutcond;
+			let mut current_time = SystemTime::now();
+			loop {
+				let mut guard = mtx.lock().unwrap();
+				let result = cvar.wait_timeout(guard, Duration::from_millis(1000)).unwrap();
+				guard = result.0;
+				let saved_res = *guard;
+				mem::drop(guard);
+				if saved_res {
+					if let Err(e) = utils::write_to_file(filepath.clone(), filename.clone(), &manager) {
+						println!("Errored persisting manager: {}", e);
+					};
+				}
+				// If we receive a message from the thread_terminator, we should exit now.
+				match receiver.try_recv() {
+					Ok(_) | Err(TryRecvError::Disconnected) => {
+						println!("Terminating.");
+						break;
+					}
+					Err(TryRecvError::Empty) => {}
+				}
+				match current_time.elapsed() {
+					Ok(elapsed) => {
+						if elapsed.as_secs() > 60 {
+							manager.timer_chan_freshness_every_min();
+							current_time = SystemTime::now();
+						}
+					},
+					Err(e) => println!("Errored retrieving elapsed time: {}", e),
+				}
+			}
+		});
+		Self {
+			#[cfg(test)]
+			path_to_manager: saved_filepath,
+			thread_terminator: sender,
+		}
+	}
+
+	pub fn stop(&self) {
+		let _ = self.thread_terminator.send(());
+	}
+}
+
+#[cfg(test)]
+mod tests {
+	use bitcoin::blockdata::constants::genesis_block;
+	use bitcoin::blockdata::transaction::{Transaction, TxOut};
+	use bitcoin::network::constants::Network;
+	use crate::utils;
+	use lightning::chain::chainmonitor;
+	use lightning::chain::keysinterface::{InMemoryChannelKeys, KeysManager};
+	use lightning::chain::transaction::OutPoint;
+	use lightning::get_event_msg;
+	use lightning::ln::channelmanager::{ChannelManager, SimpleArcChannelManager};
+	use lightning::ln::features::{InitFeatures};
+	use lightning::ln::msgs::ChannelMessageHandler;
+	use lightning::util::config::UserConfig;
+	use lightning::util::events::{Event, EventsProvider, MessageSendEventsProvider, MessageSendEvent};
+	use lightning::util::ser::{Writeable};
+	use lightning::util::test_utils;
+	use super::ManagerPersister;
+	use crate::FilesystemPersister;
+	use std::fs;
+	use std::sync::{Arc, Mutex};
+	use std::time::Duration;
+
+	impl Drop for ManagerPersister {
+		fn drop(&mut self) {
+			// We test for invalid directory names, so it's OK if directory removal
+			// fails.
+			match fs::remove_dir_all(&self.path_to_manager) {
+				Err(e) => println!("Failed to remove test persister directory: {}", e),
+				_ => {}
+			}
+		}
+	}
+
+	type ChainMonitor = chainmonitor::ChainMonitor<InMemoryChannelKeys, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
+
+	struct Node {
+		node: SimpleArcChannelManager<ChainMonitor, test_utils::TestBroadcaster, test_utils::TestFeeEstimator, test_utils::TestLogger>,
+	}
+
+	fn create_nodes(num_nodes: usize) -> Vec<Node> {
+		let mut nodes = Vec::new();
+		for i in 0..num_nodes {
+			let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
+			let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
+			let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
+			let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
+			let monitor_persister = Arc::new(FilesystemPersister::new(format!("monitor_persister_{}", i)));
+			let seed = [i as u8; 32];
+			let network = Network::Testnet;
+			let now = Duration::from_secs(genesis_block(network).header.time as u64);
+			let keys_manager = Arc::new(KeysManager::new(&seed, network, now.as_secs(), now.subsec_nanos()));
+			let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), monitor_persister.clone()));
+			let manager = Arc::new(ChannelManager::new(Network::Testnet, fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster, logger.clone(), keys_manager.clone(), UserConfig::default(), i));
+			let node = Node { node: manager };
+			nodes.push(node);
+		}
+		nodes
+	}
+
+	#[test]
+	fn test_manager_persister() {
+		let nodes = create_nodes(2);
+
+		// Initiate the persisters to watch each node.
+		let _persister_0 = ManagerPersister::start("persister_0".to_string(), "manager".to_string(), nodes[0].node.clone());
+		let _persister_1 = ManagerPersister::start("persister_1".to_string(), "manager".to_string(), nodes[1].node.clone());
+
+		// Go through the channel creation process until each node should have something persisted.
+		let channel_value = 100000;
+		nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value, 100, 42, None).unwrap();
+		nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
+		nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
+
+		let events = nodes[0].node.get_and_clear_pending_events();
+		assert_eq!(events.len(), 1);
+		let (temporary_channel_id, tx, funding_output) = match events[0] {
+			Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
+				assert_eq!(*channel_value_satoshis, channel_value);
+				assert_eq!(user_channel_id, 42);
+
+				let tx = Transaction { version: 1 as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
+					value: *channel_value_satoshis, script_pubkey: output_script.clone(),
+				}]};
+				let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
+				(*temporary_channel_id, tx, funding_outpoint)
+			},
+			_ => panic!("Unexpected event"),
+		};
+
+		nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
+		nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
+		nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
+
+		macro_rules! check_persisted_data {
+			($node: expr, $filepath: expr) => {
+				let bytes = loop {
+					match std::fs::read($filepath) {
+						Ok(bytes) => break bytes,
+						Err(_) => continue
+					}
+				};
+				let mut expected_bytes = Vec::new();
+				assert!($node.write(&mut expected_bytes).is_ok());
+				assert_eq!(bytes, expected_bytes);
+			}
+		}
+
+		// Check that the initial channel manager data is persisted as expected.
+		let filepath_0 = utils::get_full_filepath("persister_0".to_string(), "manager".to_string());
+		let filepath_1 = utils::get_full_filepath("persister_1".to_string(), "manager".to_string());
+		check_persisted_data!(nodes[0].node, filepath_0.clone());
+		check_persisted_data!(nodes[1].node, filepath_1.clone());
+
+		// Save the current bytes then trigger another update.
+		let current_bytes = std::fs::read(filepath_0.clone()).unwrap();
+
+		// Force-close the channel.
+		nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id());
+
+		// Loop until what's written on disk changes.
+		loop {
+			match std::fs::read(filepath_0.clone()) {
+				Ok(bytes) => {
+					if bytes == current_bytes { continue } else { break }
+				},
+				Err(_) => continue
+			}
+		};
+		// Make sure the update was persisted properly.
+		check_persisted_data!(nodes[0].node, filepath_0.clone());
+		// TODO(val): `Drop` is never called on the FilesystemPersisters (causing their directories to linger). why?
+		let _ = fs::remove_dir_all("monitor_persister_0");
+		let _ = fs::remove_dir_all("monitor_persister_1");
+	}
+
+	#[test]
+	fn test_stop_persister_bg_thread() {
+		let nodes = create_nodes(1);
+		let persister_0 = ManagerPersister::start("persister_0".to_string(), "manager".to_string(), nodes[0].node.clone());
+
+		// Stop the persister and check that it terminated.
+		persister_0.stop();
+		loop {
+			match persister_0.thread_terminator.send(()) {
+				Err(_) => break, // A send operation can only fail if the receiving end is disconnected.
+				Ok(()) => continue
+			}
+		}
+	}
+}

lightning-persister/src/utils.rs

@@ -8,7 +8,7 @@ pub(crate) trait DiskWriteable {
 	fn write_to_file(&self, writer: &mut fs::File) -> Result<(), std::io::Error>;
 }
 
-fn get_full_filepath(filepath: String, filename: String) -> String {
+pub(crate) fn get_full_filepath(filepath: String, filename: String) -> String {
 	let mut path = PathBuf::from(filepath);
 	path.push(filename);
 	path.to_str().unwrap().to_string()