HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 5 commits into from
Dec 1, 2022
Merged

HTLC JIT channel interception followup + minor cleanups #1893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6791d2c
Clean up HTLC intercept errors
valentinewallace Dec 1, 2022
7858010
Test for unknown HTLC intercept id error
valentinewallace Dec 1, 2022
d30122d
HTLC intercept test: swap hardcoded value for const
valentinewallace Dec 1, 2022
7203c83
Fix weird import format in persist
valentinewallace Oct 28, 2022
e0820ae
Rename APIError::RouteError to ::InvalidRoute
valentinewallace Dec 1, 2022
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: 1 addition & 1 deletion fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
match api_err {
APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
APIError::RouteError { .. } => panic!("Our routes should work"),
APIError::InvalidRoute { .. } => panic!("Our routes should work"),
APIError::ChannelUnavailable { err } => {
// Test the error against a list of errors we can hit, and reject
// all others. If you hit this panic, the list of acceptable errors
Expand Down
28 changes: 14 additions & 14 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
.map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
.map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
if onion_utils::route_size_insane(&onion_payloads) {
return Err(APIError::RouteError{err: "Route size too large considering onion data"});
return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
}
let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
match {
if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
}
if !chan.get().is_live() {
return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
/// fields for more info.
///
/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
/// PaymentSendFailure for more info.
///
/// In general, a path may raise:
/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
/// node public key) is specified.
/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
if route.paths.len() < 1 {
return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
}
if payment_secret.is_none() && route.paths.len() > 1 {
return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
let mut path_errs = Vec::with_capacity(route.paths.len());
'path_check: for path in route.paths.iter() {
if path.len() < 1 || path.len() > 20 {
path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
continue 'path_check;
}
for (idx, hop) in path.iter().enumerate() {
if idx != path.len() - 1 && hop.pubkey == our_node_id {
path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
continue 'path_check;
}
}
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
Some(chan) => {
if !chan.is_usable() {
return Err(APIError::APIMisuseError {
err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
return Err(APIError::ChannelUnavailable {
err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
})
}
chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
},
None => return Err(APIError::APIMisuseError {
err: format!("Channel with id {:?} not found", next_hop_channel_id)
None => return Err(APIError::ChannelUnavailable {
err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
})
};

let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
.ok_or_else(|| APIError::APIMisuseError {
err: format!("Payment with intercept id {:?} not found", intercept_id.0)
err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
})?;

let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
.ok_or_else(|| APIError::APIMisuseError {
err: format!("Payment with InterceptId {:?} not found", intercept_id)
err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
})?;

if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
.with_features(channelmanager::provided_invoice_features());
let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/onion_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
});
cur_value_msat += hop.fee_msat;
if cur_value_msat >= 21000000 * 100000000 * 1000 {
return Err(APIError::RouteError{err: "Channel fees overflowed?"});
return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
}
cur_cltv += hop.cltv_expiry_delta as u32;
if cur_cltv >= 500000000 {
return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
}
last_short_channel_id = hop.short_channel_id;
}
Expand Down
20 changes: 11 additions & 9 deletions lightning/src/ln/payment_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
final_value_msat: amt_msat,
final_cltv_expiry_delta: TEST_FINAL_CLTV,
};
let route = find_route(
&nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
&scorer, &random_seed_bytes
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
).unwrap();

let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

// Check for unknown channel id error.
let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

if test == InterceptTest::Fail {
// Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
// Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

// Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
};
connect_block(&nodes[0], &block);
connect_block(&nodes[1], &block);
let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
for _ in 0..block_count {
for _ in 0..TEST_FINAL_CLTV {
block.header.prev_blockhash = block.block_hash();
connect_block(&nodes[0], &block);
connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
// Check for unknown intercept id error.
let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
}
}
4 changes: 2 additions & 2 deletions lightning/src/util/errors.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
},
/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
/// too-many-hops, etc).
RouteError {
InvalidRoute {
/// A human-readable error message
err: &'static str
},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
match *self {
APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
APIError::IncompatibleShutdownScript { ref script } => {
Expand Down
11 changes: 9 additions & 2 deletions lightning/src/util/persist.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down
, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down

, '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
HTLC JIT channel interception followup + minor cleanups#1893

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 5 commits into

from

Dec 1, 2022
 Merged


HTLC JIT channel interception followup + minor cleanups
#1893
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6791d2c

Clean up HTLC intercept errors


valentinewallace Dec 1, 2022
7858010

Test for unknown HTLC intercept id error


valentinewallace Dec 1, 2022
d30122d

HTLC intercept test: swap hardcoded value for const


valentinewallace Dec 1, 2022
7203c83

Fix weird import format in persist


valentinewallace Oct 28, 2022
e0820ae

Rename APIError::RouteError to ::InvalidRoute


valentinewallace Dec 1, 2022

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: 1 addition & 1 deletion
fuzz/src/chanmon_consistency.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,7 +253,7 @@ fn check_api_err(api_err: APIError) {
	match api_err {
 APIError::APIMisuseError { .. } => panic!("We can't misuse the API"),
 APIError::FeeRateTooHigh { .. } => panic!("We can't send too much fee?"),
 APIError::RouteError { .. } => panic!("Our routes should work"),
 APIError::InvalidRoute { .. } => panic!("Our routes should work"),
 APIError::ChannelUnavailable { err } => {
 // Test the error against a list of errors we can hit, and reject
 // all others. If you hit this panic, the list of acceptable errors
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2407,10 +2407,10 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");

 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
 if onion_utils::route_size_insane(&onion_payloads) {
 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
 }
 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);

Expand All@@ -2427,7 +2427,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
 match {
 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
 }
 if !chan.get().is_live() {
 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
Expand DownExpand Up@@ -2502,7 +2502,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// fields for more info.
	///
	/// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
	/// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
	/// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
	/// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
	/// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
	/// [`PaymentId`].
Expand All@@ -2521,7 +2521,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
	/// PaymentSendFailure for more info.
	///
	/// In general, a path may raise:
	/// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
	/// node public key) is specified.
	/// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
	/// (including due to previous monitor update failure or new permanent monitor update
Expand DownExpand Up@@ -2586,7 +2586,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

	fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
 if route.paths.len() < 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 }
 if payment_secret.is_none() && route.paths.len() > 1 {
 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
Expand All@@ -2596,12 +2596,12 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let mut path_errs = Vec::with_capacity(route.paths.len());
 'path_check: for path in route.paths.iter() {
 if path.len() < 1 || path.len() > 20 {
 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 continue 'path_check;
 }
 for (idx, hop) in path.iter().enumerate() {
 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 continue 'path_check;
 }
 }
Expand DownExpand Up@@ -3080,20 +3080,20 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
 Some(chan) => {
 if !chan.is_usable() {
 return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not fully established", next_hop_channel_id)
 return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
 })
 }
 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
 },
 None => return Err(APIError::APIMisuseError {
 err: format!("Channel with id {:?} not found", next_hop_channel_id)
 None => return Err(APIError::ChannelUnavailable {
 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
 })
 };

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 let routing = match payment.forward_info.routing {
Expand DownExpand Up@@ -3128,7 +3128,7 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F

 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
 .ok_or_else(|| APIError::APIMisuseError {
 err: format!("Payment with InterceptId {:?} not found", intercept_id)
 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 })?;

 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
Expand Down

2 changes: 1 addition & 1 deletion
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6023,7 +6023,7 @@ fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
 .with_features(channelmanager::provided_invoice_features());
	let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
	route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
	unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::InvalidRoute { ref err },
 assert_eq!(err, &"Channel CLTV overflowed?"));
}

Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/onion_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,11 +182,11 @@ pub(super) fn build_onion_payloads(path: &Vec<RouteHop>, total_msat: u64, paymen
 });
 cur_value_msat += hop.fee_msat;
 if cur_value_msat >= 21000000 * 100000000 * 1000 {
 return Err(APIError::RouteError{err: "Channel fees overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel fees overflowed?"});
 }
 cur_cltv += hop.cltv_expiry_delta as u32;
 if cur_cltv >= 500000000 {
 return Err(APIError::RouteError{err: "Channel CLTV overflowed?"});
 return Err(APIError::InvalidRoute{err: "Channel CLTV overflowed?"});
 }
 last_short_channel_id = hop.short_channel_id;
	}
Expand Down

20 changes: 11 additions & 9 deletions
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ use crate::ln::channelmanager::{self, BREAKDOWN_TIMEOUT, ChannelManager, MPP_TIM
use crate::ln::msgs;
use crate::ln::msgs::ChannelMessageHandler;
use crate::routing::gossip::RoutingFees;
use crate::routing::router::{find_route, get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::routing::router::{get_route, PaymentParameters, RouteHint, RouteHintHop, RouteParameters};
use crate::util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
use crate::util::test_utils;
use crate::util::errors::APIError;
Expand DownExpand Up@@ -1429,9 +1429,10 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 final_value_msat: amt_msat,
 final_cltv_expiry_delta: TEST_FINAL_CLTV,
	};
	let route = find_route(
 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph, None, nodes[0].logger,
 &scorer, &random_seed_bytes
	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
	).unwrap();

	let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60).unwrap();
Expand DownExpand Up@@ -1466,7 +1467,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {

	// Check for unknown channel id error.
	let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &[42; 32], nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
	assert_eq!(unknown_chan_id_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not found", [42; 32]) });
	assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not found", log_bytes!([42; 32])) });

	if test == InterceptTest::Fail {
 // Ensure we can fail the intercepted payment back.
Expand All@@ -1490,7 +1491,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unusable_chan_err , APIError::APIMisuseError { err: format!("Channel with id {:?} not fully established", temp_chan_id) });
 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable { err: format!("Channel with id {} not fully established", log_bytes!(temp_chan_id)) });
 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);

 // Open the just-in-time channel so the payment can then be forwarded.
Expand DownExpand Up@@ -1540,8 +1541,7 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 };
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
 let block_count = 183; // find_route adds a random CLTV offset, so hardcode rather than summing consts
 for _ in 0..block_count {
 for _ in 0..TEST_FINAL_CLTV {
 block.header.prev_blockhash = block.block_hash();
 connect_block(&nodes[0], &block);
 connect_block(&nodes[1], &block);
Expand All@@ -1561,6 +1561,8 @@ fn do_test_intercepted_payment(test: InterceptTest) {
 // Check for unknown intercept id error.
 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {:?} not found", intercept_id.0) });
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
	}
}

4 changes: 2 additions & 2 deletions
lightning/src/util/errors.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ pub enum APIError {
	},
	/// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
	/// too-many-hops, etc).
RouteError {
InvalidRoute {
 /// A human-readable error message
 err: &'static str
	},
Expand DownExpand Up@@ -74,7 +74,7 @@ impl fmt::Debug for APIError {
 match *self {
 APIError::APIMisuseError {ref err} => write!(f, "Misuse error: {}", err),
 APIError::FeeRateTooHigh {ref err, ref feerate} => write!(f, "{} feerate: {}", err, feerate),
 APIError::RouteError {ref err} => write!(f, "Route error: {}", err),
 APIError::InvalidRoute {ref err} => write!(f, "Invalid route provided: {}", err),
 APIError::ChannelUnavailable {ref err} => write!(f, "Channel unavailable: {}", err),
 APIError::MonitorUpdateInProgress => f.write_str("Client indicated a channel monitor update is in progress but not yet complete"),
 APIError::IncompatibleShutdownScript { ref script } => {
Expand Down

11 changes: 9 additions & 2 deletions
lightning/src/util/persist.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,10 +10,17 @@

use core::ops::Deref;
use bitcoin::hashes::hex::ToHex;
use crate::io::{self};
use crate::io;
use crate::routing::scoring::WriteableScore;

use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::gossip::NetworkGraph};
use crate::chain;
use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
use crate::chain::keysinterface::{Sign, KeysInterface};
use crate::chain::transaction::OutPoint;
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use crate::ln::channelmanager::ChannelManager;
use crate::routing::gossip::NetworkGraph;
use super::{logger::Logger, ser::Writeable};

/// Trait for a key-value store for persisting some writeable object at some key
Expand Down