Skip to content

Commit 08951f7

Browse files
committed
Update router docs
1 parent 965714e commit 08951f7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

lightning/src/ln/router.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! The top-level routing logic lives here.
22
//!
3-
//! You probably want to create a Router and use that as your RoutingMessageHandler and then
4-
//! interrogate it to get routes for your own payments.
3+
//! Helps to create routes for your own payments based on the NetworkGraph,
4+
//! constructed from network messages which may come from different sources.
55
66
use secp256k1::key::PublicKey;
77

@@ -155,13 +155,13 @@ struct DummyDirectionalChannelInfo {
155155
}
156156

157157
impl Router {
158-
/// Creates a new router with the given node_id to be used as the source for get_route()
158+
/// Creates a new router
159159
pub fn new(logger: Arc<Logger>) -> Self {
160160
Router {
161161
logger: logger.clone(),
162162
}
163163
}
164-
/// Gets a route from us to the given target node.
164+
/// Gets a route from us (as specified in the provided NetworkGraph) to the given target node.
165165
///
166166
/// Extra routing hops between known nodes and the target will be used if they are included in
167167
/// last_hops.

0 commit comments

Comments
 (0)