Trait lightning::ln::msgs::RoutingMessageHandler
source · pub trait RoutingMessageHandler: MessageSendEventsProvider {
Show 13 methods
// Required methods
fn handle_node_announcement(
&self,
msg: &NodeAnnouncement
) -> Result<bool, LightningError>;
fn handle_channel_announcement(
&self,
msg: &ChannelAnnouncement
) -> Result<bool, LightningError>;
fn handle_channel_update(
&self,
msg: &ChannelUpdate
) -> Result<bool, LightningError>;
fn get_next_channel_announcement(
&self,
starting_point: u64
) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
fn get_next_node_announcement(
&self,
starting_point: Option<&NodeId>
) -> Option<NodeAnnouncement>;
fn peer_connected(
&self,
their_node_id: &PublicKey,
init: &Init,
inbound: bool
) -> Result<(), ()>;
fn handle_reply_channel_range(
&self,
their_node_id: &PublicKey,
msg: ReplyChannelRange
) -> Result<(), LightningError>;
fn handle_reply_short_channel_ids_end(
&self,
their_node_id: &PublicKey,
msg: ReplyShortChannelIdsEnd
) -> Result<(), LightningError>;
fn handle_query_channel_range(
&self,
their_node_id: &PublicKey,
msg: QueryChannelRange
) -> Result<(), LightningError>;
fn handle_query_short_channel_ids(
&self,
their_node_id: &PublicKey,
msg: QueryShortChannelIds
) -> Result<(), LightningError>;
fn processing_queue_high(&self) -> bool;
fn provided_node_features(&self) -> NodeFeatures;
fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
}
Expand description
A trait to describe an object which can receive routing messages.
Implementor DoS Warnings
For messages enabled with the gossip_queries
feature 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.
Required Methods§
sourcefn handle_node_announcement(
&self,
msg: &NodeAnnouncement
) -> Result<bool, LightningError>
fn handle_node_announcement( &self, msg: &NodeAnnouncement ) -> Result<bool, LightningError>
Handle an incoming node_announcement
message, returning true
if it should be forwarded on,
false
or returning an Err
otherwise.
sourcefn handle_channel_announcement(
&self,
msg: &ChannelAnnouncement
) -> Result<bool, LightningError>
fn handle_channel_announcement( &self, msg: &ChannelAnnouncement ) -> Result<bool, LightningError>
Handle a channel_announcement
message, returning true
if it should be forwarded on, false
or returning an Err
otherwise.
sourcefn handle_channel_update(
&self,
msg: &ChannelUpdate
) -> Result<bool, LightningError>
fn handle_channel_update( &self, msg: &ChannelUpdate ) -> Result<bool, LightningError>
Handle an incoming channel_update
message, returning true if it should be forwarded on,
false
or returning an Err
otherwise.
sourcefn get_next_channel_announcement(
&self,
starting_point: u64
) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>
fn get_next_channel_announcement( &self, starting_point: u64 ) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>
Gets channel announcements and updates required to dump our routing table to a remote node,
starting at the short_channel_id
indicated by starting_point
and including announcements
for a single channel.
sourcefn get_next_node_announcement(
&self,
starting_point: Option<&NodeId>
) -> Option<NodeAnnouncement>
fn get_next_node_announcement( &self, starting_point: Option<&NodeId> ) -> Option<NodeAnnouncement>
Gets a node announcement required to dump our routing table to a remote node, starting at
the node after the provided pubkey and including up to one announcement 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.
sourcefn peer_connected(
&self,
their_node_id: &PublicKey,
init: &Init,
inbound: bool
) -> Result<(), ()>
fn peer_connected( &self, their_node_id: &PublicKey, init: &Init, inbound: bool ) -> Result<(), ()>
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.
May return an Err(())
if the features the peer supports are not sufficient to communicate
with us. Implementors should be somewhat conservative about doing so, however, as other
message handlers may still wish to communicate with this peer.
sourcefn handle_reply_channel_range(
&self,
their_node_id: &PublicKey,
msg: ReplyChannelRange
) -> Result<(), LightningError>
fn handle_reply_channel_range( &self, their_node_id: &PublicKey, msg: ReplyChannelRange ) -> Result<(), LightningError>
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 replies to a single query.
sourcefn handle_reply_short_channel_ids_end(
&self,
their_node_id: &PublicKey,
msg: ReplyShortChannelIdsEnd
) -> Result<(), LightningError>
fn handle_reply_short_channel_ids_end( &self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd ) -> Result<(), LightningError>
Handles the reply of a query we initiated asking for routing gossip messages for a list of channels. We should receive this message when a node has completed its best effort to send us the pertaining routing gossip messages.
sourcefn handle_query_channel_range(
&self,
their_node_id: &PublicKey,
msg: QueryChannelRange
) -> Result<(), LightningError>
fn handle_query_channel_range( &self, their_node_id: &PublicKey, msg: QueryChannelRange ) -> Result<(), LightningError>
Handles when a peer asks us to send a list of short_channel_id
s
for the requested range of blocks.
sourcefn handle_query_short_channel_ids(
&self,
their_node_id: &PublicKey,
msg: QueryShortChannelIds
) -> Result<(), LightningError>
fn handle_query_short_channel_ids( &self, their_node_id: &PublicKey, msg: QueryShortChannelIds ) -> Result<(), LightningError>
Handles when a peer asks us to send routing gossip messages for a
list of short_channel_id
s.
sourcefn processing_queue_high(&self) -> bool
fn processing_queue_high(&self) -> bool
Indicates that there are a large number of ChannelAnnouncement
(or other) messages
pending some async action. While there is no guarantee of the rate of future messages, the
caller should seek to reduce the rate of new gossip messages handled, especially
ChannelAnnouncement
s.
sourcefn provided_node_features(&self) -> NodeFeatures
fn provided_node_features(&self) -> NodeFeatures
Gets the node feature flags which this handler itself supports. All available handlers are
queried similarly and their feature flags are OR’d together to form the NodeFeatures
which are broadcasted in our NodeAnnouncement
message.
sourcefn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures
fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures
Gets the init feature flags which should be sent to the given peer. All available handlers
are queried similarly and their feature flags are OR’d together to form the InitFeatures
which are sent in our Init
message.
Note that this method is called before Self::peer_connected
.