Skip to content

Multi-Path Payments #441

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
merged 12 commits into from
Apr 15, 2020
Merged

Multi-Path Payments #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f26e373
Split only-receive/forward data out of PendingHTLCInfo into an enum
TheBlueMatt Jan 1, 2020
b548173
Support (de)serializing payment_data in onion TLVs and track them
TheBlueMatt Jan 2, 2020
1442acf
Refuse to deserialize OnionHopDatas with values > 21 million
TheBlueMatt Jan 2, 2020
6d1bd8b
Impl Base AMP in the receive pipeline and expose payment_secret
TheBlueMatt Jan 2, 2020
d39f258
Add/announce features for payment_secret and basic_mpp
TheBlueMatt Jan 15, 2020
5260e81
Expand the Route object to include multiple paths.
TheBlueMatt Jan 4, 2020
a93d6e9
Refactor payment-claim logic to ensure MPP-claim atomicity
TheBlueMatt Mar 30, 2020
b2c9941
Implement multipath sends using payment_secret.
TheBlueMatt Jan 7, 2020
3512d66
Refactor test utils and add a simple MPP send/claim test.
TheBlueMatt Jan 7, 2020
03a1b52
Test basic AMP payments in chanmon_consistency
TheBlueMatt Jan 10, 2020
d3b6083
panic!() when serializing OnionHopDatas with value > 21m BTC
TheBlueMatt Mar 21, 2020
59b1bf6
Pass Route to send_payment as a reference, not move
TheBlueMatt Apr 7, 2020
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
68 changes: 56 additions & 12 deletions fuzz/src/chanmon_consistency.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,C
use lightning::chain::keysinterface::{KeysInterface, InMemoryChannelKeys};
use lightning::ln::channelmonitor;
use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, ChannelManagerReadArgs};
use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret, ChannelManagerReadArgs};
use lightning::ln::router::{Route, RouteHop};
use lightning::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, UpdateAddHTLC, Init};
Expand Down Expand Up @@ -408,25 +408,25 @@ pub fn do_test(data: &[u8]) {
($source: expr, $dest: expr) => { {
let payment_hash = Sha256::hash(&[payment_id; 1]);
payment_id = payment_id.wrapping_add(1);
if let Err(_) = $source.send_payment(Route {
hops: vec![RouteHop {
if let Err(_) = $source.send_payment(&Route {
paths: vec![vec![RouteHop {
pubkey: $dest.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $dest.1,
channel_features: ChannelFeatures::empty(),
fee_msat: 5000000,
cltv_expiry_delta: 200,
}],
}, PaymentHash(payment_hash.into_inner())) {
}]],
}, PaymentHash(payment_hash.into_inner()), &None) {
// Probably ran out of funds
test_return!();
}
} };
($source: expr, $middle: expr, $dest: expr) => { {
let payment_hash = Sha256::hash(&[payment_id; 1]);
payment_id = payment_id.wrapping_add(1);
if let Err(_) = $source.send_payment(Route {
hops: vec![RouteHop {
if let Err(_) = $source.send_payment(&Route {
paths: vec![vec![RouteHop {
pubkey: $middle.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $middle.1,
Expand All @@ -440,8 +440,50 @@ pub fn do_test(data: &[u8]) {
channel_features: ChannelFeatures::empty(),
fee_msat: 5000000,
cltv_expiry_delta: 200,
}],
}, PaymentHash(payment_hash.into_inner())) {
}]],
}, PaymentHash(payment_hash.into_inner()), &None) {
// Probably ran out of funds
test_return!();
}
} }
}
macro_rules! send_payment_with_secret {
($source: expr, $middle: expr, $dest: expr) => { {
let payment_hash = Sha256::hash(&[payment_id; 1]);
payment_id = payment_id.wrapping_add(1);
let payment_secret = Sha256::hash(&[payment_id; 1]);
payment_id = payment_id.wrapping_add(1);
if let Err(_) = $source.send_payment(&Route {
paths: vec![vec![RouteHop {
pubkey: $middle.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $middle.1,
channel_features: ChannelFeatures::empty(),
fee_msat: 50000,
cltv_expiry_delta: 100,
},RouteHop {
pubkey: $dest.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $dest.1,
channel_features: ChannelFeatures::empty(),
fee_msat: 5000000,
cltv_expiry_delta: 200,
}],vec![RouteHop {
pubkey: $middle.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $middle.1,
channel_features: ChannelFeatures::empty(),
fee_msat: 50000,
cltv_expiry_delta: 100,
},RouteHop {
pubkey: $dest.0.get_our_node_id(),
node_features: NodeFeatures::empty(),
short_channel_id: $dest.1,
channel_features: ChannelFeatures::empty(),
fee_msat: 5000000,
cltv_expiry_delta: 200,
}]],
}, PaymentHash(payment_hash.into_inner()), &Some(PaymentSecret(payment_secret.into_inner()))) {
// Probably ran out of funds
test_return!();
}
Expand Down Expand Up @@ -599,12 +641,12 @@ pub fn do_test(data: &[u8]) {
});
for event in events.drain(..) {
match event {
events::Event::PaymentReceived { payment_hash, .. } => {
events::Event::PaymentReceived { payment_hash, payment_secret, .. } => {
if claim_set.insert(payment_hash.0) {
if $fail {
assert!(nodes[$node].fail_htlc_backwards(&payment_hash));
assert!(nodes[$node].fail_htlc_backwards(&payment_hash, &payment_secret));
} else {
assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), 5_000_000));
assert!(nodes[$node].claim_funds(PaymentPreimage(payment_hash.0), &payment_secret, 5_000_000));
}
}
},
Expand Down Expand Up @@ -734,6 +776,8 @@ pub fn do_test(data: &[u8]) {
nodes[2] = node_c.clone();
monitor_c = new_monitor_c;
},
0x22 => send_payment_with_secret!(nodes[0], (&nodes[1], chan_a), (&nodes[2], chan_b)),
0x23 => send_payment_with_secret!(nodes[2], (&nodes[1], chan_b), (&nodes[0], chan_a)),
// 0x24 defined above
_ => test_return!(),
}
Expand Down
42 changes: 32 additions & 10 deletions fuzz/src/full_stack.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,C
use lightning::chain::transaction::OutPoint;
use lightning::chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
use lightning::ln::channelmonitor;
use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage};
use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, PaymentSecret};
use lightning::ln::peer_handler::{MessageHandler,PeerManager,SocketDescriptor};
use lightning::ln::router::Router;
use lightning::util::events::{EventsProvider,Event};
Expand Down Expand Up @@ -343,7 +343,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
}, our_network_key, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 15, 0], Arc::clone(&logger)));

