Skip to content

Commit c2ca6d3

Browse files
committed
Further document the initial routing table send.
As requested by Arik at #435 (comment)
1 parent a8114a7 commit c2ca6d3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning/src/ln/msgs.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,10 +600,11 @@ pub trait RoutingMessageHandler : Send + Sync {
600600
fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
601601
/// Gets a subset of the channel announcements and updates required to dump our routing table
602602
/// to a remote node, starting at the short_channel_id indicated by starting_point and
603-
/// including batch_amount entries.
603+
/// including the batch_amount entries immediately higher in numerical value than starting_point.
604604
fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
605605
/// Gets a subset of the node announcements required to dump our routing table to a remote node,
606-
/// starting at the node *after* the provided publickey and including batch_amount entries.
606+
/// starting at the node *after* the provided publickey and including batch_amount entries
607+
/// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
607608
/// If None is provided for starting_point, we start at the first node.
608609
fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
609610
/// Returns whether a full sync should be requested from a peer.

0 commit comments

Comments
 (0)