Initial commit.
[rapid-gossip-sync-server] / src / lib.rs
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644 (file)
index 0000000..fe82489
--- /dev/null
@@ -0,0 +1,254 @@
+#![deny(unsafe_code)]
+#![deny(broken_intra_doc_links)]
+#![deny(private_intra_doc_links)]
+#![deny(non_upper_case_globals)]
+#![deny(non_camel_case_types)]
+#![deny(non_snake_case)]
+#![deny(unused_mut)]
+#![deny(unused_variables)]
+#![deny(unused_imports)]
+
+extern crate core;
+
+use std::collections::{HashMap, HashSet};
+use std::fs::File;
+use std::io::BufReader;
+use std::sync::Arc;
+use std::sync::atomic::{AtomicBool, Ordering};
+
+use bitcoin::blockdata::constants::genesis_block;
+use bitcoin::Network;
+use bitcoin::secp256k1::PublicKey;
+use lightning::routing::gossip::NetworkGraph;
+use lightning::util::ser::{ReadableArgs, Writeable};
+use tokio::sync::mpsc;
+use crate::lookup::DeltaSet;
+
+use crate::persistence::GossipPersister;
+use crate::serialization::UpdateSerializationMechanism;
+use crate::snapshot::Snapshotter;
+use crate::types::{GossipChainAccess, TestLogger};
+
+mod downloader;
+mod types;
+mod tracking;
+mod lookup;
+mod persistence;
+mod serialization;
+mod snapshot;
+mod config;
+mod hex_utils;
+mod verifier;
+
+pub struct RapidSyncProcessor {
+       network_graph: Arc<NetworkGraph<Arc<TestLogger>>>,
+       pub initial_sync_complete: Arc<AtomicBool>,
+}
+
+pub struct SerializedResponse {
+       pub data: Vec<u8>,
+       pub message_count: u32,
+       pub announcement_count: u32,
+       pub update_count: u32,
+       pub update_count_full: u32,
+       pub update_count_incremental: u32,
+}
+
+impl RapidSyncProcessor {
+       pub fn new() -> Self {
+               let logger = TestLogger::new();
+               let mut initial_sync_complete = false;
+               let arc_logger = Arc::new(logger);
+               let network_graph = if let Ok(file) = File::open(&config::network_graph_cache_path()) {
+                       println!("Initializing from cached network graph…");
+                       let mut buffered_reader = BufReader::new(file);
+                       let network_graph_result = NetworkGraph::read(&mut buffered_reader, Arc::clone(&arc_logger));
+                       if let Ok(network_graph) = network_graph_result {
+                               initial_sync_complete = true;
+                               network_graph.remove_stale_channels();
+                               println!("Initialized from cached network graph!");
+                               network_graph
+                       } else {
+                               println!("Initialization from cached network graph failed: {}", network_graph_result.err().unwrap());
+                               NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), arc_logger)
+                       }
+               } else {
+                       NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), arc_logger)
+               };
+               let arc_network_graph = Arc::new(network_graph);
+               let (_sync_termination_sender, _sync_termination_receiver) = mpsc::channel::<()>(1);
+               Self {
+                       network_graph: arc_network_graph,
+                       initial_sync_complete: Arc::new(AtomicBool::new(initial_sync_complete)),
+               }
+       }
+
+       pub async fn start_sync(&self) {
+               // means to indicate sync completion status within this module
+               let (sync_completion_sender, mut sync_completion_receiver) = mpsc::channel::<()>(1);
+               let initial_sync_complete = self.initial_sync_complete.clone();
+
+               let network_graph = self.network_graph.clone();
+               let snapshotter = Snapshotter::new(network_graph.clone());
+
+               if config::DOWNLOAD_NEW_GOSSIP {
+
+                       let mut persister = GossipPersister::new(sync_completion_sender, self.network_graph.clone());
+
+                       let persistence_sender = persister.gossip_persistence_sender.clone();
+                       println!("Starting gossip download");
+                       let download_future = tracking::download_gossip(persistence_sender, network_graph.clone());
+                       tokio::spawn(async move {
+                               // initiate the whole download stuff in the background
+                               download_future.await;
+                       });
+                       println!("Starting gossip db persistence listener");
+                       tokio::spawn(async move {
+                               // initiate persistence of the gossip data
+                               let persistence_future = persister.persist_gossip();
+                               persistence_future.await;
+                       });
+
+               } else {
+                       sync_completion_sender.send(()).await.unwrap();
+               }
+
+               {
+                       let sync_completion = sync_completion_receiver.recv().await;
+                       if sync_completion.is_none() {
+                               panic!("Sync failed!");
+                       }
+                       initial_sync_complete.store(true, Ordering::Release);
+                       println!("Initial sync complete!");
+
+                       // start the gossip snapshotting service
+                       snapshotter.snapshot_gossip().await;
+               }
+       }
+
+       pub async fn serialize_delta(&self, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
+               crate::serialize_delta(self.network_graph.clone(), last_sync_timestamp, consider_intermediate_updates).await
+       }
+}
+
+async fn serialize_delta(network_graph: Arc<NetworkGraph<Arc<TestLogger>>>, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
+       let (client, connection) = lookup::connect_to_db().await;
+
+       tokio::spawn(async move {
+               if let Err(e) = connection.await {
+                       panic!("connection error: {}", e);
+               }
+       });
+
+       let mut output: Vec<u8> = vec![];
+
+       // set a flag if the chain hash is prepended
+       // chain hash only necessary if either channel announcements or non-incremental updates are present
+       // for announcement-free incremental-only updates, chain hash can be skipped
+
+       let mut node_id_set: HashSet<[u8; 33]> = HashSet::new();
+       let mut node_id_indices: HashMap<[u8; 33], usize> = HashMap::new();
+       let mut node_ids: Vec<PublicKey> = Vec::new();
+       let mut duplicate_node_ids: i32 = 0;
+
+       let mut get_node_id_index = |node_id: PublicKey| {
+               let serialized_node_id = node_id.serialize();
+               if node_id_set.insert(serialized_node_id) {
+                       node_ids.push(node_id);
+                       let index = node_ids.len() - 1;
+                       node_id_indices.insert(serialized_node_id, index);
+                       return index;
+               }
+               duplicate_node_ids += 1;
+               node_id_indices[&serialized_node_id]
+       };
+
+       let mut delta_set = DeltaSet::new();
+       lookup::fetch_channel_announcements(&mut delta_set, network_graph, &client, last_sync_timestamp).await;
+       println!("announcement channel count: {}", delta_set.len());
+       lookup::fetch_channel_updates(&mut delta_set, &client, last_sync_timestamp, consider_intermediate_updates).await;
+       println!("update-fetched channel count: {}", delta_set.len());
+       lookup::filter_delta_set(&mut delta_set);
+       println!("update-filtered channel count: {}", delta_set.len());
+       let serialization_details = serialization::serialize_delta_set(delta_set, last_sync_timestamp);
+
+       // process announcements
+       // write the number of channel announcements to the output
+       let announcement_count = serialization_details.announcements.len() as u32;
+       announcement_count.write(&mut output).unwrap();
+       let mut previous_announcement_scid = 0;
+       for current_announcement in serialization_details.announcements {
+               let id_index_1 = get_node_id_index(current_announcement.node_id_1);
+               let id_index_2 = get_node_id_index(current_announcement.node_id_2);
+               let mut stripped_announcement = serialization::serialize_stripped_channel_announcement(&current_announcement, id_index_1, id_index_2, previous_announcement_scid);
+               output.append(&mut stripped_announcement);
+
+               previous_announcement_scid = current_announcement.short_channel_id;
+       }
+
+       // process updates
+       let mut previous_update_scid = 0;
+       let update_count = serialization_details.updates.len() as u32;
+       update_count.write(&mut output).unwrap();
+
+       let default_update_values = serialization_details.full_update_defaults;
+       if update_count > 0 {
+               default_update_values.cltv_expiry_delta.write(&mut output).unwrap();
+               default_update_values.htlc_minimum_msat.write(&mut output).unwrap();
+               default_update_values.fee_base_msat.write(&mut output).unwrap();
+               default_update_values.fee_proportional_millionths.write(&mut output).unwrap();
+               default_update_values.htlc_maximum_msat.write(&mut output).unwrap();
+       }
+
+       let mut update_count_full = 0;
+       let mut update_count_incremental = 0;
+       for current_update in serialization_details.updates {
+               match &current_update.mechanism {
+                       UpdateSerializationMechanism::Full => {
+                               update_count_full += 1;
+                       }
+                       UpdateSerializationMechanism::Incremental(_) => {
+                               update_count_incremental += 1;
+                       }
+               };
+
+               let mut stripped_update = serialization::serialize_stripped_channel_update(&current_update, &default_update_values, previous_update_scid);
+               output.append(&mut stripped_update);
+
+               previous_update_scid = current_update.update.short_channel_id;
+       }
+
+       // some stats
+       let message_count = announcement_count + update_count;
+
+       let mut prefixed_output = vec![76, 68, 75, 1];
+
+       // always write the chain hash
+       serialization_details.chain_hash.write(&mut prefixed_output).unwrap();
+       // always write the latest seen timestamp
+       let latest_seen_timestamp = serialization_details.latest_seen;
+       let overflow_seconds = latest_seen_timestamp % config::SNAPSHOT_CALCULATION_INTERVAL;
+       let serialized_seen_timestamp = latest_seen_timestamp.saturating_sub(overflow_seconds);
+       serialized_seen_timestamp.write(&mut prefixed_output).unwrap();
+
+       let node_id_count = node_ids.len() as u32;
+       node_id_count.write(&mut prefixed_output).unwrap();
+
+       for current_node_id in node_ids {
+               current_node_id.write(&mut prefixed_output).unwrap();
+       }
+
+       prefixed_output.append(&mut output);
+
+       println!("duplicated node ids: {}", duplicate_node_ids);
+       println!("latest seen timestamp: {:?}", serialization_details.latest_seen);
+
+       SerializedResponse {
+               data: prefixed_output,
+               message_count,
+               announcement_count,
+               update_count,
+               update_count_full,
+               update_count_incremental,
+       }
+}