Add channel scoring to get_route
[rust-lightning] / lightning / src / routing / mod.rs
index ca7b920563839cab087eaab7b3e102e8eb268cb9..1cf73c2689eecc9029114d7ab6d24c4b19b66557 100644 (file)
@@ -9,5 +9,14 @@
 
 //! Structs and impls for receiving messages about the network and storing the topology live here.
 
-pub mod router;
 pub mod network_graph;
+pub mod router;
+pub mod scorer;
+
+/// An interface used to score payment channels for path finding.
+///
+///    Scoring is in terms of fees willing to be paid in order to avoid routing through a channel.
+pub trait Score {
+       /// Returns the fee in msats willing to be paid to avoid routing through the given channel.
+       fn channel_penalty_msat(&self, short_channel_id: u64) -> u64;
+}