Skip to content

Commit 96b9cf2

Browse files
committed
Update the gossip and router module docs which were out of date
1 parent 51a3353 commit 96b9cf2

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

lightning/src/routing/gossip.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
// You may not use this file except in accordance with one or both of these
88
// licenses.
99

10-
//! The top-level network map tracking logic lives here.
10+
//! The [`NetworkGraph`] stores the network gossip and [`P2PGossipSync`] fetches it from peers
1111
1212
use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
1313
use bitcoin::secp256k1::PublicKey;

lightning/src/routing/router.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@
77
// You may not use this file except in accordance with one or both of these
88
// licenses.
99

10-
//! The top-level routing/network map tracking logic lives here.
11-
//!
12-
//! You probably want to create a P2PGossipSync and use that as your RoutingMessageHandler and then
13-
//! interrogate it to get routes for your own payments.
10+
//! The router finds paths within a [`NetworkGraph`] for a payment.
1411
1512
use bitcoin::secp256k1::PublicKey;
1613
use bitcoin::hashes::Hash;

0 commit comments

Comments
 (0)