Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Oct 16, 2021
Merged

Add channel scoring to get_route #1124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
let scorer = Scorer::new(0);

let peers = RefCell::new([false; 256]);
let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
},
4 => {
let value = slice_to_be24(get_slice!(3)) as u64;
let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
Ok(route) => route,
Err(_) => return,
};
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
},
15 => {
let value = slice_to_be24(get_slice!(3)) as u64;
let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
Ok(route) => route,
Err(_) => return,
};
Expand Down
4 changes: 3 additions & 1 deletion fuzz/src/router.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
}]));
}
}
let scorer = Scorer::new(0);
for target in node_pks.iter() {
let _ = get_route(&our_pubkey, &net_graph, target, None,
first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
&last_hops.iter().collect::<Vec<_>>(),
slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
}
},
}
Expand Down
3 changes: 3 additions & 0 deletions lightning-invoice/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs::ChannelMessageHandler;
use lightning::routing::router;
use lightning::routing::scorer::Scorer;
use lightning::util::events::MessageSendEventsProvider;
use lightning::util::test_utils;
#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
let last_hops = invoice.route_hints();
let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
let logger = test_utils::TestLogger::new();
let scorer = Scorer::new(0);
let route = router::get_route(
&nodes[0].node.get_our_node_id(),
network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
amt_msat,
invoice.min_final_cltv_expiry() as u32,
&logger,
&scorer,
).unwrap();

let payment_event = {
Expand Down
16 changes: 11 additions & 5 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{get_keysend_route, get_route};
use routing::scorer::Scorer;
use util::errors::APIError;
use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
let logger = test_utils::TestLogger::new();
let scorer = Scorer::new(0);

// To start (1), send a regular payment but don't claim it.
let expected_route = [&nodes[1]];
let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

// Next, attempt a keysend payment and make sure it fails.
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
check_added_monitors!(nodes[0], 1);
let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

// To start (2), send a keysend payment but don't claim it.
let payment_preimage = PaymentPreimage([42; 32]);
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
check_added_monitors!(nodes[0], 1);
let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
let first_hops = nodes[0].node.list_usable_channels();
let scorer = Scorer::new(0);
let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
nodes[0].logger).unwrap();
nodes[0].logger, &scorer).unwrap();

let test_preimage = PaymentPreimage([42; 32]);
let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
let first_hops = nodes[0].node.list_usable_channels();
let scorer = Scorer::new(0);
let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
nodes[0].logger).unwrap();
nodes[0].logger, &scorer).unwrap();

