Have get_route and Route take RouteParameters#2555

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 5 commits into from
Sep 6, 2023
Merged

Have get_route and Route take RouteParameters#2555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3612b8
Add constructor to `RouteParameters`
tnull Aug 31, 2023
266a3aa
Have `get_route` take `RouteParameters`
tnull Aug 31, 2023
61cf752
Have `Route` hold `RouteParameters`
tnull Aug 31, 2023
6082b57
Include overpaid value in `Route::get_total_fees`
tnull Sep 6, 2023
543674f
Improve `Route::get_total_amount` docs
tnull Sep 6, 2023
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
6 changes: 3 additions & 3 deletions fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
fee_msat: amt,
cltv_expiry_delta: 200,
}], blinded_tail: None }],
payment_params: None,
route_params: None,
}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
channel_features: middle.channel_features(),
fee_msat: first_hop_fee,
cltv_expiry_delta: 100,
},RouteHop {
},RouteHop {
pubkey: dest.get_our_node_id(),
node_features: dest.node_features(),
short_channel_id: dest_chan_id,
channel_features: dest.channel_features(),
fee_msat: amt,
cltv_expiry_delta: 200,
}], blinded_tail: None }],
payment_params: None,
route_params: None,
}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
let sent_amt = amt + first_hop_fee;
check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down
12 changes: 4 additions & 8 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
4 => {
let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
let params = RouteParameters {
payment_params,
final_value_msat,
};
let params = RouteParameters::from_payment_params_and_value(
payment_params, final_value_msat);
let mut payment_hash = PaymentHash([0; 32]);
payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
15 => {
let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
let params = RouteParameters {
payment_params,
final_value_msat,
};
let params = RouteParameters::from_payment_params_and_value(
payment_params, final_value_msat);
let mut payment_hash = PaymentHash([0; 32]);
payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
let mut sha = Sha256::engine();
Expand Down
15 changes: 6 additions & 9 deletions fuzz/src/router.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
let mut last_hops = Vec::new();
last_hops!(last_hops);
find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
RouteParameters::from_payment_params_and_value(
PaymentParameters::from_node_id(*target, final_delta)
.with_route_hints(last_hops.clone()).unwrap(),
final_value_msat: final_amt,
}
final_amt)
});
},
x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
let mut features = Bolt12InvoiceFeatures::empty();
features.set_basic_mpp_optional();
find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
RouteParameters {
payment_params: PaymentParameters::blinded(last_hops.clone())
.with_bolt12_features(features.clone()).unwrap(),
final_value_msat: final_amt,
}
RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
.with_bolt12_features(features.clone()).unwrap(),
final_amt)
});
}
}
Expand Down
12 changes: 4 additions & 8 deletions lightning-invoice/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
invoice.min_final_cltv_expiry_delta() as u32)
.with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
.with_route_hints(invoice.route_hints()).unwrap();
let route_params = RouteParameters {
payment_params,
final_value_msat: invoice.amount_milli_satoshis().unwrap(),
};
let route_params = RouteParameters::from_payment_params_and_value(
payment_params, invoice.amount_milli_satoshis().unwrap());
let payment_event = {
let mut payment_hash = PaymentHash([0; 32]);
payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
invoice.min_final_cltv_expiry_delta() as u32)
.with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
.with_route_hints(invoice.route_hints()).unwrap();
let params = RouteParameters {
payment_params,
final_value_msat: invoice.amount_milli_satoshis().unwrap(),
};
let params = RouteParameters::from_payment_params_and_value(
payment_params, invoice.amount_milli_satoshis().unwrap());
let (payment_event, fwd_idx) = {
let mut payment_hash = PaymentHash([0; 32]);
payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down
33 changes: 14 additions & 19 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
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_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
let route_params = RouteParameters::from_payment_params_and_value(
PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
TEST_FINAL_CLTV, false), 100_000);
let route = find_route(
&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

// Next, attempt a keysend payment and make sure it fails.
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
let route_params = RouteParameters::from_payment_params_and_value(
PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
100_000
);
let route = find_route(
&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
let payee_pubkey = nodes[1].node.get_our_node_id();

let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
final_value_msat: 10_000,
};
let route_params = RouteParameters::from_payment_params_and_value(
PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
let network_graph = nodes[0].network_graph.clone();
let first_hops = nodes[0].node.list_usable_channels();
let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
let payee_pubkey = nodes[1].node.get_our_node_id();

let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
final_value_msat: 10_000,
};
let route_params = RouteParameters::from_payment_params_and_value(
PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
let network_graph = nodes[0].network_graph.clone();
let first_hops = nodes[0].node.list_usable_channels();
let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

$node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
Retry::Attempts(0)).unwrap();
let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
$node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
$node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down
27 changes: 15 additions & 12 deletions lightning/src/ln/functional_test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
let scorer = TestScorer::new();
let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
let random_seed_bytes = keys_manager.get_secure_random_bytes();
router::get_route(
&send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
&send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
send_node.logger, &scorer, &(), &random_seed_bytes
)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
($send_node: expr, $payment_params: expr, $recv_value: expr) => {
$crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
}
($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
$crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
$crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
}};
($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
let (payment_preimage, payment_hash, payment_secret) =
$crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
(route.unwrap(), payment_hash, payment_preimage, payment_secret)
}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
.with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
let route = get_route(origin_node, &payment_params, recv_value).unwrap();
let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
let route = get_route(origin_node, &route_params).unwrap();
assert_eq!(route.paths.len(), 1);
assert_eq!(route.paths[0].hops.len(), expected_route.len());
for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
.with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
let network_graph = origin_node.network_graph.read_only();
let scorer = test_utils::TestScorer::new();
let seed = [0u8; 32];
let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
let random_seed_bytes = keys_manager.get_secure_random_bytes();
let route = router::get_route(
&origin_node.node.get_our_node_id(), &payment_params, &network_graph,
None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
assert_eq!(route.paths.len(), 1);
assert_eq!(route.paths[0].hops.len(), expected_route.len());
for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down
27 changes: 18 additions & 9 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
});
hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
let payment_preimage_1 = send_along_route(&nodes[1],
Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
&vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

let mut hops = Vec::with_capacity(3);
hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
});
hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
let payment_hash_2 = send_along_route(&nodes[1],
Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
&vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

// Claim the rebalances...
fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

let scorer = test_utils::TestScorer::new();
let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
let scorer = test_utils::TestScorer::new();
let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
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
Have get_route and Route take RouteParameters#2555

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 5 commits into

from

Sep 6, 2023
 Merged


Have get_route and Route take RouteParameters#2555
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b3612b8

Add constructor to `RouteParameters`


tnull Aug 31, 2023
266a3aa

Have `get_route` take `RouteParameters`


tnull Aug 31, 2023
61cf752

Have `Route` hold `RouteParameters`


tnull Aug 31, 2023
6082b57

Include overpaid value in `Route::get_total_fees`


tnull Sep 6, 2023
543674f

Improve `Route::get_total_amount` docs


tnull Sep 6, 2023

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


6 changes: 3 additions & 3 deletions
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -376,7 +376,7 @@ fn send_payment(source: &ChanMan, dest: &ChanMan, dest_chan_id: u64, amt: u64, p
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 check_payment_err(err, amt > max_value_sendable || amt < min_value_sendable);
 false
Expand DownExpand Up@@ -409,15 +409,15 @@ fn send_hop_payment(source: &ChanMan, middle: &ChanMan, middle_chan_id: u64, des
 channel_features: middle.channel_features(),
 fee_msat: first_hop_fee,
 cltv_expiry_delta: 100,
 },RouteHop {
 },RouteHop {
 pubkey: dest.get_our_node_id(),
 node_features: dest.node_features(),
 short_channel_id: dest_chan_id,
 channel_features: dest.channel_features(),
 fee_msat: amt,
 cltv_expiry_delta: 200,
 }], blinded_tail: None }],