let mut should_forward = false;
let mut payments_received: Vec<(PaymentHash, u64)> = Vec::new();
let mut payments_received: Vec<(PaymentHash, Option<PaymentSecret>, u64)> = Vec::new();
let mut payments_sent = 0;
let mut pending_funding_generation: Vec<([u8; 32], u64, Script)> = Vec::new();
let mut pending_funding_signatures = HashMap::new();
Expand Down Expand Up @@ -401,7 +401,28 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
sha.input(&payment_hash.0[..]);
payment_hash.0 = Sha256::from_engine(sha).into_inner();
payments_sent += 1;
match channelmanager.send_payment(route, payment_hash) {
match channelmanager.send_payment(&route, payment_hash, &None) {
Ok(_) => {},
Err(_) => return,
}
},
15 => {
let value = slice_to_be24(get_slice!(3)) as u64;
let mut route = match router.get_route(&get_pubkey!(), None, &Vec::new(), value, 42) {
Ok(route) => route,
Err(_) => return,
};
route.paths.push(route.paths[0].clone());
let mut payment_hash = PaymentHash([0; 32]);
payment_hash.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
let mut sha = Sha256::engine();
sha.input(&payment_hash.0[..]);
payment_hash.0 = Sha256::from_engine(sha).into_inner();
payments_sent += 1;
let mut payment_secret = PaymentSecret([0; 32]);
payment_secret.0[0..8].copy_from_slice(&be64_to_array(payments_sent));
payments_sent += 1;
match channelmanager.send_payment(&route, payment_hash, &Some(payment_secret)) {
Ok(_) => {},
Err(_) => return,
}
Expand All @@ -428,23 +449,23 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
}
},
8 => {
for (payment, amt) in payments_received.drain(..) {
for (payment, payment_secret, amt) in payments_received.drain(..) {
// SHA256 is defined as XOR of all input bytes placed in the first byte, and 0s
// for the remaining bytes. Thus, if not all remaining bytes are 0s we cannot
// fulfill this HTLC, but if they are, we can just take the first byte and
// place that anywhere in our preimage.
if &payment.0[1..] != &[0; 31] {
channelmanager.fail_htlc_backwards(&payment);
channelmanager.fail_htlc_backwards(&payment, &payment_secret);
} else {
let mut payment_preimage = PaymentPreimage([0; 32]);
payment_preimage.0[0] = payment.0[0];
channelmanager.claim_funds(payment_preimage, amt);
channelmanager.claim_funds(payment_preimage, &payment_secret, amt);
}
}
},
9 => {
for (payment, _) in payments_received.drain(..) {
channelmanager.fail_htlc_backwards(&payment);
for (payment, payment_secret, _) in payments_received.drain(..) {
channelmanager.fail_htlc_backwards(&payment, &payment_secret);
}
},
10 => {
Expand Down Expand Up @@ -513,6 +534,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
channelmanager.force_close_channel(&channels[channel_id].channel_id);
},
// 15 is above
_ => return,
}
loss_detector.handler.process_events();
Expand All @@ -524,9 +546,9 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
Event::FundingBroadcastSafe { funding_txo, .. } => {
pending_funding_relay.push(pending_funding_signatures.remove(&funding_txo).unwrap());
},
Event::PaymentReceived { payment_hash, amt } => {
Event::PaymentReceived { payment_hash, payment_secret, amt } => {
//TODO: enhance by fetching random amounts from fuzz input?
payments_received.push((payment_hash, amt));
payments_received.push((payment_hash, payment_secret, amt));
},
Event::PaymentSent {..} => {},
Event::PaymentFailed {..} => {},
Expand Down
Loading