Rename NetGraphMsgHandler to P2PGossipSync
[rust-lightning] / lightning / src / ln / mod.rs
index 1e5f49f07df6a0cc5056e6ea26545cfac33d04ec..932ca70b00f1f9cf22a47f51cd79beaff5bc54dc 100644 (file)
@@ -9,14 +9,17 @@
 
 //! High level lightning structs and impls live here.
 //!
-//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler first.
+//! You probably want to create a [`ChannelManager`], and a [`P2PGossipSync`] first.
 //! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to
 //! create/manage connections and call get_and_clear_pending_events after each action, handling
 //! them appropriately.
 //!
-//! When you want to open/close a channel or send a payment, call into your ChannelManager and when
-//! you want to learn things about the network topology (eg get a route for sending a payment),
-//! call into your NetGraphMsgHandler.
+//! When you want to open/close a channel or send a payment, call into your [`ChannelManager`] and
+//! when you want to learn things about the network topology (eg get a route for sending a payment),
+//! call into your [`P2PGossipSync`].
+//!
+//! [`ChannelManager`]: channelmanager::ChannelManager
+//! [`P2PGossipSync`]: crate::routing::network_graph::P2PGossipSync
 
 #[cfg(any(test, feature = "_test_utils"))]
 #[macro_use]