Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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 3 commits into from
Feb 28, 2023
Merged

Remove the final_cltv_expiry_delta in RouteParameters entirely #2015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9364154
Require a non-0 number of non-empty paths when deserializing routes
TheBlueMatt Feb 6, 2023
6aa5ebb
Support `ReadableArgs` types across in the TLV struct serialization
TheBlueMatt Feb 6, 2023
f03b7cd
Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely
TheBlueMatt Feb 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
2 changes: 0 additions & 2 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
let params = RouteParameters {
payment_params,
final_value_msat,
final_cltv_expiry_delta: 42,
};
let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
let params = RouteParameters {
payment_params,
final_value_msat,
final_cltv_expiry_delta: 42,
};
let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down
1 change: 0 additions & 1 deletion fuzz/src/router.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
.with_route_hints(last_hops.clone()),
final_value_msat,
final_cltv_expiry_delta,
};
let _ = find_route(&our_pubkey, &route_params, &net_graph,
first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down
1 change: 0 additions & 1 deletion lightning-invoice/src/payment.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
let route_params = RouteParameters {
payment_params,
final_value_msat: amount_msats,
final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
};

payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down
2 changes: 0 additions & 2 deletions lightning-invoice/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
let route_params = RouteParameters {
payment_params,
final_value_msat: invoice.amount_milli_satoshis().unwrap(),
final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
};
let first_hops = nodes[0].node.list_usable_channels();
let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
let params = RouteParameters {
payment_params,
final_value_msat: invoice.amount_milli_satoshis().unwrap(),
final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
};
let first_hops = nodes[0].node.list_usable_channels();
let network_graph = &node_cfgs[0].network_graph;
Expand Down
20 changes: 13 additions & 7 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
0 => {
let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
let mut first_hop_htlc_msat: u64 = 0;
let mut path = Some(Vec::new());
let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
let mut payment_id = None;
let mut payment_secret = None;
let mut payment_params = None;
let mut payment_params: Option<PaymentParameters> = None;
read_tlv_fields!(reader, {
(0, session_priv, required),
(1, payment_id, option),
(2, first_hop_htlc_msat, required),
(3, payment_secret, option),
(4, path, vec_type),
(5, payment_params, option),
(5, payment_params, (option: ReadableArgs, 0)),
});
if payment_id.is_none() {
// For backwards compat, if there was no payment_id written, use the session_priv bytes
// instead.
payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
}
if path.is_none() || path.as_ref().unwrap().is_empty() {
return Err(DecodeError::InvalidValue);
}
let path = path.unwrap();
if let Some(params) = payment_params.as_mut() {
if params.final_cltv_expiry_delta == 0 {
params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
}
}
Ok(HTLCSource::OutboundRoute {
session_priv: session_priv.0.unwrap(),
first_hop_htlc_msat,
path: path.unwrap(),
path,
payment_id: payment_id.unwrap(),
payment_secret,
payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
final_value_msat: 100_000,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};
let route = find_route(
&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
final_value_msat: 10_000,
final_cltv_expiry_delta: 40,
};
let network_graph = nodes[0].network_graph.clone();
let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
final_value_msat: 10_000,
final_cltv_expiry_delta: 40,
};
let network_graph = nodes[0].network_graph.clone();
let first_hops = nodes[0].node.list_usable_channels();
Expand Down
2 changes: 0 additions & 2 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
final_value_msat: 10000,
final_cltv_expiry_delta: 40,
};
let scorer = test_utils::TestScorer::new();
let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
let route_params = RouteParameters {
payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
final_value_msat: 10000,
final_cltv_expiry_delta: 40,
};
let network_graph = nodes[0].network_graph.clone();
let first_hops = nodes[0].node.list_usable_channels();
Expand Down
27 changes: 4 additions & 23 deletions lightning/src/ln/outbound_payment.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
if pending_amt_msat < total_msat {
retry_id_route_params = Some((*pmt_id, RouteParameters {
final_value_msat: *total_msat - *pending_amt_msat,
final_cltv_expiry_delta:
if let Some(delta) = params.final_cltv_expiry_delta { delta }
else {
debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
},
payment_params: params.clone(),
}));
break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
Some(RouteParameters {
payment_params: payment_params.clone(),
final_value_msat: pending_amt_unsent,
final_cltv_expiry_delta:
if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
else { max_unsent_cltv_delta },
})
} else { None }
} else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
// `payment_params`) back to the user.
let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
if let Some(params) = payment.get_mut().payment_parameters() {
if params.final_cltv_expiry_delta.is_none() {
// This should be rare, but a user could provide None for the payment data, and
// we need it when we go to retry the payment, so fill it in.
params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
}
retry = Some(RouteParameters {
payment_params: params.clone(),
final_value_msat: path_last_hop.fee_msat,
final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
});
} else if let Some(params) = payment_params {
retry = Some(RouteParameters {
payment_params: params.clone(),
final_value_msat: path_last_hop.fee_msat,
final_cltv_expiry_delta:
if let Some(delta) = params.final_cltv_expiry_delta { delta }
else { path_last_hop.cltv_expiry_delta },
});
}

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(0, session_privs, required),
(1, pending_fee_msat, option),
(2, payment_hash, required),
(3, payment_params, option),
// Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
// never see it - `payment_params` was added here after the field was added/required.
(3, payment_params, (option: ReadableArgs, 0)),
(4, payment_secret, option),
(5, keysend_preimage, option),
(6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
let expired_route_params = RouteParameters {
payment_params,
final_value_msat: 0,
final_cltv_expiry_delta: 0,
};
let pending_events = Mutex::new(Vec::new());
if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
let route_params = RouteParameters {
payment_params,
final_value_msat: 0,
final_cltv_expiry_delta: 0,
};
router.expect_find_route(route_params.clone(),
Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
let route_params = RouteParameters {
payment_params: payment_params.clone(),
final_value_msat: 0,
final_cltv_expiry_delta: 0,
};
let failed_scid = 42;
let route = Route {
Expand Down
26 changes: 7 additions & 19 deletions lightning/src/ln/payment_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
let mut route_params = RouteParameters {
payment_params: route.payment_params.clone().unwrap(),
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
let route_params = RouteParameters {
payment_params: route.payment_params.clone().unwrap(),
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};
nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};
let route = get_route(
&nodes[0].node.get_our_node_id(), &route_params.payment_params,
&nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
&random_seed_bytes,
).unwrap();

let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};
let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
let mut payment_params = route_params.payment_params.clone();
payment_params.previously_failed_channels.push(chan_2_id);
nodes[0].router.expect_find_route(RouteParameters {
payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
payment_params, final_value_msat: amt_msat / 2,
}, Ok(retry_1_route));
let mut payment_params = route_params.payment_params.clone();
payment_params.previously_failed_channels.push(chan_3_id);
nodes[0].router.expect_find_route(RouteParameters {
payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
payment_params, final_value_msat: amt_msat / 4,
}, Ok(retry_2_route));

// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
let route_params = RouteParameters {
payment_params: payment_params.clone(),
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
payment_params: pay_params,
// Note that the second request here requests the amount we originally failed to send,
// not the amount remaining on the full payment, which should be changed.
final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
final_value_msat: 100_000_001,
}, Ok(route.clone()));

{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
nodes[0].router.expect_find_route(RouteParameters {
payment_params: pay_params, final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV
}, Ok(route.clone()));

nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
route.paths[0][1].fee_msat = amt_msat;
nodes[0].router.expect_find_route(RouteParameters {
payment_params: second_payment_params,
final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
final_value_msat: amt_msat,
}, Ok(route.clone()));

nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
let route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
route.paths.remove(0);
nodes[0].router.expect_find_route(RouteParameters {
payment_params: second_payment_params,
final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
final_value_msat: amt_msat / 2,
}, Ok(route.clone()));

nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
let mut route_params = RouteParameters {
payment_params,
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};

let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
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
Remove the final_cltv_expiry_delta in RouteParameters entirely#2015

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

from

Feb 28, 2023
 Merged


Remove the final_cltv_expiry_delta in RouteParameters entirely
#2015
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9364154

Require a non-0 number of non-empty paths when deserializing routes


TheBlueMatt Feb 6, 2023
6aa5ebb

Support `ReadableArgs` types across in the TLV struct serialization


TheBlueMatt Feb 6, 2023
f03b7cd

Remove the `final_cltv_expiry_delta` in `RouteParameters` entirely


TheBlueMatt Feb 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


2 changes: 0 additions & 2 deletions
fuzz/src/full_stack.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -513,7 +513,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand All@@ -537,7 +536,6 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 let params = RouteParameters {
 payment_params,
 final_value_msat,
 final_cltv_expiry_delta: 42,
 };
 let random_seed_bytes: [u8; 32] = keys_manager.get_secure_random_bytes();
 let mut route = match find_route(&our_id, &params, &network_graph, None, Arc::clone(&logger), &scorer, &random_seed_bytes) {
Expand Down

1 change: 0 additions & 1 deletion
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -301,7 +301,6 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 payment_params: PaymentParameters::from_node_id(*target, final_cltv_expiry_delta)
 .with_route_hints(last_hops.clone()),
 final_value_msat,
 final_cltv_expiry_delta,
 };
 let _ = find_route(&our_pubkey, &route_params, &net_graph,
 first_hops.map(|c| c.iter().collect::<Vec<_>>()).as_ref().map(|a| a.as_slice()),
Expand Down

1 change: 0 additions & 1 deletion
lightning-invoice/src/payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,6 @@ fn pay_invoice_using_amount<P: Deref>(
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amount_msats,
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
	};

	payer.send_payment(payment_hash, &payment_secret, payment_id, route_params, retry_strategy)
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,7 +686,6 @@ mod test {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand DownExpand Up@@ -1050,7 +1049,6 @@ mod test {
 let params = RouteParameters {
 payment_params,
 final_value_msat: invoice.amount_milli_satoshis().unwrap(),
 final_cltv_expiry_delta: invoice.min_final_cltv_expiry_delta() as u32,
 };
 let first_hops = nodes[0].node.list_usable_channels();
 let network_graph = &node_cfgs[0].network_graph;
Expand Down

20 changes: 13 additions & 7 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6745,27 +6745,36 @@ impl Readable for HTLCSource {
 0 => {
 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
 let mut first_hop_htlc_msat: u64 = 0;
 let mut path = Some(Vec::new());
 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
 let mut payment_id = None;
 let mut payment_secret = None;
 let mut payment_params = None;
 let mut payment_params: Option<PaymentParameters> = None;
 read_tlv_fields!(reader, {
 (0, session_priv, required),
 (1, payment_id, option),
 (2, first_hop_htlc_msat, required),
 (3, payment_secret, option),
 (4, path, vec_type),
 (5, payment_params, option),
 (5, payment_params, (option: ReadableArgs, 0)),
 });
 if payment_id.is_none() {
 // For backwards compat, if there was no payment_id written, use the session_priv bytes
 // instead.
 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 }
 if path.is_none() || path.as_ref().unwrap().is_empty() {
 return Err(DecodeError::InvalidValue);
 }
 let path = path.unwrap();
 if let Some(params) = payment_params.as_mut() {
 if params.final_cltv_expiry_delta == 0 {
 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
 }
 }
 Ok(HTLCSource::OutboundRoute {
 session_priv: session_priv.0.unwrap(),
 first_hop_htlc_msat,
 path: path.unwrap(),
 path,
 payment_id: payment_id.unwrap(),
 payment_secret,
 payment_params,
Expand DownExpand Up@@ -7963,7 +7972,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
 final_value_msat: 100_000,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
 };
 let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
Expand DownExpand Up@@ -8054,7 +8062,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -8097,7 +8104,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10_000,
 final_cltv_expiry_delta: 40,
 };
 let network_graph = nodes[0].network_graph.clone();
 let first_hops = nodes[0].node.list_usable_channels();
Expand Down

2 changes: 0 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9241,7 +9241,6 @@ fn test_keysend_payments_to_public_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let scorer = test_utils::TestScorer::new();
	let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
Expand DownExpand Up@@ -9272,7 +9271,6 @@ fn test_keysend_payments_to_private_node() {
	let route_params = RouteParameters {
 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
 final_value_msat: 10000,
 final_cltv_expiry_delta: 40,
	};
	let network_graph = nodes[0].network_graph.clone();
	let first_hops = nodes[0].node.list_usable_channels();
Expand Down

27 changes: 4 additions & 23 deletions
lightning/src/ln/outbound_payment.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,6 @@ use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
use crate::ln::onion_utils::HTLCFailReason;
use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
use crate::util::errors::APIError;
Expand All@@ -25,6 +24,7 @@ use crate::util::logger::Logger;
use crate::util::time::Time;
#[cfg(all(not(feature = "no-std"), test))]
use crate::util::time::tests::SinceEpoch;
use crate::util::ser::ReadableArgs;

use core::cmp;
use core::fmt::{self, Display, Formatter};
Expand DownExpand Up@@ -528,12 +528,6 @@ impl OutboundPayments {
 if pending_amt_msat < total_msat {
 retry_id_route_params = Some((*pmt_id, RouteParameters {
 final_value_msat: *total_msat - *pending_amt_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else {
 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 },
 payment_params: params.clone(),
 }));
 break
Expand DownExpand Up@@ -976,9 +970,6 @@ impl OutboundPayments {
 Some(RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: pending_amt_unsent,
 final_cltv_expiry_delta:
 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 else { max_unsent_cltv_delta },
 })
 } else { None }
 } else { None },
Expand DownExpand Up@@ -1179,23 +1170,14 @@ impl OutboundPayments {
 // `payment_params`) back to the user.
 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 if let Some(params) = payment.get_mut().payment_parameters() {
 if params.final_cltv_expiry_delta.is_none() {
 // This should be rare, but a user could provide None for the payment data, and
 // we need it when we go to retry the payment, so fill it in.
 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
 }
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
 });
 } else if let Some(params) = payment_params {
 retry = Some(RouteParameters {
 payment_params: params.clone(),
 final_value_msat: path_last_hop.fee_msat,
 final_cltv_expiry_delta:
 if let Some(delta) = params.final_cltv_expiry_delta { delta }
 else { path_last_hop.cltv_expiry_delta },
 });
 }

Expand DownExpand Up@@ -1330,7 +1312,9 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 (0, session_privs, required),
 (1, pending_fee_msat, option),
 (2, payment_hash, required),
 (3, payment_params, option),
 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
 // never see it - `payment_params` was added here after the field was added/required.
 (3, payment_params, (option: ReadableArgs, 0)),
 (4, payment_secret, option),
 (5, keysend_preimage, option),
 (6, total_msat, required),
Expand DownExpand Up@@ -1386,7 +1370,6 @@ mod tests {
 let expired_route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let pending_events = Mutex::new(Vec::new());
 if on_retry {
Expand DownExpand Up@@ -1428,7 +1411,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params,
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 router.expect_find_route(route_params.clone(),
 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
Expand DownExpand Up@@ -1471,7 +1453,6 @@ mod tests {
 let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: 0,
 final_cltv_expiry_delta: 0,
 };
 let failed_scid = 42;
 let route = Route {
Expand Down

26 changes: 7 additions & 19 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,6 @@ fn mpp_retry() {
	let mut route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
Expand DownExpand Up@@ -297,7 +296,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
	let route_params = RouteParameters {
 payment_params: route.payment_params.clone().unwrap(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
	check_added_monitors!(nodes[0], 1);
Expand DownExpand Up@@ -1387,12 +1385,12 @@ fn do_test_intercepted_payment(test: InterceptTest) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &route_params.payment_params,
 &nodes[0].network_graph.read_only(), None, route_params.final_value_msat,
 route_params.final_cltv_expiry_delta, nodes[0].logger, &scorer, &random_seed_bytes
 route_params.payment_params.final_cltv_expiry_delta, nodes[0].logger, &scorer,
 &random_seed_bytes,
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
Expand DownExpand Up@@ -1577,7 +1575,6 @@ fn do_automatic_retries(test: AutoRetry) {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);

Expand DownExpand Up@@ -1787,7 +1784,6 @@ fn auto_retry_partial_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	// Ensure the first monitor update (for the initial send path1 over chan_1) succeeds, but the
Expand DownExpand Up@@ -1860,12 +1856,12 @@ fn auto_retry_partial_failure() {
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_2_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 2,
 }, Ok(retry_1_route));
	let mut payment_params = route_params.payment_params.clone();
	payment_params.previously_failed_channels.push(chan_3_id);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params, final_value_msat: amt_msat / 4, final_cltv_expiry_delta: TEST_FINAL_CLTV
 payment_params, final_value_msat: amt_msat / 4,
 }, Ok(retry_2_route));

	// Send a payment that will partially fail on send, then partially fail on retry, then succeed.
Expand DownExpand Up@@ -1999,7 +1995,6 @@ fn auto_retry_zero_attempts_send_error() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
Expand DownExpand Up@@ -2039,7 +2034,6 @@ fn fails_paying_after_rejected_by_payee() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2086,7 +2080,6 @@ fn retry_multi_path_single_failed_payment() {
	let route_params = RouteParameters {
 payment_params: payment_params.clone(),
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand DownExpand Up@@ -2121,7 +2114,7 @@ fn retry_multi_path_single_failed_payment() {
 payment_params: pay_params,
 // Note that the second request here requests the amount we originally failed to send,
 // not the amount remaining on the full payment, which should be changed.
 final_value_msat: 100_000_001, final_cltv_expiry_delta: TEST_FINAL_CLTV
 final_value_msat: 100_000_001,
 }, Ok(route.clone()));

	{
Expand DownExpand Up@@ -2180,7 +2173,6 @@ fn immediate_retry_on_failure() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let chans = nodes[0].node.list_usable_channels();
Expand All@@ -2207,7 +2199,6 @@ fn immediate_retry_on_failure() {
	pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: pay_params, final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2270,7 +2261,6 @@ fn no_extra_retries_on_back_to_back_fail() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2316,7 +2306,7 @@ fn no_extra_retries_on_back_to_back_fail() {
	route.paths[0][1].fee_msat = amt_msat;
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2471,7 +2461,6 @@ fn test_simple_partial_retry() {
	let route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand DownExpand Up@@ -2516,7 +2505,7 @@ fn test_simple_partial_retry() {
	route.paths.remove(0);
	nodes[0].router.expect_find_route(RouteParameters {
 payment_params: second_payment_params,
 final_value_msat: amt_msat / 2, final_cltv_expiry_delta: TEST_FINAL_CLTV,
 final_value_msat: amt_msat / 2,
 }, Ok(route.clone()));

	nodes[0].node.send_payment_with_retry(payment_hash, &Some(payment_secret), PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
Expand DownExpand Up@@ -2637,7 +2626,6 @@ fn test_threaded_payment_retries() {
	let mut route_params = RouteParameters {
 payment_params,
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};

	let mut route = Route {
Expand Down
Loading