1 use std::collections::{BTreeMap, HashSet};
5 use std::time::{Instant, SystemTime, UNIX_EPOCH};
7 use lightning::ln::msgs::{ChannelAnnouncement, ChannelUpdate, UnsignedChannelAnnouncement, UnsignedChannelUpdate};
8 use lightning::routing::gossip::NetworkGraph;
9 use lightning::util::ser::Readable;
10 use tokio_postgres::{Client, Connection, NoTls, Socket};
11 use tokio_postgres::tls::NoTlsStream;
13 use futures::StreamExt;
14 use lightning::log_info;
15 use lightning::util::logger::Logger;
18 use crate::serialization::MutatedProperties;
20 /// The delta set needs to be a BTreeMap so the keys are sorted.
21 /// That way, the scids in the response automatically grow monotonically
22 pub(super) type DeltaSet = BTreeMap<u64, ChannelDelta>;
24 pub(super) struct AnnouncementDelta {
26 pub(super) announcement: UnsignedChannelAnnouncement,
29 pub(super) struct UpdateDelta {
31 pub(super) update: UnsignedChannelUpdate,
34 pub(super) struct DirectedUpdateDelta {
35 pub(super) last_update_before_seen: Option<UnsignedChannelUpdate>,
36 pub(super) mutated_properties: MutatedProperties,
37 pub(super) latest_update_after_seen: Option<UpdateDelta>,
38 pub(super) serialization_update_flags: Option<u8>,
41 pub(super) struct ChannelDelta {
42 pub(super) announcement: Option<AnnouncementDelta>,
43 pub(super) updates: (Option<DirectedUpdateDelta>, Option<DirectedUpdateDelta>),
44 pub(super) first_bidirectional_updates_seen: Option<u32>,
45 /// The seen timestamp of the older of the two latest directional updates
46 pub(super) requires_reminder: bool,
49 impl Default for ChannelDelta {
50 fn default() -> Self {
53 updates: (None, None),
54 first_bidirectional_updates_seen: None,
55 requires_reminder: false,
60 impl Default for DirectedUpdateDelta {
61 fn default() -> Self {
63 last_update_before_seen: None,
64 mutated_properties: MutatedProperties::default(),
65 latest_update_after_seen: None,
66 serialization_update_flags: None,
71 pub(super) async fn connect_to_db() -> (Client, Connection<Socket, NoTlsStream>) {
72 let connection_config = config::db_connection_config();
73 connection_config.connect(NoTls).await.unwrap()
76 /// Fetch all the channel announcements that are presently in the network graph, regardless of
77 /// whether they had been seen before.
78 /// Also include all announcements for which the first update was announced
79 /// after `last_sync_timestamp`
80 pub(super) async fn fetch_channel_announcements<L: Deref>(delta_set: &mut DeltaSet, network_graph: Arc<NetworkGraph<L>>, client: &Client, last_sync_timestamp: u32, logger: L) where L::Target: Logger {
81 log_info!(logger, "Obtaining channel ids from network graph");
83 let read_only_graph = network_graph.read_only();
84 log_info!(logger, "Retrieved read-only network graph copy");
85 let channel_iterator = read_only_graph.channels().unordered_iter();
87 .filter(|c| c.1.announcement_message.is_some())
88 .map(|c| c.1.announcement_message.as_ref().unwrap().contents.short_channel_id as i64)
92 log_info!(logger, "Channel IDs: {:?}", channel_ids);
93 log_info!(logger, "Last sync timestamp: {}", last_sync_timestamp);
94 let last_sync_timestamp_float = last_sync_timestamp as f64;
96 log_info!(logger, "Obtaining corresponding database entries");
97 // get all the channel announcements that are currently in the network graph
98 let announcement_rows = client.query_raw("SELECT announcement_signed, CAST(EXTRACT('epoch' from seen) AS BIGINT) AS seen FROM channel_announcements WHERE short_channel_id = any($1) ORDER BY short_channel_id ASC", [&channel_ids]).await.unwrap();
99 let mut pinned_rows = Box::pin(announcement_rows);
101 let mut announcement_count = 0;
102 while let Some(row_res) = pinned_rows.next().await {
103 let current_announcement_row = row_res.unwrap();
104 let blob: Vec<u8> = current_announcement_row.get("announcement_signed");
105 let mut readable = Cursor::new(blob);
106 let unsigned_announcement = ChannelAnnouncement::read(&mut readable).unwrap().contents;
108 let scid = unsigned_announcement.short_channel_id;
109 let current_seen_timestamp = current_announcement_row.get::<_, i64>("seen") as u32;
111 let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
112 (*current_channel_delta).announcement = Some(AnnouncementDelta {
113 announcement: unsigned_announcement,
114 seen: current_seen_timestamp,
117 announcement_count += 1;
119 log_info!(logger, "Fetched {} announcement rows", announcement_count);
122 // THIS STEP IS USED TO DETERMINE IF A CHANNEL SHOULD BE OMITTED FROM THE DELTA
124 log_info!(logger, "Annotating channel announcements whose oldest channel update in a given direction occurred after the last sync");
126 // — Obtain all updates, distinct by (scid, direction), ordered by seen DESC // to find the oldest update in a given direction
127 // — From those updates, select distinct by (scid), ordered by seen DESC (to obtain the newer one per direction)
128 // This will allow us to mark the first time updates in both directions were seen
130 // here is where the channels whose first update in either direction occurred after
131 // `last_seen_timestamp` are added to the selection
132 let params: [&(dyn tokio_postgres::types::ToSql + Sync); 2] =
133 [&channel_ids, &last_sync_timestamp_float];
134 let newer_oldest_directional_updates = client.query_raw("
135 SELECT short_channel_id, CAST(EXTRACT('epoch' from distinct_chans.seen) AS BIGINT) AS seen FROM (
136 SELECT DISTINCT ON (short_channel_id) *
138 SELECT DISTINCT ON (short_channel_id, direction) short_channel_id, seen
140 WHERE short_channel_id = any($1)
141 ORDER BY short_channel_id ASC, direction ASC, seen ASC
142 ) AS directional_last_seens
143 ORDER BY short_channel_id ASC, seen DESC
145 WHERE distinct_chans.seen >= TO_TIMESTAMP($2)
146 ", params).await.unwrap();
147 let mut pinned_updates = Box::pin(newer_oldest_directional_updates);
149 let mut newer_oldest_directional_update_count = 0;
150 while let Some(row_res) = pinned_updates.next().await {
151 let current_row = row_res.unwrap();
153 let scid: i64 = current_row.get("short_channel_id");
154 let current_seen_timestamp = current_row.get::<_, i64>("seen") as u32;
156 // the newer of the two oldest seen directional updates came after last sync timestamp
157 let current_channel_delta = delta_set.entry(scid as u64).or_insert(ChannelDelta::default());
158 // first time a channel was seen in both directions
159 (*current_channel_delta).first_bidirectional_updates_seen = Some(current_seen_timestamp);
161 newer_oldest_directional_update_count += 1;
163 log_info!(logger, "Fetched {} update rows of the first update in a new direction", newer_oldest_directional_update_count);
167 // THIS STEP IS USED TO DETERMINE IF A REMINDER UPDATE SHOULD BE SENT
169 log_info!(logger, "Annotating channel announcements whose latest channel update in a given direction occurred more than six days ago");
171 // — Obtain all updates, distinct by (scid, direction), ordered by seen DESC
172 // — From those updates, select distinct by (scid), ordered by seen ASC (to obtain the older one per direction)
173 let reminder_threshold_timestamp = SystemTime::now().checked_sub(config::CHANNEL_REMINDER_AGE).unwrap().duration_since(UNIX_EPOCH).unwrap().as_secs() as f64;
175 let params: [&(dyn tokio_postgres::types::ToSql + Sync); 2] =
176 [&channel_ids, &reminder_threshold_timestamp];
177 let older_latest_directional_updates = client.query_raw("
178 SELECT short_channel_id FROM (
179 SELECT DISTINCT ON (short_channel_id) *
181 SELECT DISTINCT ON (short_channel_id, direction) short_channel_id, seen
183 WHERE short_channel_id = any($1)
184 ORDER BY short_channel_id ASC, direction ASC, seen DESC
185 ) AS directional_last_seens
186 ORDER BY short_channel_id ASC, seen ASC
188 WHERE distinct_chans.seen <= TO_TIMESTAMP($2)
189 ", params).await.unwrap();
190 let mut pinned_updates = Box::pin(older_latest_directional_updates);
192 let mut older_latest_directional_update_count = 0;
193 while let Some(row_res) = pinned_updates.next().await {
194 let current_row = row_res.unwrap();
195 let scid: i64 = current_row.get("short_channel_id");
197 // annotate this channel as requiring that reminders be sent to the client
198 let current_channel_delta = delta_set.entry(scid as u64).or_insert(ChannelDelta::default());
200 // way might be able to get away with not using this
201 (*current_channel_delta).requires_reminder = true;
203 if let Some(current_channel_info) = network_graph.read_only().channel(scid as u64) {
204 if current_channel_info.one_to_two.is_none() || current_channel_info.two_to_one.is_none() {
205 // we don't send reminders if we don't have bidirectional update data
209 if let Some(info) = current_channel_info.one_to_two.as_ref() {
210 let flags: u8 = if info.enabled { 0 } else { 2 };
211 let current_update = (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default());
212 current_update.serialization_update_flags = Some(flags);
215 if let Some(info) = current_channel_info.two_to_one.as_ref() {
216 let flags: u8 = if info.enabled { 1 } else { 3 };
217 let current_update = (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default());
218 current_update.serialization_update_flags = Some(flags);
221 // we don't send reminders if we don't have the channel
224 older_latest_directional_update_count += 1;
226 log_info!(logger, "Fetched {} update rows of the latest update in the less recently updated direction", older_latest_directional_update_count);
230 pub(super) async fn fetch_channel_updates<L: Deref>(delta_set: &mut DeltaSet, client: &Client, last_sync_timestamp: u32, logger: L) where L::Target: Logger {
231 let start = Instant::now();
232 let last_sync_timestamp_float = last_sync_timestamp as f64;
234 // get the latest channel update in each direction prior to last_sync_timestamp, provided
235 // there was an update in either direction that happened after the last sync (to avoid
236 // collecting too many reference updates)
237 let reference_rows = client.query_raw("
238 SELECT id, direction, blob_signed FROM channel_updates
240 SELECT DISTINCT ON (short_channel_id, direction) id
242 WHERE seen < TO_TIMESTAMP($1) AND short_channel_id IN (
243 SELECT DISTINCT ON (short_channel_id) short_channel_id
245 WHERE seen >= TO_TIMESTAMP($1)
247 ORDER BY short_channel_id ASC, direction ASC, seen DESC
249 ", [last_sync_timestamp_float]).await.unwrap();
250 let mut pinned_rows = Box::pin(reference_rows);
252 log_info!(logger, "Fetched reference rows in {:?}", start.elapsed());
254 let mut last_seen_update_ids: Vec<i32> = Vec::new();
255 let mut non_intermediate_ids: HashSet<i32> = HashSet::new();
256 let mut reference_row_count = 0;
258 while let Some(row_res) = pinned_rows.next().await {
259 let current_reference = row_res.unwrap();
260 let update_id: i32 = current_reference.get("id");
261 last_seen_update_ids.push(update_id);
262 non_intermediate_ids.insert(update_id);
264 let direction: bool = current_reference.get("direction");
265 let blob: Vec<u8> = current_reference.get("blob_signed");
266 let mut readable = Cursor::new(blob);
267 let unsigned_channel_update = ChannelUpdate::read(&mut readable).unwrap().contents;
268 let scid = unsigned_channel_update.short_channel_id;
270 let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
271 let update_delta = if !direction {
272 (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default())
274 (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
276 update_delta.last_update_before_seen = Some(unsigned_channel_update);
277 reference_row_count += 1;
280 log_info!(logger, "Processed {} reference rows (delta size: {}) in {:?}",
281 reference_row_count, delta_set.len(), start.elapsed());
283 // get all the intermediate channel updates
284 // (to calculate the set of mutated fields for snapshotting, where intermediate updates may
285 // have been omitted)
287 let intermediate_updates = client.query_raw("
288 SELECT id, direction, blob_signed, CAST(EXTRACT('epoch' from seen) AS BIGINT) AS seen
290 WHERE seen >= TO_TIMESTAMP($1)
291 ", [last_sync_timestamp_float]).await.unwrap();
292 let mut pinned_updates = Box::pin(intermediate_updates);
293 log_info!(logger, "Fetched intermediate rows in {:?}", start.elapsed());
295 let mut previous_scid = u64::MAX;
296 let mut previously_seen_directions = (false, false);
298 // let mut previously_seen_directions = (false, false);
299 let mut intermediate_update_count = 0;
300 while let Some(row_res) = pinned_updates.next().await {
301 let intermediate_update = row_res.unwrap();
302 let update_id: i32 = intermediate_update.get("id");
303 if non_intermediate_ids.contains(&update_id) {
306 intermediate_update_count += 1;
308 let direction: bool = intermediate_update.get("direction");
309 let current_seen_timestamp = intermediate_update.get::<_, i64>("seen") as u32;
310 let blob: Vec<u8> = intermediate_update.get("blob_signed");
311 let mut readable = Cursor::new(blob);
312 let unsigned_channel_update = ChannelUpdate::read(&mut readable).unwrap().contents;
314 let scid = unsigned_channel_update.short_channel_id;
315 if scid != previous_scid {
316 previous_scid = scid;
317 previously_seen_directions = (false, false);
320 // get the write configuration for this particular channel's directional details
321 let current_channel_delta = delta_set.entry(scid).or_insert(ChannelDelta::default());
322 let update_delta = if !direction {
323 (*current_channel_delta).updates.0.get_or_insert(DirectedUpdateDelta::default())
325 (*current_channel_delta).updates.1.get_or_insert(DirectedUpdateDelta::default())
329 // handle the latest deltas
330 if !direction && !previously_seen_directions.0 {
331 previously_seen_directions.0 = true;
332 update_delta.latest_update_after_seen = Some(UpdateDelta {
333 seen: current_seen_timestamp,
334 update: unsigned_channel_update.clone(),
336 } else if direction && !previously_seen_directions.1 {
337 previously_seen_directions.1 = true;
338 update_delta.latest_update_after_seen = Some(UpdateDelta {
339 seen: current_seen_timestamp,
340 update: unsigned_channel_update.clone(),
345 // determine mutations
346 if let Some(last_seen_update) = update_delta.last_update_before_seen.as_ref() {
347 if unsigned_channel_update.flags != last_seen_update.flags {
348 update_delta.mutated_properties.flags = true;
350 if unsigned_channel_update.cltv_expiry_delta != last_seen_update.cltv_expiry_delta {
351 update_delta.mutated_properties.cltv_expiry_delta = true;
353 if unsigned_channel_update.htlc_minimum_msat != last_seen_update.htlc_minimum_msat {
354 update_delta.mutated_properties.htlc_minimum_msat = true;
356 if unsigned_channel_update.fee_base_msat != last_seen_update.fee_base_msat {
357 update_delta.mutated_properties.fee_base_msat = true;
359 if unsigned_channel_update.fee_proportional_millionths != last_seen_update.fee_proportional_millionths {
360 update_delta.mutated_properties.fee_proportional_millionths = true;
362 if unsigned_channel_update.htlc_maximum_msat != last_seen_update.htlc_maximum_msat {
363 update_delta.mutated_properties.htlc_maximum_msat = true;
367 log_info!(logger, "Processed intermediate rows ({}) (delta size: {}): {:?}", intermediate_update_count, delta_set.len(), start.elapsed());
370 pub(super) fn filter_delta_set<L: Deref>(delta_set: &mut DeltaSet, logger: L) where L::Target: Logger {
371 let original_length = delta_set.len();
372 let keys: Vec<u64> = delta_set.keys().cloned().collect();
374 let v = delta_set.get(&k).unwrap();
375 if v.announcement.is_none() {
376 // this channel is not currently in the network graph
377 delta_set.remove(&k);
381 let update_meets_criteria = |update: &Option<DirectedUpdateDelta>| {
382 if update.is_none() {
385 let update_reference = update.as_ref().unwrap();
386 // update_reference.latest_update_after_seen.is_some() && !update_reference.intermediate_updates.is_empty()
387 // if there has been an update after the channel was first seen
389 v.requires_reminder || update_reference.latest_update_after_seen.is_some()
392 let direction_a_meets_criteria = update_meets_criteria(&v.updates.0);
393 let direction_b_meets_criteria = update_meets_criteria(&v.updates.1);
395 if !v.requires_reminder && !direction_a_meets_criteria && !direction_b_meets_criteria {
396 delta_set.remove(&k);
400 let new_length = delta_set.len();
401 if original_length != new_length {
402 log_info!(logger, "length modified!");