payment_params: None,
route_params: None,
	}, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_id)) {
 let sent_amt = amt + first_hop_fee;
 check_payment_err(err, sent_amt < min_value_sendable || sent_amt > max_value_sendable);
Expand Down

12 changes: 4 additions & 8 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -527,10 +527,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 4 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand All@@ -548,10 +546,8 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 15 => {
 let final_value_msat = slice_to_be24(get_slice!(3)) as u64;
 let payment_params = PaymentParameters::from_node_id(get_pubkey!(), 42);
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, final_value_msat);
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
 let mut sha = Sha256::engine();
Expand Down

15 changes: 6 additions & 9 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -326,11 +326,10 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut last_hops = Vec::new();
 last_hops!(last_hops);
 find_routes!(first_hops, node_pks.iter(), |final_amt, final_delta, target: &PublicKey| {
 RouteParameters {
payment_params: PaymentParameters::from_node_id(*target, final_delta)
 RouteParameters::from_payment_params_and_value(
 PaymentParameters::from_node_id(*target, final_delta)
 .with_route_hints(last_hops.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 final_amt)
 });
 },
 x => {
Expand DownExpand Up@@ -366,11 +365,9 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 let mut features = Bolt12InvoiceFeatures::empty();
 features.set_basic_mpp_optional();
 find_routes!(first_hops, vec![dummy_pk].iter(), |final_amt, _, _| {
 RouteParameters {
 payment_params: PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_value_msat: final_amt,
 }
 RouteParameters::from_payment_params_and_value(PaymentParameters::blinded(last_hops.clone())
 .with_bolt12_features(features.clone()).unwrap(),
 final_amt)
 });
 }
 }
Expand Down

12 changes: 4 additions & 8 deletions
lightning-invoice/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -869,10 +869,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let payment_event = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand DownExpand Up@@ -1326,10 +1324,8 @@ mod test {
 invoice.min_final_cltv_expiry_delta() as u32)
 .with_bolt11_features(invoice.features().unwrap().clone()).unwrap()
 .with_route_hints(invoice.route_hints()).unwrap();
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 };
 let params = RouteParameters::from_payment_params_and_value(
 payment_params, invoice.amount_milli_satoshis().unwrap());
 let (payment_event, fwd_idx) = {
 let mut payment_hash = PaymentHash([0; 32]);
 payment_hash.0.copy_from_slice(&invoice.payment_hash().as_ref()[0..32]);
Expand Down

33 changes: 14 additions & 19 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9653,10 +9653,9 @@ mod tests {
 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_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 final_value_msat: 100_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
 TEST_FINAL_CLTV, false), 100_000);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9744,10 +9743,10 @@ mod tests {
 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));

 // Next, attempt a keysend payment and make sure it fails.
 let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
