Allow custom logger types.
[rapid-gossip-sync-server] / src / lookup.rs
index 83768da304122e344f92c9f67b14216a6e690660..79fb84e8d599ca4d993fc8ab4bb955cb3cf2648b 100644 (file)
@@ -10,7 +10,10 @@ use lightning::util::ser::Readable;
 use tokio_postgres::{Client, Connection, NoTls, Socket};
 use tokio_postgres::tls::NoTlsStream;
 
-use crate::{config, hex_utils, TestLogger};
+use futures::StreamExt;
+use lightning::util::logger::Logger;
+
+use crate::config;
 use crate::serialization::MutatedProperties;
 
 /// The delta set needs to be a BTreeMap so the keys are sorted.
@@ -31,17 +34,25 @@ pub(super) struct DirectedUpdateDelta {
        pub(super) last_update_before_seen: Option<UnsignedChannelUpdate>,
        pub(super) mutated_properties: MutatedProperties,
        pub(super) latest_update_after_seen: Option<UpdateDelta>,
+       pub(super) serialization_update_flags: Option<u8>,
 }
 
 pub(super) struct ChannelDelta {
        pub(super) announcement: Option<AnnouncementDelta>,
        pub(super) updates: (Option<DirectedUpdateDelta>, Option<DirectedUpdateDelta>),
-       pub(super) first_update_seen: Option<u32>,
+       pub(super) first_bidirectional_updates_seen: Option<u32>,
+       /// The seen timestamp of the older of the two latest directional updates
+       pub(super) requires_reminder: bool,
 }
 
 impl Default for ChannelDelta {
        fn default() -> Self {
-               Self { announcement: None, updates: (None, None), first_update_seen: None }
+               Self {
+                       announcement: None,
+                       updates: (None, None),
+                       first_bidirectional_updates_seen: None,
+                       requires_reminder: false,
+               }
        }
 }
 
@@ -51,6 +62,7 @@ impl Default for DirectedUpdateDelta {
                        last_update_before_seen: None,
                        mutated_properties: MutatedProperties::default(),
                        latest_update_after_seen: None,
+                       serialization_update_flags: None,
                }
        }
 }
@@ -63,25 +75,27 @@ pub(super) async fn connect_to_db() -> (Client, Connection<Socket, NoTlsStream>)
 /// Fetch all the channel announcements that are presently in the network graph, regardless of
 /// whether they had been seen before.
 /// Also include all announcements for which the first update was announced
