Merge pull request #1133 from jkczyz/2021-10-expand-scorer

[rust-lightning] / lightning / src / routing / mod.rs

diff --git a/lightning/src/routing/mod.rs b/lightning/src/routing/mod.rs
index 9e72d7c3e0f6fb132ece179fe142fa0219bbe425..51ffd91b50483d58bc2016440bdb98d9f82886e5 100644 (file)
--- a/lightning/src/routing/mod.rs
+++ b/lightning/src/routing/mod.rs
@@ -1,3 +1,25 @@
+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// You may not use this file except in accordance with one or both of these
+// licenses.
+
 //! Structs and impls for receiving messages about the network and storing the topology live here.
 
+pub mod network_graph;
 pub mod router;
+pub mod scorer;
+
+use routing::network_graph::NodeId;
+
+/// 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
+       /// in the direction from `source` to `target`.
+       fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId) -> u64;
+}