Create wrapper struct for rapid sync.

Author: arik-so

lightning-rapid-gossip-sync/src/lib.rs

@@ -57,8 +57,11 @@
 extern crate test;
 
 use std::fs::File;
+use std::ops::Deref;
+use std::sync::Arc;
+use std::sync::atomic::AtomicBool;
 
-use lightning::routing::network_graph;
+use lightning::routing::network_graph::NetworkGraph;
 
 use crate::error::GraphSyncError;
 
@@ -68,32 +71,48 @@ pub mod error;
 /// Core functionality of this crate
 pub mod processing;
 
-/// Sync gossip data from a file
-/// Returns the last sync timestamp to be used the next time rapid sync data is queried.
-///
-/// `network_graph`: The network graph to apply the updates to
-///
-/// `sync_path`: Path to the file where the gossip update data is located
-///
-pub fn sync_network_graph_with_file_path(
-	network_graph: &network_graph::NetworkGraph,
-	sync_path: &str,
-) -> Result<u32, GraphSyncError> {
-	let mut file = File::open(sync_path)?;
-	processing::update_network_graph_from_byte_stream(&network_graph, &mut file)
+/// Rapid Gossip Sync holder struct
+pub struct RapidGossipSync<NG: Deref<Target=NetworkGraph>> {
+	network_graph: NG,
+	/// Atomic bool indicating whether a rapid gossip sync has completed at least once
+	pub is_initial_sync_complete: Arc<AtomicBool>
+}
+
+impl<NG: Deref<Target=NetworkGraph>> RapidGossipSync<NG> {
+	pub fn new(network_graph: NG) -> Self {
+		Self {
+			network_graph,
+			is_initial_sync_complete: Arc::new(AtomicBool::new(false))
+		}
+	}
+
+	/// Sync gossip data from a file
+	/// Returns the last sync timestamp to be used the next time rapid sync data is queried.
+	///
+	/// `network_graph`: The network graph to apply the updates to
+	///
+	/// `sync_path`: Path to the file where the gossip update data is located
+	///
+	pub fn sync_network_graph_with_file_path(
+		&self,
+		sync_path: &str,
+	) -> Result<u32, GraphSyncError> {
+		let mut file = File::open(sync_path)?;
+		self.update_network_graph_from_byte_stream(&mut file)
+	}
 }
 
 #[cfg(test)]
 mod tests {
 	use std::fs;
+	use std::sync::Arc;
 
 	use bitcoin::blockdata::constants::genesis_block;
 	use bitcoin::Network;
 
 	use lightning::ln::msgs::DecodeError;
 	use lightning::routing::network_graph::NetworkGraph;
-
-	use crate::sync_network_graph_with_file_path;
+	use crate::RapidGossipSync;
 
 	#[test]
 	fn test_sync_from_file() {
@@ -152,11 +171,12 @@ mod tests {
 		let graph_sync_test_file = sync_test.get_test_file_path();
 
 		let block_hash = genesis_block(Network::Bitcoin).block_hash();
-		let network_graph = NetworkGraph::new(block_hash);
+		let network_graph = Arc::new(NetworkGraph::new(block_hash));
 
 		assert_eq!(network_graph.read_only().channels().len(), 0);
 
-		let sync_result = sync_network_graph_with_file_path(&network_graph, &graph_sync_test_file);
+		let rapid_sync = RapidGossipSync::new(network_graph.clone());
+		let sync_result = rapid_sync.sync_network_graph_with_file_path(&graph_sync_test_file);
 
 		if sync_result.is_err() {
 			panic!("Unexpected sync result: {:?}", sync_result)
@@ -187,9 +207,10 @@ mod tests {
 
 		assert_eq!(network_graph.read_only().channels().len(), 0);
 
+		let rapid_sync = RapidGossipSync::new(Arc::new(network_graph));
 		let start = std::time::Instant::now();
-		let sync_result =
-			sync_network_graph_with_file_path(&network_graph, "./res/full_graph.lngossip");
+		let sync_result = rapid_sync
+			.sync_network_graph_with_file_path("./res/full_graph.lngossip");
 		if let Err(crate::error::GraphSyncError::DecodeError(DecodeError::Io(io_error))) = &sync_result {
 			let error_string = format!("Input file lightning-graph-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
 			#[cfg(not(require_route_graph_test))]
@@ -218,17 +239,15 @@ pub mod bench {
 	use lightning::ln::msgs::DecodeError;
 	use lightning::routing::network_graph::NetworkGraph;
 
-	use crate::sync_network_graph_with_file_path;
+	use crate::{RapidGossipSync, sync_network_graph_with_file_path};
 
 	#[bench]
 	fn bench_reading_full_graph_from_file(b: &mut Bencher) {
 		let block_hash = genesis_block(Network::Bitcoin).block_hash();
 		b.iter(|| {
 			let network_graph = NetworkGraph::new(block_hash);
-			let sync_result = sync_network_graph_with_file_path(
-				&network_graph,
-				"./res/full_graph.lngossip",
-			);
+			let rapid_sync = RapidGossipSync::new(network_graph);
+			let sync_result = rapid_sync.sync_network_graph_with_file_path("./res/full_graph.lngossip");
 			if let Err(crate::error::GraphSyncError::DecodeError(DecodeError::Io(io_error))) = &sync_result {
 				let error_string = format!("Input file lightning-graph-sync/res/full_graph.lngossip is missing! Download it from https://bitcoin.ninja/ldk-compressed_graph-bc08df7542-2022-05-05.bin\n\n{:?}", io_error);
 				#[cfg(not(require_route_graph_test))]