final_value_msat: 100_000,
};
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
 100_000
);
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
Expand DownExpand Up@@ -9793,10 +9792,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -9840,10 +9837,8 @@ mod tests {
 let payee_pubkey = nodes[1].node.get_our_node_id();

 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
 final_value_msat: 10_000,
 };
 let route_params = RouteParameters::from_payment_params_and_value(
 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
 let scorer = test_utils::TestScorer::new();
Expand DownExpand Up@@ -10740,9 +10735,9 @@ pub mod bench {
 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();

 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
 PaymentId(payment_hash.0), RouteParameters {
payment_params, final_value_msat: 10_000,
}, Retry::Attempts(0)).unwrap();
 PaymentId(payment_hash.0),
RouteParameters::from_payment_params_and_value(payment_params, 10_000),
 Retry::Attempts(0)).unwrap();
 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
Expand Down

27 changes: 15 additions & 12 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, Walle
use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
use crate::routing::router::{self, PaymentParameters, Route};
use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
use crate::ln::features::InitFeatures;
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
Expand DownExpand Up@@ -1838,14 +1838,14 @@ macro_rules! get_payment_preimage_hash {
}

/// Gets a route from the given sender to the node described in `payment_params`.
pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
	let scorer = TestScorer::new();
	let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	router::get_route(
 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
 send_node.logger, &scorer, &(), &random_seed_bytes
	)
}

Expand All@@ -1854,9 +1854,10 @@ pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_valu
/// Don't use this, use the identically-named function instead.
#[macro_export]
macro_rules! get_route {
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {
 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
	}
	($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
	}}
}

#[cfg(test)]
Expand All@@ -1868,9 +1869,10 @@ macro_rules! get_route_and_payment_hash {
 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
	}};
	($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
 let (payment_preimage, payment_hash, payment_secret) =
 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
	}}
}
Expand DownExpand Up@@ -2464,7 +2466,8 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route = get_route(origin_node, &payment_params, recv_value).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let route = get_route(origin_node, &route_params).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand All@@ -2478,14 +2481,14 @@ 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 payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
	let network_graph = origin_node.network_graph.read_only();
	let scorer = test_utils::TestScorer::new();
	let seed = [0u8; 32];
	let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
	let random_seed_bytes = keys_manager.get_secure_random_bytes();
	let route = router::get_route(
 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
	assert_eq!(route.paths.len(), 1);
	assert_eq!(route.paths[0].hops.len(), expected_route.len());
	for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
Expand Down

27 changes: 18 additions & 9 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
use crate::ln::{chan_utils, onion_utils};
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route};
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, get_route, RouteParameters};
use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
use crate::ln::msgs;
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
Expand DownExpand Up@@ -1049,7 +1049,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
	let payment_preimage_1 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;

	let mut hops = Vec::with_capacity(3);
	hops.push(RouteHop {
Expand DownExpand Up@@ -1078,7 +1080,9 @@ fn fake_network_test() {
	});
	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
	let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![Path { hops, blinded_tail: None }], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
	let payment_hash_2 = send_along_route(&nodes[1],
 Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
 &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;

	// Claim the rebalances...
	fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
Expand DownExpand Up@@ -7137,8 +7141,11 @@ fn test_check_htlc_underpaying() {

	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(),
 TEST_FINAL_CLTV).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
 None, nodes[0].logger, &scorer, &(), &random_seed_bytes).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, None).unwrap();
	nodes[0].node.send_payment_with_route(&route, our_payment_hash,
Expand DownExpand Up@@ -7394,12 +7401,14 @@ fn test_bump_penalty_txn_on_revoked_htlcs() {
	let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), 50).with_bolt11_features(nodes[1].node.invoice_features()).unwrap();
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
	let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
	let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), 50).with_bolt11_features(nodes[0].node.invoice_features()).unwrap();
	let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
 3_000_000, nodes[0].logger, &scorer, &(), &random_seed_bytes).unwrap();
	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 3_000_000);
	let route = get_route(&nodes[1].node.get_our_node_id(), &route_params, &nodes[1].network_graph.read_only(), None,
 nodes[0].logger, &scorer, &(), &random_seed_bytes).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 Down
Loading