let test_preimage = PaymentPreimage([42; 32]);
let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
use ln::msgs::{ChannelMessageHandler, Init};
use routing::network_graph::NetworkGraph;
use routing::router::get_route;
use routing::scorer::Scorer;
use util::test_utils;
use util::config::UserConfig;
use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
macro_rules! send_payment {
($node_a: expr, $node_b: expr) => {
let usable_channels = $node_a.list_usable_channels();
let scorer = Scorer::new(0);
let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

let mut payment_preimage = PaymentPreimage([0; 32]);
payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down
12 changes: 8 additions & 4 deletions lightning/src/ln/functional_test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
let scorer = ::routing::scorer::Scorer::new(0);
let route = ::routing::router::get_route(
&$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
&$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
&$last_hops, $recv_value, $cltv, $send_node.logger
&$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
).unwrap();
(route, payment_hash, payment_preimage, payment_secret)
}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
let scorer = Scorer::new(0);
let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
&expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
assert_eq!(route.paths.len(), 1);
assert_eq!(route.paths[0].len(), expected_route.len());
for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
let scorer = Scorer::new(0);
let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
assert_eq!(route.paths.len(), 1);
assert_eq!(route.paths[0].len(), expected_route.len());
for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down
15 changes: 10 additions & 5 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
// Create some initial channels
create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
let scorer = Scorer::new(0);
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
let scorer = Scorer::new(0);
let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
&nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
&nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
&nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
&nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
let payer_pubkey = nodes[0].node.get_our_node_id();
let payee_pubkey = nodes[1].node.get_our_node_id();
let scorer = Scorer::new(0);
let route = get_keysend_route(
&payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
&payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
).unwrap();

let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
let first_hops = nodes[0].node.list_usable_channels();
let scorer = Scorer::new(0);
let route = get_keysend_route(
&payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
&vec![], 10000, 40, nodes[0].logger
&vec![], 10000, 40, nodes[0].logger, &scorer
).unwrap();

let test_preimage = PaymentPreimage([42; 32]);
Expand Down
8 changes: 5 additions & 3 deletions lightning/src/ln/shutdown_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
let logger = test_utils::TestLogger::new();
let scorer = Scorer::new(0);

let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down
11 changes: 10 additions & 1 deletion lightning/src/routing/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add channel scoring to get_route#1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Oct 16, 2021
 Merged


Add channel scoring to get_route
#1124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 5 additions & 3 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,9 @@ use lightning::ln::channelmanager::{ChainParameters, ChannelManager};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor,IgnoringMessageHandler};
use lightning::ln::msgs::DecodeError;
use lightning::ln::script::ShutdownScript;
use lightning::routing::router::get_route;
use lightning::routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use lightning::routing::router::get_route;
use lightning::routing::scorer::Scorer;
use lightning::util::config::UserConfig;
use lightning::util::errors::APIError;
use lightning::util::events::Event;
Expand DownExpand Up@@ -380,6 +381,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
	let scorer = Scorer::new(0);

	let peers = RefCell::new([false; 256]);
	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {
Expand DownExpand Up@@ -435,7 +437,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 4 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand All@@ -452,7 +454,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 },
 15 => {
 let value = slice_to_be24(get_slice!(3)) as u64;
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger)) {
 let mut route = match get_route(&our_id, &net_graph_msg_handler.network_graph, &get_pubkey!(), None, None, &Vec::new(), value, 42, Arc::clone(&logger), &scorer) {
 Ok(route) => route,
 Err(_) => return,
 };
Expand Down

4 changes: 3 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ use lightning::ln::channelmanager::{ChannelDetails, ChannelCounterparty};
use lightning::ln::features::InitFeatures;
use lightning::ln::msgs;
use lightning::routing::router::{get_route, RouteHint, RouteHintHop};
use lightning::routing::scorer::Scorer;
use lightning::util::logger::Logger;
use lightning::util::ser::Readable;
use lightning::routing::network_graph::{NetworkGraph, RoutingFees};
Expand DownExpand Up@@ -247,11 +248,12 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 }]));
 }
 }
 let scorer = Scorer::new(0);
 for target in node_pks.iter() {
 let _ = get_route(&our_pubkey, &net_graph, target, None,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
 &last_hops.iter().collect::<Vec<_>>(),
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger));
 slice_to_be64(get_slice!(8)), slice_to_be32(get_slice!(4)), Arc::clone(&logger), &scorer);
 }
 },
 }
Expand Down

