_ Git - rapid-gossip-sync-server/blob - src/lib.rs

   1 #![deny(unsafe_code)]
   2 #![deny(broken_intra_doc_links)]
   3 #![deny(private_intra_doc_links)]
   4 #![deny(non_upper_case_globals)]
   5 #![deny(non_camel_case_types)]
   6 #![deny(non_snake_case)]
   7 #![deny(unused_mut)]
   8 #![deny(unused_variables)]
   9 #![deny(unused_imports)]
  10
  11 extern crate core;
  12
  13 use std::collections::{HashMap, HashSet};
  14 use std::fs::File;
  15 use std::io::BufReader;
  16 use std::sync::Arc;
  17 use std::sync::atomic::{AtomicBool, Ordering};
  18
  19 use bitcoin::blockdata::constants::genesis_block;
  20 use bitcoin::Network;
  21 use bitcoin::secp256k1::PublicKey;
  22 use lightning::routing::gossip::NetworkGraph;
  23 use lightning::util::ser::{ReadableArgs, Writeable};
  24 use tokio::sync::mpsc;
  25 use crate::lookup::DeltaSet;
  26
  27 use crate::persistence::GossipPersister;
  28 use crate::serialization::UpdateSerializationMechanism;
  29 use crate::snapshot::Snapshotter;
  30 use crate::types::{GossipChainAccess, TestLogger};
  31
  32 mod downloader;
  33 mod types;
  34 mod tracking;
  35 mod lookup;
  36 mod persistence;
  37 mod serialization;
  38 mod snapshot;
  39 mod config;
  40 mod hex_utils;
  41 mod verifier;
  42
  43 pub struct RapidSyncProcessor {
  44         network_graph: Arc<NetworkGraph<Arc<TestLogger>>>,
  45         pub initial_sync_complete: Arc<AtomicBool>,
  46 }
  47
  48 pub struct SerializedResponse {
  49         pub data: Vec<u8>,
  50         pub message_count: u32,
  51         pub announcement_count: u32,
  52         pub update_count: u32,
  53         pub update_count_full: u32,
  54         pub update_count_incremental: u32,
  55 }
  56
  57 impl RapidSyncProcessor {
  58         pub fn new() -> Self {
  59                 let logger = TestLogger::new();
  60                 let mut initial_sync_complete = false;
  61                 let arc_logger = Arc::new(logger);
  62                 let network_graph = if let Ok(file) = File::open(&config::network_graph_cache_path()) {
  63                         println!("Initializing from cached network graph…");
  64                         let mut buffered_reader = BufReader::new(file);
  65                         let network_graph_result = NetworkGraph::read(&mut buffered_reader, Arc::clone(&arc_logger));
  66                         if let Ok(network_graph) = network_graph_result {
  67                                 initial_sync_complete = true;
  68                                 network_graph.remove_stale_channels();
  69                                 println!("Initialized from cached network graph!");
  70                                 network_graph
  71                         } else {
  72                                 println!("Initialization from cached network graph failed: {}", network_graph_result.err().unwrap());
  73                                 NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), arc_logger)
  74                         }
  75                 } else {
  76                         NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), arc_logger)
  77                 };
  78                 let arc_network_graph = Arc::new(network_graph);
  79                 let (_sync_termination_sender, _sync_termination_receiver) = mpsc::channel::<()>(1);
  80                 Self {
  81                         network_graph: arc_network_graph,
  82                         initial_sync_complete: Arc::new(AtomicBool::new(initial_sync_complete)),
  83                 }
  84         }
  85
  86         pub async fn start_sync(&self) {
  87                 // means to indicate sync completion status within this module
  88                 let (sync_completion_sender, mut sync_completion_receiver) = mpsc::channel::<()>(1);
  89                 let initial_sync_complete = self.initial_sync_complete.clone();
  90
  91                 let network_graph = self.network_graph.clone();
  92                 let snapshotter = Snapshotter::new(network_graph.clone());
  93
  94                 if config::DOWNLOAD_NEW_GOSSIP {
  95
  96                         let mut persister = GossipPersister::new(sync_completion_sender, self.network_graph.clone());
  97
  98                         let persistence_sender = persister.gossip_persistence_sender.clone();
  99                         println!("Starting gossip download");
 100                         let download_future = tracking::download_gossip(persistence_sender, network_graph.clone());
 101                         tokio::spawn(async move {
 102                                 // initiate the whole download stuff in the background
 103                                 download_future.await;
 104                         });
 105                         println!("Starting gossip db persistence listener");
 106                         tokio::spawn(async move {
 107                                 // initiate persistence of the gossip data
 108                                 let persistence_future = persister.persist_gossip();
 109                                 persistence_future.await;
 110                         });
 111
 112                 } else {
 113                         sync_completion_sender.send(()).await.unwrap();
 114                 }
 115
 116                 {
 117                         let sync_completion = sync_completion_receiver.recv().await;
 118                         if sync_completion.is_none() {
 119                                 panic!("Sync failed!");
 120                         }
 121                         initial_sync_complete.store(true, Ordering::Release);
 122                         println!("Initial sync complete!");
 123
 124                         // start the gossip snapshotting service
 125                         snapshotter.snapshot_gossip().await;
 126                 }
 127         }
 128
 129         pub async fn serialize_delta(&self, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
 130                 crate::serialize_delta(self.network_graph.clone(), last_sync_timestamp, consider_intermediate_updates).await
 131         }
 132 }
 133
 134 async fn serialize_delta(network_graph: Arc<NetworkGraph<Arc<TestLogger>>>, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
 135         let (client, connection) = lookup::connect_to_db().await;
 136
 137         tokio::spawn(async move {
 138                 if let Err(e) = connection.await {
 139                         panic!("connection error: {}", e);
 140                 }
 141         });
 142
 143         let mut output: Vec<u8> = vec![];
 144
 145         // set a flag if the chain hash is prepended
 146         // chain hash only necessary if either channel announcements or non-incremental updates are present
 147         // for announcement-free incremental-only updates, chain hash can be skipped
 148
 149         let mut node_id_set: HashSet<[u8; 33]> = HashSet::new();
 150         let mut node_id_indices: HashMap<[u8; 33], usize> = HashMap::new();
 151         let mut node_ids: Vec<PublicKey> = Vec::new();
 152         let mut duplicate_node_ids: i32 = 0;
 153
 154         let mut get_node_id_index = |node_id: PublicKey| {
 155                 let serialized_node_id = node_id.serialize();
 156                 if node_id_set.insert(serialized_node_id) {
 157                         node_ids.push(node_id);
 158                         let index = node_ids.len() - 1;
 159                         node_id_indices.insert(serialized_node_id, index);
 160                         return index;
 161                 }
 162                 duplicate_node_ids += 1;
 163                 node_id_indices[&serialized_node_id]
 164         };
 165
 166         let mut delta_set = DeltaSet::new();
 167         lookup::fetch_channel_announcements(&mut delta_set, network_graph, &client, last_sync_timestamp).await;
 168         println!("announcement channel count: {}", delta_set.len());
 169         lookup::fetch_channel_updates(&mut delta_set, &client, last_sync_timestamp, consider_intermediate_updates).await;
 170         println!("update-fetched channel count: {}", delta_set.len());
 171         lookup::filter_delta_set(&mut delta_set);
 172         println!("update-filtered channel count: {}", delta_set.len());
 173         let serialization_details = serialization::serialize_delta_set(delta_set, last_sync_timestamp);
 174
 175         // process announcements
 176         // write the number of channel announcements to the output
 177         let announcement_count = serialization_details.announcements.len() as u32;
 178         announcement_count.write(&mut output).unwrap();
 179         let mut previous_announcement_scid = 0;
 180         for current_announcement in serialization_details.announcements {
 181                 let id_index_1 = get_node_id_index(current_announcement.node_id_1);
 182                 let id_index_2 = get_node_id_index(current_announcement.node_id_2);
 183                 let mut stripped_announcement = serialization::serialize_stripped_channel_announcement(&current_announcement, id_index_1, id_index_2, previous_announcement_scid);
 184                 output.append(&mut stripped_announcement);
 185
 186                 previous_announcement_scid = current_announcement.short_channel_id;
 187         }
 188
 189         // process updates
 190         let mut previous_update_scid = 0;
 191         let update_count = serialization_details.updates.len() as u32;
 192         update_count.write(&mut output).unwrap();
 193
 194         let default_update_values = serialization_details.full_update_defaults;
 195         if update_count > 0 {
 196                 default_update_values.cltv_expiry_delta.write(&mut output).unwrap();
 197                 default_update_values.htlc_minimum_msat.write(&mut output).unwrap();
 198                 default_update_values.fee_base_msat.write(&mut output).unwrap();
 199                 default_update_values.fee_proportional_millionths.write(&mut output).unwrap();
 200                 default_update_values.htlc_maximum_msat.write(&mut output).unwrap();
 201         }
 202
 203         let mut update_count_full = 0;
 204         let mut update_count_incremental = 0;
 205         for current_update in serialization_details.updates {
 206                 match &current_update.mechanism {
 207                         UpdateSerializationMechanism::Full => {
 208                                 update_count_full += 1;
 209                         }
 210                         UpdateSerializationMechanism::Incremental(_) => {
 211                                 update_count_incremental += 1;
 212                         }
 213                 };
 214
 215                 let mut stripped_update = serialization::serialize_stripped_channel_update(&current_update, &default_update_values, previous_update_scid);
 216                 output.append(&mut stripped_update);
 217
 218                 previous_update_scid = current_update.update.short_channel_id;
 219         }
 220
 221         // some stats
 222         let message_count = announcement_count + update_count;
 223
 224         let mut prefixed_output = vec![76, 68, 75, 1];
 225
 226         // always write the chain hash
 227         serialization_details.chain_hash.write(&mut prefixed_output).unwrap();
 228         // always write the latest seen timestamp
 229         let latest_seen_timestamp = serialization_details.latest_seen;
 230         let overflow_seconds = latest_seen_timestamp % config::SNAPSHOT_CALCULATION_INTERVAL;
 231         let serialized_seen_timestamp = latest_seen_timestamp.saturating_sub(overflow_seconds);
 232         serialized_seen_timestamp.write(&mut prefixed_output).unwrap();
 233
 234         let node_id_count = node_ids.len() as u32;
 235         node_id_count.write(&mut prefixed_output).unwrap();
 236
 237         for current_node_id in node_ids {
 238                 current_node_id.write(&mut prefixed_output).unwrap();
 239         }
 240
 241         prefixed_output.append(&mut output);
 242
 243         println!("duplicated node ids: {}", duplicate_node_ids);
 244         println!("latest seen timestamp: {:?}", serialization_details.latest_seen);
 245
 246         SerializedResponse {
 247                 data: prefixed_output,
 248                 message_count,
 249                 announcement_count,
 250                 update_count,
 251                 update_count_full,
 252                 update_count_incremental,
 253         }
 254 }