_ 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::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<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 network_graph = if let Ok(file) = File::open(&config::network_graph_cache_path()) {
  62                         println!("Initializing from cached network graph…");
  63                         let mut buffered_reader = BufReader::new(file);
  64                         let network_graph_result = NetworkGraph::read(&mut buffered_reader, logger);
  65                         if let Ok(network_graph) = network_graph_result {
  66                                 initial_sync_complete = true;
  67                                 network_graph.remove_stale_channels();
  68                                 println!("Initialized from cached network graph!");
  69                                 network_graph
  70                         } else {
  71                                 println!("Initialization from cached network graph failed: {}", network_graph_result.err().unwrap());
  72                                 NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), logger)
  73                         }
  74                 } else {
  75                         NetworkGraph::new(genesis_block(Network::Bitcoin).header.block_hash(), logger)
  76                 };
  77                 let arc_network_graph = Arc::new(network_graph);
  78                 Self {
  79                         network_graph: arc_network_graph,
  80                         initial_sync_complete: Arc::new(AtomicBool::new(initial_sync_complete)),
  81                 }
  82         }
  83
  84         pub async fn start_sync(&self) {
  85                 // means to indicate sync completion status within this module
  86                 let (sync_completion_sender, mut sync_completion_receiver) = mpsc::channel::<()>(1);
  87                 let initial_sync_complete = self.initial_sync_complete.clone();
  88
  89                 if config::DOWNLOAD_NEW_GOSSIP {
  90                         let (mut persister, persistence_sender) =
  91                                 GossipPersister::new(sync_completion_sender, Arc::clone(&self.network_graph));
  92
  93                         println!("Starting gossip download");
  94                         tokio::spawn(tracking::download_gossip(persistence_sender, Arc::clone(&self.network_graph)));
  95                         println!("Starting gossip db persistence listener");
  96                         tokio::spawn(async move { persister.persist_gossip().await; });
  97                 } else {
  98                         sync_completion_sender.send(()).await.unwrap();
  99                 }
 100
 101                 {
 102                         let sync_completion = sync_completion_receiver.recv().await;
 103                         if sync_completion.is_none() {
 104                                 panic!("Sync failed!");
 105                         }
 106                         initial_sync_complete.store(true, Ordering::Release);
 107                         println!("Initial sync complete!");
 108
 109                         // start the gossip snapshotting service
 110                         Snapshotter::new(Arc::clone(&self.network_graph)).snapshot_gossip().await;
 111                 }
 112         }
 113
 114         pub async fn serialize_delta(&self, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
 115                 crate::serialize_delta(self.network_graph.clone(), last_sync_timestamp, consider_intermediate_updates).await
 116         }
 117 }
 118
 119 async fn serialize_delta(network_graph: Arc<NetworkGraph<TestLogger>>, last_sync_timestamp: u32, consider_intermediate_updates: bool) -> SerializedResponse {
 120         let (client, connection) = lookup::connect_to_db().await;
 121
 122         tokio::spawn(async move {
 123                 if let Err(e) = connection.await {
 124                         panic!("connection error: {}", e);
 125                 }
 126         });
 127
 128         let mut output: Vec<u8> = vec![];
 129
 130         // set a flag if the chain hash is prepended
 131         // chain hash only necessary if either channel announcements or non-incremental updates are present
 132         // for announcement-free incremental-only updates, chain hash can be skipped
 133
 134         let mut node_id_set: HashSet<[u8; 33]> = HashSet::new();
 135         let mut node_id_indices: HashMap<[u8; 33], usize> = HashMap::new();
 136         let mut node_ids: Vec<PublicKey> = Vec::new();
 137         let mut duplicate_node_ids: i32 = 0;
 138
 139         let mut get_node_id_index = |node_id: PublicKey| {
 140                 let serialized_node_id = node_id.serialize();
 141                 if node_id_set.insert(serialized_node_id) {
 142                         node_ids.push(node_id);
 143                         let index = node_ids.len() - 1;
 144                         node_id_indices.insert(serialized_node_id, index);
 145                         return index;
 146                 }
 147                 duplicate_node_ids += 1;
 148                 node_id_indices[&serialized_node_id]
 149         };
 150
 151         let mut delta_set = DeltaSet::new();
 152         lookup::fetch_channel_announcements(&mut delta_set, network_graph, &client, last_sync_timestamp).await;
 153         println!("announcement channel count: {}", delta_set.len());
 154         lookup::fetch_channel_updates(&mut delta_set, &client, last_sync_timestamp, consider_intermediate_updates).await;
 155         println!("update-fetched channel count: {}", delta_set.len());
 156         lookup::filter_delta_set(&mut delta_set);
 157         println!("update-filtered channel count: {}", delta_set.len());
 158         let serialization_details = serialization::serialize_delta_set(delta_set, last_sync_timestamp);
 159
 160         // process announcements
 161         // write the number of channel announcements to the output
 162         let announcement_count = serialization_details.announcements.len() as u32;
 163         announcement_count.write(&mut output).unwrap();
 164         let mut previous_announcement_scid = 0;
 165         for current_announcement in serialization_details.announcements {
 166                 let id_index_1 = get_node_id_index(current_announcement.node_id_1);
 167                 let id_index_2 = get_node_id_index(current_announcement.node_id_2);
 168                 let mut stripped_announcement = serialization::serialize_stripped_channel_announcement(&current_announcement, id_index_1, id_index_2, previous_announcement_scid);
 169                 output.append(&mut stripped_announcement);
 170
 171                 previous_announcement_scid = current_announcement.short_channel_id;
 172         }
 173
 174         // process updates
 175         let mut previous_update_scid = 0;
 176         let update_count = serialization_details.updates.len() as u32;
 177         update_count.write(&mut output).unwrap();
 178
 179         let default_update_values = serialization_details.full_update_defaults;
 180         if update_count > 0 {
 181                 default_update_values.cltv_expiry_delta.write(&mut output).unwrap();
 182                 default_update_values.htlc_minimum_msat.write(&mut output).unwrap();
 183                 default_update_values.fee_base_msat.write(&mut output).unwrap();
 184                 default_update_values.fee_proportional_millionths.write(&mut output).unwrap();
 185                 default_update_values.htlc_maximum_msat.write(&mut output).unwrap();
 186         }
 187
 188         let mut update_count_full = 0;
 189         let mut update_count_incremental = 0;
 190         for current_update in serialization_details.updates {
 191                 match &current_update.mechanism {
 192                         UpdateSerializationMechanism::Full => {
 193                                 update_count_full += 1;
 194                         }
 195                         UpdateSerializationMechanism::Incremental(_) => {
 196                                 update_count_incremental += 1;
 197                         }
 198                 };
 199
 200                 let mut stripped_update = serialization::serialize_stripped_channel_update(&current_update, &default_update_values, previous_update_scid);
 201                 output.append(&mut stripped_update);
 202
 203                 previous_update_scid = current_update.update.short_channel_id;
 204         }
 205
 206         // some stats
 207         let message_count = announcement_count + update_count;
 208
 209         let mut prefixed_output = vec![76, 68, 75, 1];
 210
 211         // always write the chain hash
 212         serialization_details.chain_hash.write(&mut prefixed_output).unwrap();
 213         // always write the latest seen timestamp
 214         let latest_seen_timestamp = serialization_details.latest_seen;
 215         let overflow_seconds = latest_seen_timestamp % config::SNAPSHOT_CALCULATION_INTERVAL;
 216         let serialized_seen_timestamp = latest_seen_timestamp.saturating_sub(overflow_seconds);
 217         serialized_seen_timestamp.write(&mut prefixed_output).unwrap();
 218
 219         let node_id_count = node_ids.len() as u32;
 220         node_id_count.write(&mut prefixed_output).unwrap();
 221
 222         for current_node_id in node_ids {
 223                 current_node_id.write(&mut prefixed_output).unwrap();
 224         }
 225
 226         prefixed_output.append(&mut output);
 227
 228         println!("duplicated node ids: {}", duplicate_node_ids);
 229         println!("latest seen timestamp: {:?}", serialization_details.latest_seen);
 230
 231         SerializedResponse {
 232                 data: prefixed_output,
 233                 message_count,
 234                 announcement_count,
 235                 update_count,
 236                 update_count_full,
 237                 update_count_incremental,
 238         }
 239 }