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