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