From 96b9cf28588619642a2fbf9ef6639e811d563e56 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Tue, 24 Jan 2023 05:04:21 +0000 Subject: [PATCH] Update the `gossip` and `router` module docs which were out of date --- lightning/src/routing/gossip.rs | 2 +- lightning/src/routing/router.rs | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/lightning/src/routing/gossip.rs b/lightning/src/routing/gossip.rs index bbb8732f2..e3645271b 100644 --- a/lightning/src/routing/gossip.rs +++ b/lightning/src/routing/gossip.rs @@ -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; diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs index a2c98212f..65fbbbc96 100644 --- a/lightning/src/routing/router.rs +++ b/lightning/src/routing/router.rs @@ -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; -- 2.39.5