3 changes: 3 additions & 0 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ mod test {
	use lightning::ln::features::InitFeatures;
	use lightning::ln::msgs::ChannelMessageHandler;
	use lightning::routing::router;
	use lightning::routing::scorer::Scorer;
	use lightning::util::events::MessageSendEventsProvider;
	use lightning::util::test_utils;
	#[test]
Expand All@@ -117,6 +118,7 @@ mod test {
 let last_hops = invoice.route_hints();
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);
 let route = router::get_route(
 &nodes[0].node.get_our_node_id(),
 network_graph,
Expand All@@ -127,6 +129,7 @@ mod test {
 amt_msat,
 invoice.min_final_cltv_expiry() as u32,
 &logger,
 &scorer,
 ).unwrap();

 let payment_event = {
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5804,6 +5804,7 @@ mod tests {
	use ln::msgs;
	use ln::msgs::ChannelMessageHandler;
	use routing::router::{get_keysend_route, get_route};
	use routing::scorer::Scorer;
	use util::errors::APIError;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
	use util::test_utils;
Expand DownExpand Up@@ -6042,13 +6043,14 @@ mod tests {
 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 let logger = test_utils::TestLogger::new();
 let scorer = Scorer::new(0);

 // To start (1), send a regular payment but don't claim it.
 let expected_route = [&nodes[1]];
 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);

 // Next, attempt a keysend payment and make sure it fails.
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6076,7 +6078,7 @@ mod tests {

 // To start (2), send a keysend payment but don't claim it.
 let payment_preimage = PaymentPreimage([42; 32]);
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
 check_added_monitors!(nodes[0], 1);
 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
Expand DownExpand Up@@ -6130,9 +6132,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let mismatch_payment_hash = PaymentHash([43; 32]);
Expand DownExpand Up@@ -6166,9 +6169,10 @@ mod tests {
 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
 nodes[0].logger).unwrap();
 nodes[0].logger, &scorer).unwrap();

 let test_preimage = PaymentPreimage([42; 32]);
 let test_secret = PaymentSecret([43; 32]);
Expand DownExpand Up@@ -6230,6 +6234,7 @@ pub mod bench {
	use ln::msgs::{ChannelMessageHandler, Init};
	use routing::network_graph::NetworkGraph;
	use routing::router::get_route;
	use routing::scorer::Scorer;
	use util::test_utils;
	use util::config::UserConfig;
	use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
Expand DownExpand Up@@ -6337,8 +6342,9 @@ pub mod bench {
 macro_rules! send_payment {
 ($node_a: expr, $node_b: expr) => {
 let usable_channels = $node_a.list_usable_channels();
 let scorer = Scorer::new(0);
 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();

 let mut payment_preimage = PaymentPreimage([0; 32]);
 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
Expand Down

12 changes: 8 additions & 4 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,9 @@ use chain::channelmonitor::ChannelMonitor;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
use routing::router::{Route, get_route};
use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
use routing::router::{Route, get_route};
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -996,11 +997,12 @@ macro_rules! get_route_and_payment_hash {
	($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 let scorer = ::routing::scorer::Scorer::new(0);
 let route = ::routing::router::get_route(
 &$send_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &$recv_node.node.get_our_node_id(), Some(::ln::features::InvoiceFeatures::known()),
 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
 &$last_hops, $recv_value, $cltv, $send_node.logger
 &$last_hops, $recv_value, $cltv, $send_node.logger, &scorer
 ).unwrap();
 (route, payment_hash, payment_preimage, payment_secret)
	}}
Expand DownExpand Up@@ -1311,10 +1313,11 @@ pub const TEST_FINAL_CLTV: u32 = 70;

pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand All@@ -1326,7 +1329,8 @@ pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route:

pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
	let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
Expand Down

15 changes: 10 additions & 5 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ use ln::{chan_utils, onion_utils};
use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
use routing::network_graph::{NetworkUpdate, RoutingFees};
use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
use routing::scorer::Scorer;
use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -7264,7 +7265,8 @@ fn test_check_htlc_underpaying() {
	// Create some initial channels
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
	let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
	nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
Expand DownExpand Up@@ -7664,11 +7666,12 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {

	let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
	// Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
	let scorer = Scorer::new(0);
	let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger, &scorer).unwrap();
	send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);

	let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
Expand DownExpand Up@@ -9166,8 +9169,9 @@ fn test_keysend_payments_to_public_node() {
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let payer_pubkey = nodes[0].node.get_our_node_id();
	let payee_pubkey = nodes[1].node.get_our_node_id();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger
 &payer_pubkey, &network_graph, &payee_pubkey, None, &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand DownExpand Up@@ -9196,9 +9200,10 @@ fn test_keysend_payments_to_private_node() {
	let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
	let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
	let first_hops = nodes[0].node.list_usable_channels();
	let scorer = Scorer::new(0);
	let route = get_keysend_route(
 &payer_pubkey, &network_graph, &payee_pubkey, Some(&first_hops.iter().collect::<Vec<_>>()),
 &vec![], 10000, 40, nodes[0].logger
 &vec![], 10000, 40, nodes[0].logger, &scorer
	).unwrap();

	let test_preimage = PaymentPreimage([42; 32]);
Expand Down

8 changes: 5 additions & 3 deletions
lightning/src/ln/shutdown_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,8 +13,9 @@ use chain::keysinterface::KeysInterface;
use chain::transaction::OutPoint;
use ln::{PaymentPreimage, PaymentHash};
use ln::channelmanager::PaymentSendFailure;
use routing::network_graph::NetworkUpdate;
use routing::router::get_route;
use routing::network_graph::NetworkUpdate;
use routing::scorer::Scorer;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::{ChannelMessageHandler, ErrorAction};
Expand DownExpand Up@@ -81,6 +82,7 @@ fn updates_shutdown_wait() {
	let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
	let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
	let logger = test_utils::TestLogger::new();
	let scorer = Scorer::new(0);

	let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);

Expand All@@ -97,8 +99,8 @@ fn updates_shutdown_wait() {

	let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
	let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
	let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
	unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
	unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});

Expand Down

11 changes: 10 additions & 1 deletion
lightning/src/routing/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
Comment thread
valentinewallace marked this conversation as resolved.

}
Loading