Add PeerManager::disconnect_by_node_id()
[rust-lightning] / lightning / src / ln / msgs.rs
index 073637413a82630866f8c7b3681683c883658375..25553c7080fdaa46e9268978d8348e5be00140cb 100644 (file)
@@ -804,6 +804,12 @@ pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Syn
 }
 
 /// A trait to describe an object which can receive routing messages.
+///
+/// # Implementor DoS Warnings
+///
+/// For `gossip_queries` messages there are potential DoS vectors when handling
+/// inbound queries. Implementors using an on-disk network graph should be aware of
+/// repeated disk I/O for queries accessing different parts of the network graph.
 pub trait RoutingMessageHandler : Send + Sync + events::MessageSendEventsProvider {
        /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
        /// false or returning an Err otherwise.
@@ -825,11 +831,9 @@ pub trait RoutingMessageHandler : Send + Sync + events::MessageSendEventsProvide
        /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
        /// If None is provided for starting_point, we start at the first node.
        fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
-       /// Returns whether a full sync should be requested from a peer.
-       fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
-       /// Initiates routing gossip sync by querying a peer to discover channels
-       /// and their associated routing gossip messages. This method will use a
-       /// sync strategy defined by the implementor.
+       /// Called when a connection is established with a peer. This can be used to
+       /// perform routing table synchronization using a strategy defined by the
+       /// implementor.
        fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
        /// Handles the reply of a query we initiated to learn about channels
        /// for a given range of blocks. We can expect to receive one or more
@@ -841,14 +845,10 @@ pub trait RoutingMessageHandler : Send + Sync + events::MessageSendEventsProvide
        /// gossip messages.
        fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
        /// Handles when a peer asks us to send a list of short_channel_ids
-       /// for the requested range of blocks. There are potential DoS vectors when
-       /// handling inbound queries. Handling requests with first_blocknum very far
-       /// away may trigger repeated disk I/O if the NetworkGraph is not fully in-memory.
+       /// for the requested range of blocks.
        fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
        /// Handles when a peer asks us to send routing gossip messages for a
-       /// list of short_channel_ids. There are potential DoS vectors when handling
-       /// inbound queries. Handling requests with first_blocknum very far away may
-       /// trigger repeated disk I/O if the NetworkGraph is not fully in-memory.
+       /// list of short_channel_ids.
        fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
 }