Skip to content

Commit 5fbc8e0

Browse files
Allow receiving less than the onion claims to pay
Useful for penultimate hops in routes to take an extra fee, if for example they opened a JIT channel to the payee and want them to help bear the channel open cost.
1 parent 7e81894 commit 5fbc8e0

File tree

3 files changed

+161
-12
lines changed

3 files changed

+161
-12
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2414,9 +2414,10 @@ where
24142414
}
24152415
}
24162416

2417-
fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2418-
payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2419-
{
2417+
fn construct_recv_pending_htlc_info(
2418+
&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32], payment_hash: PaymentHash,
2419+
amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool
2420+
) -> Result<PendingHTLCInfo, ReceiveError> {
24202421
// final_incorrect_cltv_expiry
24212422
if hop_data.outgoing_cltv_value > cltv_expiry {
24222423
return Err(ReceiveError {
@@ -2442,7 +2443,7 @@ where
24422443
msg: "The final CLTV expiry is too soon to handle",
24432444
});
24442445
}
2445-
if hop_data.amt_to_forward > amt_msat {
2446+
if !allow_underpay && hop_data.amt_to_forward > amt_msat {
24462447
return Err(ReceiveError {
24472448
err_code: 19,
24482449
err_data: amt_msat.to_be_bytes().to_vec(),
@@ -2722,6 +2723,7 @@ where
27222723

27232724
fn construct_pending_htlc_status<'a>(
27242725
&self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
2726+
allow_underpay: bool,
27252727
) -> PendingHTLCStatus {
27262728
macro_rules! return_err {
27272729
($msg: expr, $err_code: expr, $data: expr) => {
@@ -2739,7 +2741,9 @@ where
27392741
match decoded_hop {
27402742
onion_utils::Hop::Receive(next_hop_data) => {
27412743
// OUR PAYMENT!
2742-
match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2744+
match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
2745+
msg.amount_msat, msg.cltv_expiry, None, allow_underpay)
2746+
{
27432747
Ok(info) => {
27442748
// Note that we could obviously respond immediately with an update_fulfill_htlc
27452749
// message, however that would leak that we are the recipient of this payment, so
@@ -3543,7 +3547,10 @@ where
35433547
};
35443548
match next_hop {
35453549
onion_utils::Hop::Receive(hop_data) => {
3546-
match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3550+
match self.construct_recv_pending_htlc_info(hop_data,
3551+
incoming_shared_secret, payment_hash, outgoing_amt_msat,
3552+
outgoing_cltv_value, Some(phantom_shared_secret), false)
3553+
{
35473554
Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
35483555
Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
35493556
}
@@ -5269,7 +5276,8 @@ where
52695276

52705277
let pending_forward_info = match decoded_hop_res {
52715278
Ok((next_hop, shared_secret)) =>
5272-
self.construct_pending_htlc_status(msg, shared_secret, next_hop),
5279+
self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5280+
chan.get().config().accept_underpaying_htlcs),
52735281
Err(e) => PendingHTLCStatus::Fail(e)
52745282
};
52755283
let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {

lightning/src/ln/functional_test_utils.rs

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2164,7 +2164,20 @@ pub fn send_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route
21642164
(our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
21652165
}
21662166

2167-
pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) -> u64 {
2167+
pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2168+
origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2169+
our_payment_preimage: PaymentPreimage
2170+
) -> u64 {
2171+
let extra_fees = vec![0; expected_paths.len()];
2172+
do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2173+
&extra_fees[..], skip_last, our_payment_preimage)
2174+
}
2175+
2176+
pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2177+
origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2178+
&[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2179+
) -> u64 {
2180+
assert_eq!(expected_paths.len(), expected_extra_fees.len());
21682181
for path in expected_paths.iter() {
21692182
assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
21702183
}
@@ -2214,7 +2227,7 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
22142227
}
22152228
}
22162229

2217-
for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2230+
for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
22182231
let mut next_msgs = Some(path_msgs);
22192232
let mut expected_next_node = next_hop;
22202233

@@ -2229,10 +2242,10 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
22292242
}
22302243
}
22312244
macro_rules! mid_update_fulfill_dance {
2232-
($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2245+
($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
22332246
{
22342247
$node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2235-
let fee = {
2248+
let mut fee = {
22362249
let per_peer_state = $node.node.per_peer_state.read().unwrap();
22372250
let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
22382251
.unwrap().lock().unwrap();
@@ -2243,6 +2256,7 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
22432256
channel.config().forwarding_fee_base_msat
22442257
}
22452258
};
2259+
if $idx == 1 { fee += expected_extra_fees[i]; }
22462260
expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
22472261
expected_total_fee_msat += fee as u64;
22482262
check_added_monitors!($node, 1);
@@ -2274,7 +2288,7 @@ pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>,
22742288
} else {
22752289
next_node = expected_route[expected_route.len() - 1 - idx - 1];
22762290
}
2277-
mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2291+
mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
22782292
} else {
22792293
assert!(!update_next_msgs);
22802294
assert!(node.node.get_and_clear_pending_msg_events().is_empty());

lightning/src/ln/payment_tests.rs

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1732,6 +1732,133 @@ fn do_test_intercepted_payment(test: InterceptTest) {
17321732
}
17331733
}
17341734

1735+
#[test]
1736+
fn accept_underpaying_htlcs_config() {
1737+
do_accept_underpaying_htlcs_config(1);
1738+
do_accept_underpaying_htlcs_config(2);
1739+
do_accept_underpaying_htlcs_config(3);
1740+
}
1741+
1742+
fn do_accept_underpaying_htlcs_config(num_mpp_parts: usize) {
1743+
let chanmon_cfgs = create_chanmon_cfgs(3);
1744+
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1745+
let mut intercept_forwards_config = test_default_channel_config();
1746+
intercept_forwards_config.accept_intercept_htlcs = true;
1747+
let mut underpay_config = test_default_channel_config();
1748+
underpay_config.channel_config.accept_underpaying_htlcs = true;
1749+
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), Some(underpay_config)]);
1750+
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1751+
1752+
let mut chan_ids = Vec::new();
1753+
for _ in 0..num_mpp_parts {
1754+
let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000, 0);
1755+
let channel_id = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 2_000_000, 0).0.channel_id;
1756+
chan_ids.push(channel_id);
1757+
}
1758+
1759+
// Send the initial payment.
1760+
let amt_msat = 900_000;
1761+
let skimmed_fee_msat = 20;
1762+
let mut route_hints = Vec::new();
1763+
for _ in 0..num_mpp_parts {
1764+
route_hints.push(RouteHint(vec![RouteHintHop {
1765+
src_node_id: nodes[1].node.get_our_node_id(),
1766+
short_channel_id: nodes[1].node.get_intercept_scid(),
1767+
fees: RoutingFees {
1768+
base_msat: 1000,
1769+
proportional_millionths: 0,
1770+
},
1771+
cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1772+
htlc_minimum_msat: None,
1773+
htlc_maximum_msat: Some(amt_msat / num_mpp_parts as u64 + 5),
1774+
}]));
1775+
}
1776+
let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1777+
.with_route_hints(route_hints).unwrap()
1778+
.with_bolt11_features(nodes[2].node.invoice_features()).unwrap();
1779+
let route_params = RouteParameters {
1780+
payment_params,
1781+
final_value_msat: amt_msat,
1782+
};
1783+
let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
1784+
nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
1785+
PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
1786+
check_added_monitors!(nodes[0], num_mpp_parts); // one monitor per path
1787+
let mut events: Vec<SendEvent> = nodes[0].node.get_and_clear_pending_msg_events().into_iter().map(|e| SendEvent::from_event(e)).collect();
1788+
assert_eq!(events.len(), num_mpp_parts);
1789+
1790+
// Forward the intercepted payments.
1791+
for (idx, ev) in events.into_iter().enumerate() {
1792+
nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &ev.msgs[0]);
1793+
do_commitment_signed_dance(&nodes[1], &nodes[0], &ev.commitment_msg, false, true);
1794+
1795+
let events = nodes[1].node.get_and_clear_pending_events();
1796+
assert_eq!(events.len(), 1);
1797+
let (intercept_id, expected_outbound_amt_msat) = match events[0] {
1798+
crate::events::Event::HTLCIntercepted {
1799+
intercept_id, expected_outbound_amount_msat, payment_hash: pmt_hash, ..
1800+
} => {
1801+
assert_eq!(pmt_hash, payment_hash);
1802+
(intercept_id, expected_outbound_amount_msat)
1803+
},
1804+
_ => panic!()
1805+
};
1806+
nodes[1].node.forward_intercepted_htlc(intercept_id, &chan_ids[idx],
1807+
nodes[2].node.get_our_node_id(), expected_outbound_amt_msat - skimmed_fee_msat).unwrap();
1808+
expect_pending_htlcs_forwardable!(nodes[1]);
1809+
let payment_event = {
1810+
{
1811+
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
1812+
assert_eq!(added_monitors.len(), 1);
1813+
added_monitors.clear();
1814+
}
1815+
let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1816+
assert_eq!(events.len(), 1);
1817+
SendEvent::from_event(events.remove(0))
1818+
};
1819+
nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
1820+
do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, false, true);
1821+
if idx == num_mpp_parts - 1 {
1822+
expect_pending_htlcs_forwardable!(nodes[2]);
1823+
}
1824+
}
1825+
1826+
// Claim the payment and check that the skimmed fee is as expected.
1827+
let payment_preimage = nodes[2].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1828+
let events = nodes[2].node.get_and_clear_pending_events();
1829+
assert_eq!(events.len(), 1);
1830+
match events[0] {
1831+
crate::events::Event::PaymentClaimable {
1832+
ref payment_hash, ref purpose, amount_msat, counterparty_skimmed_fee_msat, receiver_node_id, ..
1833+
} => {
1834+
assert_eq!(payment_hash, payment_hash);
1835+
assert_eq!(amt_msat - skimmed_fee_msat * num_mpp_parts as u64, amount_msat);
1836+
assert_eq!(skimmed_fee_msat * num_mpp_parts as u64, counterparty_skimmed_fee_msat);
1837+
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
1838+
match purpose {
1839+
crate::events::PaymentPurpose::InvoicePayment { payment_preimage: ev_payment_preimage,
1840+
payment_secret: ev_payment_secret, .. } =>
1841+
{
1842+
assert_eq!(payment_preimage, ev_payment_preimage.unwrap());
1843+
assert_eq!(payment_secret, *ev_payment_secret);
1844+
},
1845+
_ => panic!(),
1846+
}
1847+
},
1848+
_ => panic!("Unexpected event"),
1849+
}
1850+
let mut expected_paths_vecs = Vec::new();
1851+
let mut expected_paths = Vec::new();
1852+
for _ in 0..num_mpp_parts { expected_paths_vecs.push(vec!(&nodes[1], &nodes[2])); }
1853+
for i in 0..num_mpp_parts { expected_paths.push(&expected_paths_vecs[i][..]); }
1854+
let total_fee_msat = do_claim_payment_along_route_with_extra_penultimate_hop_fees(
1855+
&nodes[0], &expected_paths[..], &vec![skimmed_fee_msat as u32; num_mpp_parts][..], false,
1856+
payment_preimage);
1857+
// The sender doesn't know that the penultimate hop took an extra fee.
1858+
expect_payment_sent(&nodes[0], payment_preimage,
1859+
Some(Some(total_fee_msat - skimmed_fee_msat * num_mpp_parts as u64)), true);
1860+
}
1861+
17351862
#[derive(PartialEq)]
17361863
enum AutoRetry {
17371864
Success,

0 commit comments

Comments
 (0)