-/// after `last_syc_timestamp`
-pub(super) async fn fetch_channel_announcements(delta_set: &mut DeltaSet, network_graph: Arc<NetworkGraph<TestLogger>>, client: &Client, last_sync_timestamp: u32) {
-       let last_sync_timestamp_object = SystemTime::UNIX_EPOCH.add(Duration::from_secs(last_sync_timestamp as u64));
+/// after `last_sync_timestamp`
+pub(super) async fn fetch_channel_announcements<L: Logger>(delta_set: &mut DeltaSet, network_graph: Arc<NetworkGraph<Arc<L>>>, client: &Client, last_sync_timestamp: u32) {
        println!("Obtaining channel ids from network graph");
+       let last_sync_timestamp_object = SystemTime::UNIX_EPOCH.add(Duration::from_secs(last_sync_timestamp as u64));
        let channel_ids = {
                let read_only_graph = network_graph.read_only();
                println!("Retrieved read-only network graph copy");
-               let channel_iterator = read_only_graph.channels().into_iter();
+               let channel_iterator = read_only_graph.channels().unordered_iter();
                channel_iterator
                        .filter(|c| c.1.announcement_message.is_some())
-                       .map(|c| hex_utils::hex_str(&c.1.announcement_message.as_ref().unwrap().contents.short_channel_id.to_be_bytes()))
-                       .collect::<Vec<String>>()
+                       .map(|c| c.1.announcement_message.as_ref().unwrap().contents.short_channel_id as i64)
+                       .collect::<Vec<_>>()
        };
 
        println!("Obtaining corresponding database entries");
        // get all the channel announcements that are currently in the network graph
-       let announcement_rows = client.query("SELECT short_channel_id, announcement_signed, seen FROM channel_announcements WHERE short_channel_id = any($1) ORDER BY short_channel_id ASC", &[&channel_ids]).await.unwrap();
+       let announcement_rows = client.query_raw("SELECT announcement_signed, seen FROM channel_announcements WHERE short_channel_id = any($1) ORDER BY short_channel_id ASC", [&channel_ids]).await.unwrap();
+       let mut pinned_rows = Box::pin(announcement_rows);
 
-       for current_announcement_row in announcement_rows {
+       while let Some(row_res) = pinned_rows.next().await {
+               let current_announcement_row = row_res.unwrap();
                let blob: Vec<u8> = current_announcement_row.get("announcement_signed");
                let mut readable = Cursor::new(blob);
                let unsigned_announcement = ChannelAnnouncement::read(&mut readable).unwrap().contents;
@@ -90,96 +104,195 @@ pub(super) async fn fetch_channel_announcements(delta_set: &mut DeltaSet, networ
                let current_seen_timestamp_object: SystemTime = current_announcement_row.get("seen");
                let current_seen_timestamp: u32 = current_seen_timestamp_object.duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs() as u32;
 
-               let mut current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
+               let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
                (*current_channel_delta).announcement = Some(AnnouncementDelta {
                        announcement: unsigned_announcement,
                        seen: current_seen_timestamp,
                });
        }
 
-       println!("Obtaining channel announcements whose first channel updates had not been seen yet");
-
-       // here is where the channels whose first update in either direction occurred after
-       // `last_seen_timestamp` are added to the selection
-       let unannounced_rows = client.query("SELECT short_channel_id, blob_signed, seen FROM (SELECT DISTINCT ON (short_channel_id) short_channel_id, blob_signed, seen FROM channel_updates ORDER BY short_channel_id ASC, seen ASC) AS first_seens WHERE first_seens.seen >= $1", &[&last_sync_timestamp_object]).await.unwrap();
-       for current_row in unannounced_rows {
-
-               let blob: Vec<u8> = current_row.get("blob_signed");
-               let mut readable = Cursor::new(blob);
-               let unsigned_update = ChannelUpdate::read(&mut readable).unwrap().contents;
-               let scid = unsigned_update.short_channel_id;
-               let current_seen_timestamp_object: SystemTime = current_row.get("seen");
-               let current_seen_timestamp: u32 = current_seen_timestamp_object.duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs() as u32;
+       {
+               // THIS STEP IS USED TO DETERMINE IF A CHANNEL SHOULD BE OMITTED FROM THE DELTA
+
+               println!("Annotating channel announcements whose oldest channel update in a given direction occurred after the last sync");
+               // Steps:
+               // — Obtain all updates, distinct by (scid, direction), ordered by seen DESC // to find the oldest update in a given direction
+               // — From those updates, select distinct by (scid), ordered by seen DESC (to obtain the newer one per direction)
+               // This will allow us to mark the first time updates in both directions were seen
+
+               // here is where the channels whose first update in either direction occurred after
+               // `last_seen_timestamp` are added to the selection
+               let params: [&(dyn tokio_postgres::types::ToSql + Sync); 2] =
+                       [&channel_ids, &last_sync_timestamp_object];
+               let newer_oldest_directional_updates = client.query_raw("
+                       SELECT * FROM (
+                               SELECT DISTINCT ON (short_channel_id) *
+                               FROM (
+                                       SELECT DISTINCT ON (short_channel_id, direction) short_channel_id, seen
+                                       FROM channel_updates
+                                       WHERE short_channel_id = any($1)
+                                       ORDER BY short_channel_id ASC, direction ASC, seen ASC
+                               ) AS directional_last_seens
+                               ORDER BY short_channel_id ASC, seen DESC
+                       ) AS distinct_chans
+                       WHERE distinct_chans.seen >= $2
+                       ", params).await.unwrap();
+               let mut pinned_updates = Box::pin(newer_oldest_directional_updates);
+
+               while let Some(row_res) = pinned_updates.next().await {
+                       let current_row = row_res.unwrap();
+
+                       let scid: i64 = current_row.get("short_channel_id");
+                       let current_seen_timestamp_object: SystemTime = current_row.get("seen");
+                       let current_seen_timestamp: u32 = current_seen_timestamp_object.duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs() as u32;
+
+                       // the newer of the two oldest seen directional updates came after last sync timestamp
+                       let current_channel_delta = delta_set.entry(scid as u64).or_insert(ChannelDelta::default());
+                       // first time a channel was seen in both directions
+                       (*current_channel_delta).first_bidirectional_updates_seen = Some(current_seen_timestamp);
+               }
+       }
 
-               let mut current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
-               (*current_channel_delta).first_update_seen = Some(current_seen_timestamp);
+       {
+               // THIS STEP IS USED TO DETERMINE IF A REMINDER UPDATE SHOULD BE SENT
+
+               println!("Annotating channel announcements whose latest channel update in a given direction occurred more than six days ago");
+               // Steps:
+               // — Obtain all updates, distinct by (scid, direction), ordered by seen DESC
+               // — From those updates, select distinct by (scid), ordered by seen ASC (to obtain the older one per direction)
+               let reminder_threshold_timestamp = SystemTime::now().checked_sub(config::CHANNEL_REMINDER_AGE).unwrap();
+
+               let params: [&(dyn tokio_postgres::types::ToSql + Sync); 2] =
+                       [&channel_ids, &reminder_threshold_timestamp];
+               let older_latest_directional_updates = client.query_raw("
+                       SELECT short_channel_id FROM (
+                               SELECT DISTINCT ON (short_channel_id) *
+                               FROM (
+                                       SELECT DISTINCT ON (short_channel_id, direction) short_channel_id, seen
+                                       FROM channel_updates
+                                       WHERE short_channel_id = any($1)
+                                       ORDER BY short_channel_id ASC, direction ASC, seen DESC
+                               ) AS directional_last_seens
+                               ORDER BY short_channel_id ASC, seen ASC
+                       ) AS distinct_chans
+                       WHERE distinct_chans.seen <= $2
+                       ", params).await.unwrap();
+               let mut pinned_updates = Box::pin(older_latest_directional_updates);
+
+               while let Some(row_res) = pinned_updates.next().await {
+                       let current_row = row_res.unwrap();
+                       let scid: i64 = current_row.get("short_channel_id");
+
+                       // annotate this channel as requiring that reminders be sent to the client
+                       let current_channel_delta = delta_set.entry(scid as u64).or_insert(ChannelDelta::default());
+
+                       // way might be able to get away with not using this
+                       (*current_channel_delta).requires_reminder = true;
+
+                       if let Some(current_channel_info) = network_graph.read_only().channel(scid as u64) {
+                               if current_channel_info.one_to_two.is_none() || current_channel_info.two_to_one.is_none() {
+                                       // we don't send reminders if we don't have bidirectional update data
+                                       continue;
+                               }
+
+                               if let Some(info) = current_channel_info.one_to_two.as_ref() {
+                                       let flags: u8 = if info.enabled { 0 } else { 2 };
+                                       let current_update = (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default());
+                                       current_update.serialization_update_flags = Some(flags);
+                               }
+
+                               if let Some(info) = current_channel_info.two_to_one.as_ref() {
+                                       let flags: u8 = if info.enabled { 1 } else { 3 };
+                                       let current_update = (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default());
+                                       current_update.serialization_update_flags = Some(flags);
+                               }
+                       } else {
+                               // we don't send reminders if we don't have the channel
+                               continue;
+                       }
+               }
        }
 }
 
-pub(super) async fn fetch_channel_updates(delta_set: &mut DeltaSet, client: &Client, last_sync_timestamp: u32, consider_intermediate_updates: bool) {
+pub(super) async fn fetch_channel_updates(delta_set: &mut DeltaSet, client: &Client, last_sync_timestamp: u32) {
        let start = Instant::now();
        let last_sync_timestamp_object = SystemTime::UNIX_EPOCH.add(Duration::from_secs(last_sync_timestamp as u64));
 
        // get the latest channel update in each direction prior to last_sync_timestamp, provided
        // there was an update in either direction that happened after the last sync (to avoid
        // collecting too many reference updates)
-       let reference_rows = client.query("SELECT DISTINCT ON (short_channel_id, direction) id, short_channel_id, direction, blob_signed FROM channel_updates WHERE seen < $1 AND short_channel_id IN (SELECT short_channel_id FROM channel_updates WHERE seen >= $1 GROUP BY short_channel_id) ORDER BY short_channel_id ASC, direction ASC, seen DESC", &[&last_sync_timestamp_object]).await.unwrap();
-
-       println!("Fetched reference rows ({}): {:?}", reference_rows.len(), start.elapsed());
-
-       let mut last_seen_update_ids: Vec<i32> = Vec::with_capacity(reference_rows.len());
+       let reference_rows = client.query_raw("
+               SELECT id, direction, blob_signed FROM channel_updates
+               WHERE id IN (
+                       SELECT DISTINCT ON (short_channel_id, direction) id
+                       FROM channel_updates
+                       WHERE seen < $1 AND short_channel_id IN (
+                               SELECT DISTINCT ON (short_channel_id) short_channel_id
+                               FROM channel_updates
+                               WHERE seen >= $1
+                       )
+                       ORDER BY short_channel_id ASC, direction ASC, seen DESC
+               )
+               ", [last_sync_timestamp_object]).await.unwrap();
+       let mut pinned_rows = Box::pin(reference_rows);
+
+       println!("Fetched reference rows in {:?}", start.elapsed());
+
+       let mut last_seen_update_ids: Vec<i32> = Vec::new();
        let mut non_intermediate_ids: HashSet<i32> = HashSet::new();
+       let mut reference_row_count = 0;
 
-       for current_reference in reference_rows {
+       while let Some(row_res) = pinned_rows.next().await {
+               let current_reference = row_res.unwrap();
                let update_id: i32 = current_reference.get("id");
                last_seen_update_ids.push(update_id);
                non_intermediate_ids.insert(update_id);
 
-               let direction: i32 = current_reference.get("direction");
+               let direction: bool = current_reference.get("direction");
                let blob: Vec<u8> = current_reference.get("blob_signed");
                let mut readable = Cursor::new(blob);
                let unsigned_channel_update = ChannelUpdate::read(&mut readable).unwrap().contents;
                let scid = unsigned_channel_update.short_channel_id;
 
                let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
-               let mut update_delta = if direction == 0 {
+               let update_delta = if !direction {
                        (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default())
-               } else if direction == 1 {
-                       (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
                } else {
-                       panic!("Channel direction must be binary!")
+                       (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
                };
                update_delta.last_update_before_seen = Some(unsigned_channel_update);
+               reference_row_count += 1;
        }
 
-       println!("Processed reference rows (delta size: {}): {:?}", delta_set.len(), start.elapsed());
+       println!("Processed {} reference rows (delta size: {}) in {:?}",
+               reference_row_count, delta_set.len(), start.elapsed());
 
        // get all the intermediate channel updates
        // (to calculate the set of mutated fields for snapshotting, where intermediate updates may
        // have been omitted)
 
-       let mut intermediate_update_prefix = "";
-       if !consider_intermediate_updates {
-               intermediate_update_prefix = "DISTINCT ON (short_channel_id, direction)";
-       }
-
-       let query_string = format!("SELECT {} id, short_channel_id, direction, blob_signed, seen FROM channel_updates WHERE seen >= $1 ORDER BY short_channel_id ASC, direction ASC, seen DESC", intermediate_update_prefix);
-       let intermediate_updates = client.query(&query_string, &[&last_sync_timestamp_object]).await.unwrap();
-       println!("Fetched intermediate rows ({}): {:?}", intermediate_updates.len(), start.elapsed());
+       let intermediate_updates = client.query_raw("
+               SELECT id, direction, blob_signed, seen
+               FROM channel_updates
+               WHERE seen >= $1
+               ", [last_sync_timestamp_object]).await.unwrap();
+       let mut pinned_updates = Box::pin(intermediate_updates);
+       println!("Fetched intermediate rows in {:?}", start.elapsed());
 
        let mut previous_scid = u64::MAX;
        let mut previously_seen_directions = (false, false);
 
        // let mut previously_seen_directions = (false, false);
        let mut intermediate_update_count = 0;
-       for intermediate_update in intermediate_updates {
+       while let Some(row_res) = pinned_updates.next().await {
+               let intermediate_update = row_res.unwrap();
                let update_id: i32 = intermediate_update.get("id");
                if non_intermediate_ids.contains(&update_id) {
                        continue;
                }
                intermediate_update_count += 1;
 
-               let direction: i32 = intermediate_update.get("direction");
+               let direction: bool = intermediate_update.get("direction");
                let current_seen_timestamp_object: SystemTime = intermediate_update.get("seen");
                let current_seen_timestamp: u32 = current_seen_timestamp_object.duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs() as u32;
                let blob: Vec<u8> = intermediate_update.get("blob_signed");
@@ -194,23 +307,21 @@ pub(super) async fn fetch_channel_updates(delta_set: &mut DeltaSet, client: &Cli
 
                // get the write configuration for this particular channel's directional details
                let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
-               let update_delta = if direction == 0 {
+               let update_delta = if !direction {
                        (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default())
-               } else if direction == 1 {
-                       (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
                } else {
-                       panic!("Channel direction must be binary!")
+                       (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
                };
 
                {
                        // handle the latest deltas
-                       if direction == 0 && !previously_seen_directions.0 {
+                       if !direction && !previously_seen_directions.0 {
                                previously_seen_directions.0 = true;
                                update_delta.latest_update_after_seen = Some(UpdateDelta {
                                        seen: current_seen_timestamp,
                                        update: unsigned_channel_update.clone(),
                                });
-                       } else if direction == 1 && !previously_seen_directions.1 {
+                       } else if direction && !previously_seen_directions.1 {
                                previously_seen_directions.1 = true;
                                update_delta.latest_update_after_seen = Some(UpdateDelta {
                                        seen: current_seen_timestamp,
@@ -220,7 +331,7 @@ pub(super) async fn fetch_channel_updates(delta_set: &mut DeltaSet, client: &Cli
                }
 
                // determine mutations
-               if let Some(last_seen_update) = update_delta.last_update_before_seen.as_ref(){
+               if let Some(last_seen_update) = update_delta.last_update_before_seen.as_ref() {
                        if unsigned_channel_update.flags != last_seen_update.flags {
                                update_delta.mutated_properties.flags = true;
                        }
@@ -240,7 +351,6 @@ pub(super) async fn fetch_channel_updates(delta_set: &mut DeltaSet, client: &Cli
                                update_delta.mutated_properties.htlc_maximum_msat = true;
                        }
                }
-
        }
        println!("Processed intermediate rows ({}) (delta size: {}): {:?}", intermediate_update_count, delta_set.len(), start.elapsed());
 }
@@ -263,13 +373,14 @@ pub(super) fn filter_delta_set(delta_set: &mut DeltaSet) {
                        let update_reference = update.as_ref().unwrap();
                        // update_reference.latest_update_after_seen.is_some() && !update_reference.intermediate_updates.is_empty()
                        // if there has been an update after the channel was first seen
-                       update_reference.latest_update_after_seen.is_some()
+
+                       v.requires_reminder || update_reference.latest_update_after_seen.is_some()
                };
 
                let direction_a_meets_criteria = update_meets_criteria(&v.updates.0);
                let direction_b_meets_criteria = update_meets_criteria(&v.updates.1);
 
-               if !direction_a_meets_criteria && !direction_b_meets_criteria {
+               if !v.requires_reminder && !direction_a_meets_criteria && !direction_b_meets_criteria {
                        delta_set.remove(&k);
                }
        }