]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Update the `gossip` and `router` module docs which were out of date
authorMatt Corallo <git@bluematt.me>
Tue, 24 Jan 2023 05:04:21 +0000 (05:04 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 8 Feb 2023 23:54:00 +0000 (23:54 +0000)
lightning/src/routing/gossip.rs
lightning/src/routing/router.rs

index bbb8732f27713d83d4410a45c9c61b84e286f2e5..e3645271b2bcdfa377980c66dfbbfba7ba123162 100644 (file)
@@ -7,7 +7,7 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
-//! The top-level network map tracking logic lives here.
+//! The [`NetworkGraph`] stores the network gossip and [`P2PGossipSync`] fetches it from peers
 
 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
 use bitcoin::secp256k1::PublicKey;
index a2c98212f65062c1cdb33e4ae1551b07c11f3813..65fbbbc9646747d4b85d98d6e9fbd3e5abcf89cf 100644 (file)
@@ -7,10 +7,7 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
-//! The top-level routing/network map tracking logic lives here.
-//!
-//! You probably want to create a P2PGossipSync and use that as your RoutingMessageHandler and then
-//! interrogate it to get routes for your own payments.
+//! The router finds paths within a [`NetworkGraph`] for a payment.
 
 use bitcoin::secp256k1::PublicKey;
 use bitcoin::hashes::Hash;