Merge pull request #1121 from TheBlueMatt/2021-10-return-temp-id
[rust-lightning] / lightning / src / routing / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Structs and impls for receiving messages about the network and storing the topology live here.
11
12 pub mod network_graph;
13 pub mod router;
14 pub mod scorer;
15
16 /// An interface used to score payment channels for path finding.
17 ///
18 ///     Scoring is in terms of fees willing to be paid in order to avoid routing through a channel.
19 pub trait Score {
20         /// Returns the fee in msats willing to be paid to avoid routing through the given channel.
21         fn channel_penalty_msat(&self, short_channel_id: u64) -> u64;
22 }