Skip to content

Commit 2cdc2e9

Browse files
alecchendevalecchendev
committed
Support receiving, validating, and claiming MPP keysend
1 parent 15edea2 commit 2cdc2e9

File tree

2 files changed

+114
-49
lines changed

2 files changed

+114
-49
lines changed

‎lightning/src/ln/channelmanager.rs

Lines changed: 55 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3489,9 +3489,13 @@ where
34893489
}
34903490

34913491
macro_rules! check_total_value {
3492-
($payment_data: expr, $payment_preimage: expr) => {{
3492+
($payment_data: expr, $payment_preimage: expr, $is_keysend: expr) => {{
34933493
let mut payment_claimable_generated = false;
3494-
let purpose = || {
3494+
let purpose = if $is_keysend {
3495+
events::PaymentPurpose::SpontaneousPayment(
3496+
$payment_preimage.expect("Should never call check_total_value with $is_keysend as true but no preimage")
3497+
)
3498+
} else {
34953499
events::PaymentPurpose::InvoicePayment {
34963500
payment_preimage: $payment_preimage,
34973501
payment_secret: $payment_data.payment_secret,
@@ -3507,7 +3511,7 @@ where
35073511
.or_insert_with(|| {
35083512
committed_to_claimable = true;
35093513
ClaimablePayment {
3510-
purpose: purpose(), htlcs: Vec::new(), onion_fields: None,
3514+
purpose: purpose.clone(), htlcs: Vec::new(), onion_fields: None,
35113515
}
35123516
});
35133517
if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
@@ -3518,7 +3522,7 @@ where
35183522
claimable_payment.onion_fields = Some(onion_fields);
35193523
}
35203524
let ref mut htlcs = &mut claimable_payment.htlcs;
3521-
if htlcs.len() == 1 {
3525+
if htlcs.len() == 1 && !$is_keysend {
35223526
if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
35233527
log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash", log_bytes!(payment_hash.0));
35243528
fail_htlc!(claimable_htlc, payment_hash);
@@ -3529,17 +3533,12 @@ where
35293533
for htlc in htlcs.iter() {
35303534
total_value += htlc.sender_intended_value;
35313535
earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
3532-
match &htlc.onion_payload {
3533-
OnionPayload::Invoice { .. } => {
3534-
if htlc.total_msat != $payment_data.total_msat {
3535-
log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3536-
log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3537-
total_value = msgs::MAX_VALUE_MSAT;
3538-
}
3539-
if total_value >= msgs::MAX_VALUE_MSAT { break; }
3540-
},
3541-
_ => unreachable!(),
3536+
if htlc.total_msat != $payment_data.total_msat {
3537+
log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3538+
log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3539+
total_value = msgs::MAX_VALUE_MSAT;
35423540
}
3541+
if total_value >= msgs::MAX_VALUE_MSAT { break; }
35433542
}
35443543
// The condition determining whether an MPP is complete must
35453544
// match exactly the condition used in `timer_tick_occurred`
@@ -3560,7 +3559,7 @@ where
35603559
new_events.push(events::Event::PaymentClaimable {
35613560
receiver_node_id: Some(receiver_node_id),
35623561
payment_hash,
3563-
purpose: purpose(),
3562+
purpose,
35643563
amount_msat,
35653564
via_channel_id: Some(prev_channel_id),
35663565
via_user_channel_id: Some(prev_user_channel_id),
@@ -3608,40 +3607,44 @@ where
36083607
fail_htlc!(claimable_htlc, payment_hash);
36093608
}
36103609
}
3611-
check_total_value!(payment_data, payment_preimage);
3610+
check_total_value!(payment_data, payment_preimage, false);
36123611
},
36133612
OnionPayload::Spontaneous(preimage) => {
3614-
let mut claimable_payments = self.claimable_payments.lock().unwrap();
3615-
if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3616-
fail_htlc!(claimable_htlc, payment_hash);
3617-
}
3618-
match claimable_payments.claimable_payments.entry(payment_hash) {
3619-
hash_map::Entry::Vacant(e) => {
3620-
let amount_msat = claimable_htlc.value;
3621-
claimable_htlc.total_value_received = Some(amount_msat);
3622-
let claim_deadline = Some(claimable_htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER);
3623-
let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3624-
e.insert(ClaimablePayment {
3625-
purpose: purpose.clone(),
3626-
onion_fields: Some(onion_fields.clone()),
3627-
htlcs: vec![claimable_htlc],
3628-
});
3629-
let prev_channel_id = prev_funding_outpoint.to_channel_id();
3630-
new_events.push(events::Event::PaymentClaimable {
3631-
receiver_node_id: Some(receiver_node_id),
3632-
payment_hash,
3633-
amount_msat,
3634-
purpose,
3635-
via_channel_id: Some(prev_channel_id),
3636-
via_user_channel_id: Some(prev_user_channel_id),
3637-
claim_deadline,
3638-
onion_fields: Some(onion_fields),
3639-
});
3640-
},
3641-
hash_map::Entry::Occupied(_) => {
3642-
log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3613+
if let Some(payment_data) = payment_data {
3614+
check_total_value!(payment_data, Some(preimage), true);
3615+
} else {
3616+
let mut claimable_payments = self.claimable_payments.lock().unwrap();
3617+
if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
36433618
fail_htlc!(claimable_htlc, payment_hash);
36443619
}
3620+
match claimable_payments.claimable_payments.entry(payment_hash) {
3621+
hash_map::Entry::Vacant(e) => {
3622+
let amount_msat = claimable_htlc.value;
3623+
claimable_htlc.total_value_received = Some(amount_msat);
3624+
let claim_deadline = Some(claimable_htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER);
3625+
let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3626+
e.insert(ClaimablePayment {
3627+
purpose: purpose.clone(),
3628+
onion_fields: Some(onion_fields.clone()),
3629+
htlcs: vec![claimable_htlc],
3630+
});
3631+
let prev_channel_id = prev_funding_outpoint.to_channel_id();
3632+
new_events.push(events::Event::PaymentClaimable {
3633+
receiver_node_id: Some(receiver_node_id),
3634+
payment_hash,
3635+
amount_msat,
3636+
purpose,
3637+
via_channel_id: Some(prev_channel_id),
3638+
via_user_channel_id: Some(prev_user_channel_id),
3639+
claim_deadline,
3640+
onion_fields: Some(onion_fields),
3641+
});
3642+
},
3643+
hash_map::Entry::Occupied(_) => {
3644+
log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3645+
fail_htlc!(claimable_htlc, payment_hash);
3646+
}
3647+
}
36453648
}
36463649
}
36473650
}
@@ -3660,7 +3663,7 @@ where
36603663
log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
36613664
fail_htlc!(claimable_htlc, payment_hash);
36623665
} else {
3663-
let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3666+
let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage, false);
36643667
if payment_claimable_generated {
36653668
inbound_payment.remove_entry();
36663669
}
@@ -4135,12 +4138,16 @@ where
41354138
/// event matches your expectation. If you fail to do so and call this method, you may provide
41364139
/// the sender "proof-of-payment" when they did not fulfill the full expected payment.
41374140
///
4141+
/// To accept multi-part keysend payments you must set [`UserConfig::accept_mpp_keysend`] to
4142+
/// true.
4143+
///
41384144
/// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
41394145
/// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
41404146
/// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
41414147
/// [`process_pending_events`]: EventsProvider::process_pending_events
41424148
/// [`create_inbound_payment`]: Self::create_inbound_payment
41434149
/// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4150+
/// [`UserConfig::accept_mpp_keysend`]: crate::util::config::UserConfig::accept_mpp_keysend
41444151
pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
41454152
let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
41464153

@@ -4201,9 +4208,9 @@ where
42014208
expected_amt_msat = htlc.total_value_received;
42024209

42034210
if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4204-
// We don't currently support MPP for spontaneous payments, so just check
4211+
// If the user chooses not to support MPP for spontaneous payments, just check
42054212
// that there's one payment here and move on.
4206-
if sources.len() != 1 {
4213+
if !self.default_configuration.accept_mpp_keysend && sources.len() != 1 {
42074214
log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
42084215
debug_assert!(false);
42094216
valid_mpp = false;

‎lightning/src/ln/functional_tests.rs

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use crate::ln::{chan_utils, onion_utils};
2727
use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
2828
use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
2929
use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, RouteParameters, find_route, get_route};
30-
use crate::ln::features::{ChannelFeatures, NodeFeatures};
30+
use crate::ln::features::{ChannelFeatures, NodeFeatures, InvoiceFeatures};
3131
use crate::ln::msgs;
3232
use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
3333
use crate::util::enforcing_trait_impls::EnforcingSigner;
@@ -8215,6 +8215,64 @@ fn test_simple_mpp() {
82158215
claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
82168216
}
82178217

8218+
fn do_test_mpp_keysend(accept_mpp_keysend: bool) {
8219+
let mut mpp_keysend_config = test_default_channel_config();
8220+
mpp_keysend_config.accept_mpp_keysend = accept_mpp_keysend;
8221+
let chanmon_cfgs = create_chanmon_cfgs(4);
8222+
let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8223+
let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(mpp_keysend_config)]);
8224+
let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8225+
8226+
create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8227+
create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8228+
create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8229+
create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8230+
let network_graph = nodes[0].network_graph.clone();
8231+
8232+
let payer_pubkey = nodes[0].node.get_our_node_id();
8233+
let payee_pubkey = nodes[3].node.get_our_node_id();
8234+
let recv_value = 15_000_000;
8235+
let mut invoice_features = InvoiceFeatures::for_keysend();
8236+
invoice_features.set_basic_mpp_optional();
8237+
let route_params = RouteParameters {
8238+
payment_params: PaymentParameters::from_node_id(payee_pubkey, 40).with_features(invoice_features),
8239+
// Approxiamating the amount to make the router use MPP is not reliable in
8240+
// case those thresholds change, but helpful to test where the router may
8241+
// block mpp keysend
8242+
final_value_msat: recv_value,
8243+
};
8244+
let scorer = test_utils::TestScorer::new();
8245+
let random_seed_bytes = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
8246+
let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
8247+
8248+
let test_preimage = PaymentPreimage([42; 32]);
8249+
let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage),
8250+
RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0)).unwrap();
8251+
check_added_monitors!(nodes[0], 2);
8252+
8253+
let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
8254+
let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8255+
assert_eq!(events.len(), 2);
8256+
for (path_idx, expected_path) in expected_route.iter().enumerate() {
8257+
let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
8258+
let expect_payment = path_idx == expected_route.len() - 1;
8259+
pass_along_path(&nodes[0], *expected_path, recv_value, payment_hash.clone(), None, ev, expect_payment, Some(test_preimage));
8260+
}
8261+
8262+
claim_payment_along_route(&nodes[0], expected_route, false, test_preimage);
8263+
}
8264+
8265+
#[test]
8266+
fn test_mpp_keysend() {
8267+
do_test_mpp_keysend(true);
8268+
}
8269+
8270+
#[test]
8271+
#[should_panic]
8272+
fn test_mpp_keysend_fail() {
8273+
do_test_mpp_keysend(false);
8274+
}
8275+
82188276
#[test]
82198277
fn test_preimage_storage() {
82208278
// Simple test of payment preimage storage allowing no client-side storage to claim payments

0 commit comments

Comments
 (0)