Skip to content

Commit cba0e24

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

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
@@ -651,10 +651,11 @@ pub trait RoutingMessageHandler : Send + Sync {
651651
fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
652652
/// Gets a subset of the channel announcements and updates required to dump our routing table
653653
/// to a remote node, starting at the short_channel_id indicated by starting_point and
654-
/// including batch_amount entries.
654+
/// including the batch_amount entries immediately higher in numerical value than starting_point.
655655
fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
656656
/// Gets a subset of the node announcements required to dump our routing table to a remote node,
657-
/// starting at the node *after* the provided publickey and including batch_amount entries.
657+
/// starting at the node *after* the provided publickey and including batch_amount entries
658+
/// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
658659
/// If None is provided for starting_point, we start at the first node.
659660
fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
660661
/// Returns whether a full sync should be requested from a peer.

0 commit comments

Comments
 (0)