1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
3 //! claim outputs on-chain.
5 use chain::chaininterface;
6 use chain::transaction::OutPoint;
7 use chain::chaininterface::{ChainListener, ChainWatchInterface};
8 use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
9 use chain::keysinterface;
10 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
11 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash};
12 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
13 use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT};
15 use ln::router::{Route, RouteHop, Router};
17 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate};
19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::errors::APIError;
21 use util::logger::Logger;
22 use util::ser::{Writeable, Writer, ReadableArgs};
23 use util::config::UserConfig;
25 use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
26 use bitcoin::util::bip143;
27 use bitcoin::util::address::Address;
28 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
29 use bitcoin::blockdata::block::{Block, BlockHeader};
30 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
31 use bitcoin::blockdata::script::{Builder, Script};
32 use bitcoin::blockdata::opcodes;
33 use bitcoin::blockdata::constants::genesis_block;
34 use bitcoin::network::constants::Network;
36 use bitcoin_hashes::sha256::Hash as Sha256;
37 use bitcoin_hashes::Hash;
39 use secp256k1::{Secp256k1, Message};
40 use secp256k1::key::{PublicKey,SecretKey};
42 use rand::{thread_rng,Rng};
44 use std::cell::RefCell;
45 use std::collections::{BTreeSet, HashMap, HashSet};
46 use std::default::Default;
48 use std::sync::{Arc, Mutex};
49 use std::sync::atomic::Ordering;
50 use std::time::Instant;
53 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
54 assert!(chain.does_match_tx(tx));
55 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
56 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
58 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
59 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
64 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
65 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
66 chan_monitor: Arc<test_utils::TestChannelMonitor>,
67 keys_manager: Arc<test_utils::TestKeysInterface>,
68 node: Arc<ChannelManager>,
71 network_payment_count: Rc<RefCell<u8>>,
72 network_chan_count: Rc<RefCell<u32>>,
76 if !::std::thread::panicking() {
77 // Check that we processed all pending events
78 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
79 assert!(self.node.get_and_clear_pending_events().is_empty());
80 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
85 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
86 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
89 fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
90 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
91 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
92 (announcement, as_update, bs_update, channel_id, tx)
95 macro_rules! get_revoke_commit_msgs {
96 ($node: expr, $node_id: expr) => {
98 let events = $node.node.get_and_clear_pending_msg_events();
99 assert_eq!(events.len(), 2);
101 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
102 assert_eq!(*node_id, $node_id);
105 _ => panic!("Unexpected event"),
107 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
108 assert_eq!(*node_id, $node_id);
109 assert!(updates.update_add_htlcs.is_empty());
110 assert!(updates.update_fulfill_htlcs.is_empty());
111 assert!(updates.update_fail_htlcs.is_empty());
112 assert!(updates.update_fail_malformed_htlcs.is_empty());
113 assert!(updates.update_fee.is_none());
114 updates.commitment_signed.clone()
116 _ => panic!("Unexpected event"),
122 macro_rules! get_event_msg {
123 ($node: expr, $event_type: path, $node_id: expr) => {
125 let events = $node.node.get_and_clear_pending_msg_events();
126 assert_eq!(events.len(), 1);
128 $event_type { ref node_id, ref msg } => {
129 assert_eq!(*node_id, $node_id);
132 _ => panic!("Unexpected event"),
138 macro_rules! get_htlc_update_msgs {
139 ($node: expr, $node_id: expr) => {
141 let events = $node.node.get_and_clear_pending_msg_events();
142 assert_eq!(events.len(), 1);
144 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
145 assert_eq!(*node_id, $node_id);
148 _ => panic!("Unexpected event"),
154 macro_rules! get_feerate {
155 ($node: expr, $channel_id: expr) => {
157 let chan_lock = $node.node.channel_state.lock().unwrap();
158 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
165 fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
166 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
167 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id())).unwrap();
168 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id())).unwrap();
170 let chan_id = *node_a.network_chan_count.borrow();
174 let events_2 = node_a.node.get_and_clear_pending_events();
175 assert_eq!(events_2.len(), 1);
177 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
178 assert_eq!(*channel_value_satoshis, channel_value);
179 assert_eq!(user_channel_id, 42);
181 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
182 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
184 funding_output = OutPoint::new(tx.txid(), 0);
186 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
187 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
188 assert_eq!(added_monitors.len(), 1);
189 assert_eq!(added_monitors[0].0, funding_output);
190 added_monitors.clear();
192 _ => panic!("Unexpected event"),
195 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id())).unwrap();
197 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
198 assert_eq!(added_monitors.len(), 1);
199 assert_eq!(added_monitors[0].0, funding_output);
200 added_monitors.clear();
203 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id())).unwrap();
205 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
206 assert_eq!(added_monitors.len(), 1);
207 assert_eq!(added_monitors[0].0, funding_output);
208 added_monitors.clear();
211 let events_4 = node_a.node.get_and_clear_pending_events();
212 assert_eq!(events_4.len(), 1);
214 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
215 assert_eq!(user_channel_id, 42);
216 assert_eq!(*funding_txo, funding_output);
218 _ => panic!("Unexpected event"),
224 fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
225 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
226 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingLocked, node_a.node.get_our_node_id())).unwrap();
230 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
231 let events_6 = node_a.node.get_and_clear_pending_msg_events();
232 assert_eq!(events_6.len(), 2);
233 ((match events_6[0] {
234 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
235 channel_id = msg.channel_id.clone();
236 assert_eq!(*node_id, node_b.node.get_our_node_id());
239 _ => panic!("Unexpected event"),
240 }, match events_6[1] {
241 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
242 assert_eq!(*node_id, node_b.node.get_our_node_id());
245 _ => panic!("Unexpected event"),
249 fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
250 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
251 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
255 fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
256 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
257 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
258 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
260 let events_7 = node_b.node.get_and_clear_pending_msg_events();
261 assert_eq!(events_7.len(), 1);
262 let (announcement, bs_update) = match events_7[0] {
263 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
266 _ => panic!("Unexpected event"),
269 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
270 let events_8 = node_a.node.get_and_clear_pending_msg_events();
271 assert_eq!(events_8.len(), 1);
272 let as_update = match events_8[0] {
273 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
274 assert!(*announcement == *msg);
275 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
276 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
279 _ => panic!("Unexpected event"),
282 *node_a.network_chan_count.borrow_mut() += 1;
284 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
287 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
288 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
291 fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
292 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
294 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
295 node.router.handle_channel_update(&chan_announcement.1).unwrap();
296 node.router.handle_channel_update(&chan_announcement.2).unwrap();
298 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
301 macro_rules! check_spends {
302 ($tx: expr, $spends_tx: expr) => {
304 let mut funding_tx_map = HashMap::new();
305 let spends_tx = $spends_tx;
306 funding_tx_map.insert(spends_tx.txid(), spends_tx);
307 $tx.verify(&funding_tx_map).unwrap();
312 macro_rules! get_closing_signed_broadcast {
313 ($node: expr, $dest_pubkey: expr) => {
315 let events = $node.get_and_clear_pending_msg_events();
316 assert!(events.len() == 1 || events.len() == 2);
317 (match events[events.len() - 1] {
318 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
319 assert_eq!(msg.contents.flags & 2, 2);
322 _ => panic!("Unexpected event"),
323 }, if events.len() == 2 {
325 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
326 assert_eq!(*node_id, $dest_pubkey);
329 _ => panic!("Unexpected event"),
336 macro_rules! check_closed_broadcast {
338 let events = $node.node.get_and_clear_pending_msg_events();
339 assert_eq!(events.len(), 1);
341 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
342 assert_eq!(msg.contents.flags & 2, 2);
344 _ => panic!("Unexpected event"),
349 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
350 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
351 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
354 node_a.close_channel(channel_id).unwrap();
355 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
357 let events_1 = node_b.get_and_clear_pending_msg_events();
358 assert!(events_1.len() >= 1);
359 let shutdown_b = match events_1[0] {
360 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
361 assert_eq!(node_id, &node_a.get_our_node_id());
364 _ => panic!("Unexpected event"),
367 let closing_signed_b = if !close_inbound_first {
368 assert_eq!(events_1.len(), 1);
371 Some(match events_1[1] {
372 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
373 assert_eq!(node_id, &node_a.get_our_node_id());
376 _ => panic!("Unexpected event"),
380 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
381 let (as_update, bs_update) = if close_inbound_first {
382 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
383 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
384 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
385 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
386 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
388 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
389 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
390 assert!(none_b.is_none());
391 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
392 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
393 (as_update, bs_update)
395 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
397 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
398 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
399 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
400 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
402 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
403 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
404 assert!(none_a.is_none());
405 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
406 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
407 (as_update, bs_update)
409 assert_eq!(tx_a, tx_b);
410 check_spends!(tx_a, funding_tx);
412 (as_update, bs_update, tx_a)
417 msgs: Vec<msgs::UpdateAddHTLC>,
418 commitment_msg: msgs::CommitmentSigned,
421 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
422 assert!(updates.update_fulfill_htlcs.is_empty());
423 assert!(updates.update_fail_htlcs.is_empty());
424 assert!(updates.update_fail_malformed_htlcs.is_empty());
425 assert!(updates.update_fee.is_none());
426 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
429 fn from_event(event: MessageSendEvent) -> SendEvent {
431 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
432 _ => panic!("Unexpected event type!"),
436 fn from_node(node: &Node) -> SendEvent {
437 let mut events = node.node.get_and_clear_pending_msg_events();
438 assert_eq!(events.len(), 1);
439 SendEvent::from_event(events.pop().unwrap())
443 macro_rules! check_added_monitors {
444 ($node: expr, $count: expr) => {
446 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
447 assert_eq!(added_monitors.len(), $count);
448 added_monitors.clear();
453 macro_rules! commitment_signed_dance {
454 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
456 check_added_monitors!($node_a, 0);
457 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
458 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
459 check_added_monitors!($node_a, 1);
460 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
463 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
465 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
466 check_added_monitors!($node_b, 0);
467 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
468 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
469 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
470 check_added_monitors!($node_b, 1);
471 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
472 let (bs_revoke_and_ack, extra_msg_option) = {
473 let events = $node_b.node.get_and_clear_pending_msg_events();
474 assert!(events.len() <= 2);
476 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
477 assert_eq!(*node_id, $node_a.node.get_our_node_id());
480 _ => panic!("Unexpected event"),
481 }, events.get(1).map(|e| e.clone()))
483 check_added_monitors!($node_b, 1);
485 assert!($node_a.node.get_and_clear_pending_events().is_empty());
486 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
488 (extra_msg_option, bs_revoke_and_ack)
491 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
493 check_added_monitors!($node_a, 0);
494 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
495 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
496 check_added_monitors!($node_a, 1);
497 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
498 assert!(extra_msg_option.is_none());
502 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
504 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
505 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
506 check_added_monitors!($node_a, 1);
510 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
512 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
515 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
517 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
519 expect_pending_htlcs_forwardable!($node_a);
520 check_added_monitors!($node_a, 1);
522 let channel_state = $node_a.node.channel_state.lock().unwrap();
523 assert_eq!(channel_state.pending_msg_events.len(), 1);
524 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
525 assert_ne!(*node_id, $node_b.node.get_our_node_id());
526 } else { panic!("Unexpected event"); }
528 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
534 macro_rules! get_payment_preimage_hash {
537 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
538 *$node.network_payment_count.borrow_mut() += 1;
539 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
540 (payment_preimage, payment_hash)
545 macro_rules! expect_pending_htlcs_forwardable {
547 let events = $node.node.get_and_clear_pending_events();
548 assert_eq!(events.len(), 1);
550 Event::PendingHTLCsForwardable { .. } => { },
551 _ => panic!("Unexpected event"),
553 let node_ref: &Node = &$node;
554 node_ref.node.channel_state.lock().unwrap().next_forward = Instant::now();
555 $node.node.process_pending_htlc_forwards();
559 fn send_along_route_with_hash(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64, our_payment_hash: PaymentHash) {
560 let mut payment_event = {
561 origin_node.node.send_payment(route, our_payment_hash).unwrap();
562 check_added_monitors!(origin_node, 1);
564 let mut events = origin_node.node.get_and_clear_pending_msg_events();
565 assert_eq!(events.len(), 1);
566 SendEvent::from_event(events.remove(0))
568 let mut prev_node = origin_node;
570 for (idx, &node) in expected_route.iter().enumerate() {
571 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
573 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
574 check_added_monitors!(node, 0);
575 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
577 expect_pending_htlcs_forwardable!(node);
579 if idx == expected_route.len() - 1 {
580 let events_2 = node.node.get_and_clear_pending_events();
581 assert_eq!(events_2.len(), 1);
583 Event::PaymentReceived { ref payment_hash, amt } => {
584 assert_eq!(our_payment_hash, *payment_hash);
585 assert_eq!(amt, recv_value);
587 _ => panic!("Unexpected event"),
590 let mut events_2 = node.node.get_and_clear_pending_msg_events();
591 assert_eq!(events_2.len(), 1);
592 check_added_monitors!(node, 1);
593 payment_event = SendEvent::from_event(events_2.remove(0));
594 assert_eq!(payment_event.msgs.len(), 1);
601 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
602 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
603 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
604 (our_payment_preimage, our_payment_hash)
607 fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: PaymentPreimage) {
608 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
609 check_added_monitors!(expected_route.last().unwrap(), 1);
611 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
612 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
613 macro_rules! get_next_msgs {
616 let events = $node.node.get_and_clear_pending_msg_events();
617 assert_eq!(events.len(), 1);
619 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
620 assert!(update_add_htlcs.is_empty());
621 assert_eq!(update_fulfill_htlcs.len(), 1);
622 assert!(update_fail_htlcs.is_empty());
623 assert!(update_fail_malformed_htlcs.is_empty());
624 assert!(update_fee.is_none());
625 expected_next_node = node_id.clone();
626 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
628 _ => panic!("Unexpected event"),
634 macro_rules! last_update_fulfill_dance {
635 ($node: expr, $prev_node: expr) => {
637 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
638 check_added_monitors!($node, 0);
639 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
640 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
644 macro_rules! mid_update_fulfill_dance {
645 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
647 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
648 check_added_monitors!($node, 1);
649 let new_next_msgs = if $new_msgs {
650 get_next_msgs!($node)
652 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
655 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
656 next_msgs = new_next_msgs;
661 let mut prev_node = expected_route.last().unwrap();
662 for (idx, node) in expected_route.iter().rev().enumerate() {
663 assert_eq!(expected_next_node, node.node.get_our_node_id());
664 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
665 if next_msgs.is_some() {
666 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
667 } else if update_next_msgs {
668 next_msgs = get_next_msgs!(node);
670 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
672 if !skip_last && idx == expected_route.len() - 1 {
673 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
680 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
681 let events = origin_node.node.get_and_clear_pending_events();
682 assert_eq!(events.len(), 1);
684 Event::PaymentSent { payment_preimage } => {
685 assert_eq!(payment_preimage, our_payment_preimage);
687 _ => panic!("Unexpected event"),
692 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: PaymentPreimage) {
693 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
696 const TEST_FINAL_CLTV: u32 = 32;
698 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
699 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
700 assert_eq!(route.hops.len(), expected_route.len());
701 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
702 assert_eq!(hop.pubkey, node.node.get_our_node_id());
705 send_along_route(origin_node, route, expected_route, recv_value)
708 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
709 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
710 assert_eq!(route.hops.len(), expected_route.len());
711 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
712 assert_eq!(hop.pubkey, node.node.get_our_node_id());
715 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
717 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
719 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
720 _ => panic!("Unknown error variants"),
724 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
725 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
726 claim_payment(&origin, expected_route, our_payment_preimage);
729 fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: PaymentHash) {
730 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, 0));
731 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
732 check_added_monitors!(expected_route.last().unwrap(), 1);
734 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
735 macro_rules! update_fail_dance {
736 ($node: expr, $prev_node: expr, $last_node: expr) => {
738 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
739 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
740 if skip_last && $last_node {
741 expect_pending_htlcs_forwardable!($node);
747 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
748 let mut prev_node = expected_route.last().unwrap();
749 for (idx, node) in expected_route.iter().rev().enumerate() {
750 assert_eq!(expected_next_node, node.node.get_our_node_id());
751 if next_msgs.is_some() {
752 // We may be the "last node" for the purpose of the commitment dance if we're
753 // skipping the last node (implying it is disconnected) and we're the
754 // second-to-last node!
755 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
758 let events = node.node.get_and_clear_pending_msg_events();
759 if !skip_last || idx != expected_route.len() - 1 {
760 assert_eq!(events.len(), 1);
762 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
763 assert!(update_add_htlcs.is_empty());
764 assert!(update_fulfill_htlcs.is_empty());
765 assert_eq!(update_fail_htlcs.len(), 1);
766 assert!(update_fail_malformed_htlcs.is_empty());
767 assert!(update_fee.is_none());
768 expected_next_node = node_id.clone();
769 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
771 _ => panic!("Unexpected event"),
774 assert!(events.is_empty());
776 if !skip_last && idx == expected_route.len() - 1 {
777 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
784 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
786 let events = origin_node.node.get_and_clear_pending_events();
787 assert_eq!(events.len(), 1);
789 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
790 assert_eq!(payment_hash, our_payment_hash);
791 assert!(rejected_by_dest);
793 _ => panic!("Unexpected event"),
798 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: PaymentHash) {
799 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
802 fn create_network(node_count: usize) -> Vec<Node> {
803 let mut nodes = Vec::new();
804 let mut rng = thread_rng();
805 let secp_ctx = Secp256k1::new();
807 let chan_count = Rc::new(RefCell::new(0));
808 let payment_count = Rc::new(RefCell::new(0));
810 for i in 0..node_count {
811 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
812 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
813 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
814 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
815 let mut seed = [0; 32];
816 rng.fill_bytes(&mut seed);
817 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, Arc::clone(&logger)));
818 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
819 let mut config = UserConfig::new();
820 config.channel_options.announced_channel = true;
821 config.channel_limits.force_announced_channel_preference = false;
822 let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), config).unwrap();
823 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
824 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, keys_manager, node_seed: seed,
825 network_payment_count: payment_count.clone(),
826 network_chan_count: chan_count.clone(),
834 fn test_async_inbound_update_fee() {
835 let mut nodes = create_network(2);
836 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
837 let channel_id = chan.2;
840 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
844 // send (1) commitment_signed -.
845 // <- update_add_htlc/commitment_signed
846 // send (2) RAA (awaiting remote revoke) -.
847 // (1) commitment_signed is delivered ->
848 // .- send (3) RAA (awaiting remote revoke)
849 // (2) RAA is delivered ->
850 // .- send (4) commitment_signed
851 // <- (3) RAA is delivered
852 // send (5) commitment_signed -.
853 // <- (4) commitment_signed is delivered
855 // (5) commitment_signed is delivered ->
857 // (6) RAA is delivered ->
859 // First nodes[0] generates an update_fee
860 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
861 check_added_monitors!(nodes[0], 1);
863 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
864 assert_eq!(events_0.len(), 1);
865 let (update_msg, commitment_signed) = match events_0[0] { // (1)
866 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
867 (update_fee.as_ref(), commitment_signed)
869 _ => panic!("Unexpected event"),
872 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
874 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
875 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
876 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
877 check_added_monitors!(nodes[1], 1);
879 let payment_event = {
880 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
881 assert_eq!(events_1.len(), 1);
882 SendEvent::from_event(events_1.remove(0))
884 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
885 assert_eq!(payment_event.msgs.len(), 1);
887 // ...now when the messages get delivered everyone should be happy
888 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
889 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
890 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
891 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
892 check_added_monitors!(nodes[0], 1);
894 // deliver(1), generate (3):
895 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
896 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
897 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
898 check_added_monitors!(nodes[1], 1);
900 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
901 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
902 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
903 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
904 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
905 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
906 assert!(bs_update.update_fee.is_none()); // (4)
907 check_added_monitors!(nodes[1], 1);
909 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
910 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
911 assert!(as_update.update_add_htlcs.is_empty()); // (5)
912 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
913 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
914 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
915 assert!(as_update.update_fee.is_none()); // (5)
916 check_added_monitors!(nodes[0], 1);
918 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
919 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
920 // only (6) so get_event_msg's assert(len == 1) passes
921 check_added_monitors!(nodes[0], 1);
923 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
924 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
925 check_added_monitors!(nodes[1], 1);
927 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
928 check_added_monitors!(nodes[0], 1);
930 let events_2 = nodes[0].node.get_and_clear_pending_events();
931 assert_eq!(events_2.len(), 1);
933 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
934 _ => panic!("Unexpected event"),
937 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
938 check_added_monitors!(nodes[1], 1);
942 fn test_update_fee_unordered_raa() {
943 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
944 // crash in an earlier version of the update_fee patch)
945 let mut nodes = create_network(2);
946 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
947 let channel_id = chan.2;
950 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
952 // First nodes[0] generates an update_fee
953 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
954 check_added_monitors!(nodes[0], 1);
956 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
957 assert_eq!(events_0.len(), 1);
958 let update_msg = match events_0[0] { // (1)
959 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
962 _ => panic!("Unexpected event"),
965 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
967 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
968 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
969 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
970 check_added_monitors!(nodes[1], 1);
972 let payment_event = {
973 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
974 assert_eq!(events_1.len(), 1);
975 SendEvent::from_event(events_1.remove(0))
977 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
978 assert_eq!(payment_event.msgs.len(), 1);
980 // ...now when the messages get delivered everyone should be happy
981 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
982 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
983 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
984 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
985 check_added_monitors!(nodes[0], 1);
987 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
988 check_added_monitors!(nodes[1], 1);
990 // We can't continue, sadly, because our (1) now has a bogus signature
994 fn test_multi_flight_update_fee() {
995 let nodes = create_network(2);
996 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
997 let channel_id = chan.2;
1000 // update_fee/commitment_signed ->
1001 // .- send (1) RAA and (2) commitment_signed
1002 // update_fee (never committed) ->
1003 // (3) update_fee ->
1004 // We have to manually generate the above update_fee, it is allowed by the protocol but we
1005 // don't track which updates correspond to which revoke_and_ack responses so we're in
1006 // AwaitingRAA mode and will not generate the update_fee yet.
1007 // <- (1) RAA delivered
1008 // (3) is generated and send (4) CS -.
1009 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
1010 // know the per_commitment_point to use for it.
1011 // <- (2) commitment_signed delivered
1012 // revoke_and_ack ->
1013 // B should send no response here
1014 // (4) commitment_signed delivered ->
1015 // <- RAA/commitment_signed delivered
1016 // revoke_and_ack ->
1018 // First nodes[0] generates an update_fee
1019 let initial_feerate = get_feerate!(nodes[0], channel_id);
1020 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
1021 check_added_monitors!(nodes[0], 1);
1023 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1024 assert_eq!(events_0.len(), 1);
1025 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
1026 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
1027 (update_fee.as_ref().unwrap(), commitment_signed)
1029 _ => panic!("Unexpected event"),
1032 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
1033 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
1034 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
1035 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1036 check_added_monitors!(nodes[1], 1);
1038 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
1040 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
1041 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1042 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044 // Create the (3) update_fee message that nodes[0] will generate before it does...
1045 let mut update_msg_2 = msgs::UpdateFee {
1046 channel_id: update_msg_1.channel_id.clone(),
1047 feerate_per_kw: (initial_feerate + 30) as u32,
1050 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
1052 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
1054 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
1056 // Deliver (1), generating (3) and (4)
1057 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
1058 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1059 check_added_monitors!(nodes[0], 1);
1060 assert!(as_second_update.update_add_htlcs.is_empty());
1061 assert!(as_second_update.update_fulfill_htlcs.is_empty());
1062 assert!(as_second_update.update_fail_htlcs.is_empty());
1063 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
1064 // Check that the update_fee newly generated matches what we delivered:
1065 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
1066 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
1068 // Deliver (2) commitment_signed
1069 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1070 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1071 check_added_monitors!(nodes[0], 1);
1072 // No commitment_signed so get_event_msg's assert(len == 1) passes
1074 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
1075 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1076 check_added_monitors!(nodes[1], 1);
1079 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
1080 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1081 check_added_monitors!(nodes[1], 1);
1083 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
1084 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1085 check_added_monitors!(nodes[0], 1);
1087 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
1088 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1089 // No commitment_signed so get_event_msg's assert(len == 1) passes
1090 check_added_monitors!(nodes[0], 1);
1092 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
1093 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1094 check_added_monitors!(nodes[1], 1);
1098 fn test_update_fee_vanilla() {
1099 let nodes = create_network(2);
1100 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1101 let channel_id = chan.2;
1103 let feerate = get_feerate!(nodes[0], channel_id);
1104 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
1105 check_added_monitors!(nodes[0], 1);
1107 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1108 assert_eq!(events_0.len(), 1);
1109 let (update_msg, commitment_signed) = match events_0[0] {
1110 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
1111 (update_fee.as_ref(), commitment_signed)
1113 _ => panic!("Unexpected event"),
1115 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1117 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1118 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1119 check_added_monitors!(nodes[1], 1);
1121 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1122 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1123 check_added_monitors!(nodes[0], 1);
1125 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
1126 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1127 // No commitment_signed so get_event_msg's assert(len == 1) passes
1128 check_added_monitors!(nodes[0], 1);
1130 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1131 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1132 check_added_monitors!(nodes[1], 1);
1136 fn test_update_fee_that_funder_cannot_afford() {
1137 let nodes = create_network(2);
1138 let channel_value = 1888;
1139 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
1140 let channel_id = chan.2;
1143 nodes[0].node.update_fee(channel_id, feerate).unwrap();
1144 check_added_monitors!(nodes[0], 1);
1145 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1147 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
1149 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
1151 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
1152 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
1154 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1155 let chan = chan_lock.by_id.get(&channel_id).unwrap();
1157 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
1158 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
1159 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1160 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
1161 actual_fee = channel_value - actual_fee;
1162 assert_eq!(total_fee, actual_fee);
1165 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
1166 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
1167 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
1168 check_added_monitors!(nodes[0], 1);
1170 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1172 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
1174 //While producing the commitment_signed response after handling a received update_fee request the
1175 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
1176 //Should produce and error.
1177 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
1179 assert!(match err.err {
1180 "Funding remote cannot afford proposed new fee" => true,
1184 //clear the message we could not handle
1185 nodes[1].node.get_and_clear_pending_msg_events();
1189 fn test_update_fee_with_fundee_update_add_htlc() {
1190 let mut nodes = create_network(2);
1191 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1192 let channel_id = chan.2;
1195 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1197 let feerate = get_feerate!(nodes[0], channel_id);
1198 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
1199 check_added_monitors!(nodes[0], 1);
1201 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1202 assert_eq!(events_0.len(), 1);
1203 let (update_msg, commitment_signed) = match events_0[0] {
1204 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
1205 (update_fee.as_ref(), commitment_signed)
1207 _ => panic!("Unexpected event"),
1209 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1210 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1211 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1212 check_added_monitors!(nodes[1], 1);
1214 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
1216 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
1218 // nothing happens since node[1] is in AwaitingRemoteRevoke
1219 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
1221 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
1222 assert_eq!(added_monitors.len(), 0);
1223 added_monitors.clear();
1225 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1226 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1227 // node[1] has nothing to do
1229 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1230 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1231 check_added_monitors!(nodes[0], 1);
1233 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
1234 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1235 // No commitment_signed so get_event_msg's assert(len == 1) passes
1236 check_added_monitors!(nodes[0], 1);
1237 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1238 check_added_monitors!(nodes[1], 1);
1239 // AwaitingRemoteRevoke ends here
1241 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1242 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
1243 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
1244 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
1245 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
1246 assert_eq!(commitment_update.update_fee.is_none(), true);
1248 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
1249 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1250 check_added_monitors!(nodes[0], 1);
1251 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1253 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
1254 check_added_monitors!(nodes[1], 1);
1255 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1257 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
1258 check_added_monitors!(nodes[1], 1);
1259 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1260 // No commitment_signed so get_event_msg's assert(len == 1) passes
1262 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
1263 check_added_monitors!(nodes[0], 1);
1264 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1266 expect_pending_htlcs_forwardable!(nodes[0]);
1268 let events = nodes[0].node.get_and_clear_pending_events();
1269 assert_eq!(events.len(), 1);
1271 Event::PaymentReceived { .. } => { },
1272 _ => panic!("Unexpected event"),
1275 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
1277 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
1278 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
1279 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
1283 fn test_update_fee() {
1284 let nodes = create_network(2);
1285 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1286 let channel_id = chan.2;
1289 // (1) update_fee/commitment_signed ->
1290 // <- (2) revoke_and_ack
1291 // .- send (3) commitment_signed
1292 // (4) update_fee/commitment_signed ->
1293 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
1294 // <- (3) commitment_signed delivered
1295 // send (6) revoke_and_ack -.
1296 // <- (5) deliver revoke_and_ack
1297 // (6) deliver revoke_and_ack ->
1298 // .- send (7) commitment_signed in response to (4)
1299 // <- (7) deliver commitment_signed
1300 // revoke_and_ack ->
1302 // Create and deliver (1)...
1303 let feerate = get_feerate!(nodes[0], channel_id);
1304 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
1305 check_added_monitors!(nodes[0], 1);
1307 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1308 assert_eq!(events_0.len(), 1);
1309 let (update_msg, commitment_signed) = match events_0[0] {
1310 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
1311 (update_fee.as_ref(), commitment_signed)
1313 _ => panic!("Unexpected event"),
1315 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1317 // Generate (2) and (3):
1318 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1319 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1320 check_added_monitors!(nodes[1], 1);
1323 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1324 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1325 check_added_monitors!(nodes[0], 1);
1327 // Create and deliver (4)...
1328 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
1329 check_added_monitors!(nodes[0], 1);
1330 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1331 assert_eq!(events_0.len(), 1);
1332 let (update_msg, commitment_signed) = match events_0[0] {
1333 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
1334 (update_fee.as_ref(), commitment_signed)
1336 _ => panic!("Unexpected event"),
1339 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1340 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1341 check_added_monitors!(nodes[1], 1);
1343 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1344 // No commitment_signed so get_event_msg's assert(len == 1) passes
1346 // Handle (3), creating (6):
1347 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
1348 check_added_monitors!(nodes[0], 1);
1349 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1350 // No commitment_signed so get_event_msg's assert(len == 1) passes
1353 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1354 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1355 check_added_monitors!(nodes[0], 1);
1357 // Deliver (6), creating (7):
1358 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
1359 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1360 assert!(commitment_update.update_add_htlcs.is_empty());
1361 assert!(commitment_update.update_fulfill_htlcs.is_empty());
1362 assert!(commitment_update.update_fail_htlcs.is_empty());
1363 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1364 assert!(commitment_update.update_fee.is_none());
1365 check_added_monitors!(nodes[1], 1);
1368 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1369 check_added_monitors!(nodes[0], 1);
1370 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1371 // No commitment_signed so get_event_msg's assert(len == 1) passes
1373 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1374 check_added_monitors!(nodes[1], 1);
1375 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1377 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
1378 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
1379 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
1383 fn pre_funding_lock_shutdown_test() {
1384 // Test sending a shutdown prior to funding_locked after funding generation
1385 let nodes = create_network(2);
1386 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
1387 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1388 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
1389 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
1391 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
1392 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1393 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1394 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1395 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1397 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1398 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1399 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1400 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1401 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1402 assert!(node_0_none.is_none());
1404 assert!(nodes[0].node.list_channels().is_empty());
1405 assert!(nodes[1].node.list_channels().is_empty());
1409 fn updates_shutdown_wait() {
1410 // Test sending a shutdown with outstanding updates pending
1411 let mut nodes = create_network(3);
1412 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1413 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1414 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1415 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1417 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1419 nodes[0].node.close_channel(&chan_1.2).unwrap();
1420 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1421 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1422 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1423 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1425 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1426 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1428 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1429 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
1430 else { panic!("New sends should fail!") };
1431 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
1432 else { panic!("New sends should fail!") };
1434 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1435 check_added_monitors!(nodes[2], 1);
1436 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1437 assert!(updates.update_add_htlcs.is_empty());
1438 assert!(updates.update_fail_htlcs.is_empty());
1439 assert!(updates.update_fail_malformed_htlcs.is_empty());
1440 assert!(updates.update_fee.is_none());
1441 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1442 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
1443 check_added_monitors!(nodes[1], 1);
1444 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1445 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1447 assert!(updates_2.update_add_htlcs.is_empty());
1448 assert!(updates_2.update_fail_htlcs.is_empty());
1449 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1450 assert!(updates_2.update_fee.is_none());
1451 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1452 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
1453 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1455 let events = nodes[0].node.get_and_clear_pending_events();
1456 assert_eq!(events.len(), 1);
1458 Event::PaymentSent { ref payment_preimage } => {
1459 assert_eq!(our_payment_preimage, *payment_preimage);
1461 _ => panic!("Unexpected event"),
1464 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1465 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1466 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1467 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1468 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1469 assert!(node_0_none.is_none());
1471 assert!(nodes[0].node.list_channels().is_empty());
1473 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1474 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1475 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1476 assert!(nodes[1].node.list_channels().is_empty());
1477 assert!(nodes[2].node.list_channels().is_empty());
1481 fn htlc_fail_async_shutdown() {
1482 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
1483 let mut nodes = create_network(3);
1484 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1485 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1487 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1488 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1489 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
1490 check_added_monitors!(nodes[0], 1);
1491 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1492 assert_eq!(updates.update_add_htlcs.len(), 1);
1493 assert!(updates.update_fulfill_htlcs.is_empty());
1494 assert!(updates.update_fail_htlcs.is_empty());
1495 assert!(updates.update_fail_malformed_htlcs.is_empty());
1496 assert!(updates.update_fee.is_none());
1498 nodes[1].node.close_channel(&chan_1.2).unwrap();
1499 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1500 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1501 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1503 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
1504 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
1505 check_added_monitors!(nodes[1], 1);
1506 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1507 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
1509 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1510 assert!(updates_2.update_add_htlcs.is_empty());
1511 assert!(updates_2.update_fulfill_htlcs.is_empty());
1512 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
1513 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1514 assert!(updates_2.update_fee.is_none());
1516 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
1517 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1519 let events = nodes[0].node.get_and_clear_pending_events();
1520 assert_eq!(events.len(), 1);
1522 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
1523 assert_eq!(our_payment_hash, *payment_hash);
1524 assert!(!rejected_by_dest);
1526 _ => panic!("Unexpected event"),
1529 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
1530 assert_eq!(msg_events.len(), 2);
1531 let node_0_closing_signed = match msg_events[0] {
1532 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1533 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1536 _ => panic!("Unexpected event"),
1538 match msg_events[1] {
1539 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1540 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
1542 _ => panic!("Unexpected event"),
1545 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1546 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1547 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1548 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1549 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1550 assert!(node_0_none.is_none());
1552 assert!(nodes[0].node.list_channels().is_empty());
1554 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1555 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1556 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1557 assert!(nodes[1].node.list_channels().is_empty());
1558 assert!(nodes[2].node.list_channels().is_empty());
1561 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1562 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1563 // messages delivered prior to disconnect
1564 let nodes = create_network(3);
1565 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1566 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1568 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1570 nodes[1].node.close_channel(&chan_1.2).unwrap();
1571 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1573 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1574 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1576 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1580 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1581 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1583 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
1584 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1585 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
1586 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1588 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
1589 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1590 assert!(node_1_shutdown == node_1_2nd_shutdown);
1592 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
1593 let node_0_2nd_shutdown = if recv_count > 0 {
1594 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1595 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
1598 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1599 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
1600 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1602 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
1604 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1605 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1607 assert!(nodes[2].node.claim_funds(our_payment_preimage));
1608 check_added_monitors!(nodes[2], 1);
1609 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1610 assert!(updates.update_add_htlcs.is_empty());
1611 assert!(updates.update_fail_htlcs.is_empty());
1612 assert!(updates.update_fail_malformed_htlcs.is_empty());
1613 assert!(updates.update_fee.is_none());
1614 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1615 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
1616 check_added_monitors!(nodes[1], 1);
1617 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1618 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1620 assert!(updates_2.update_add_htlcs.is_empty());
1621 assert!(updates_2.update_fail_htlcs.is_empty());
1622 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1623 assert!(updates_2.update_fee.is_none());
1624 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1625 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
1626 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1628 let events = nodes[0].node.get_and_clear_pending_events();
1629 assert_eq!(events.len(), 1);
1631 Event::PaymentSent { ref payment_preimage } => {
1632 assert_eq!(our_payment_preimage, *payment_preimage);
1634 _ => panic!("Unexpected event"),
1637 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1639 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1640 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1641 assert!(node_1_closing_signed.is_some());
1644 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1645 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1647 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
1648 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1649 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
1650 if recv_count == 0 {
1651 // If all closing_signeds weren't delivered we can just resume where we left off...
1652 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1654 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
1655 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1656 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1658 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
1659 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1660 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1662 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
1663 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1665 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
1666 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1667 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1669 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
1670 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1671 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1672 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1673 assert!(node_0_none.is_none());
1675 // If one node, however, received + responded with an identical closing_signed we end
1676 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1677 // There isn't really anything better we can do simply, but in the future we might
1678 // explore storing a set of recently-closed channels that got disconnected during
1679 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1680 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1682 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1684 if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
1685 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
1686 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1687 let msgs::ErrorMessage {ref channel_id, ..} = msg;
1688 assert_eq!(*channel_id, chan_1.2);
1689 } else { panic!("Needed SendErrorMessage close"); }
1691 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1692 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1693 // closing_signed so we do it ourselves
1694 check_closed_broadcast!(nodes[0]);
1697 assert!(nodes[0].node.list_channels().is_empty());
1699 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1700 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1701 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1702 assert!(nodes[1].node.list_channels().is_empty());
1703 assert!(nodes[2].node.list_channels().is_empty());
1707 fn test_shutdown_rebroadcast() {
1708 do_test_shutdown_rebroadcast(0);
1709 do_test_shutdown_rebroadcast(1);
1710 do_test_shutdown_rebroadcast(2);
1714 fn fake_network_test() {
1715 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1716 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1717 let nodes = create_network(4);
1719 // Create some initial channels
1720 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1721 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1722 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1724 // Rebalance the network a bit by relaying one payment through all the channels...
1725 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1726 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1727 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1728 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1730 // Send some more payments
1731 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1732 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1733 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1735 // Test failure packets
1736 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1737 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1739 // Add a new channel that skips 3
1740 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
1742 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1743 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1744 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1745 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1746 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1747 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1748 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1750 // Do some rebalance loop payments, simultaneously
1751 let mut hops = Vec::with_capacity(3);
1752 hops.push(RouteHop {
1753 pubkey: nodes[2].node.get_our_node_id(),
1754 short_channel_id: chan_2.0.contents.short_channel_id,
1756 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1758 hops.push(RouteHop {
1759 pubkey: nodes[3].node.get_our_node_id(),
1760 short_channel_id: chan_3.0.contents.short_channel_id,
1762 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1764 hops.push(RouteHop {
1765 pubkey: nodes[1].node.get_our_node_id(),
1766 short_channel_id: chan_4.0.contents.short_channel_id,
1768 cltv_expiry_delta: TEST_FINAL_CLTV,
1770 hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1771 hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1772 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1774 let mut hops = Vec::with_capacity(3);
1775 hops.push(RouteHop {
1776 pubkey: nodes[3].node.get_our_node_id(),
1777 short_channel_id: chan_4.0.contents.short_channel_id,
1779 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1781 hops.push(RouteHop {
1782 pubkey: nodes[2].node.get_our_node_id(),
1783 short_channel_id: chan_3.0.contents.short_channel_id,
1785 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1787 hops.push(RouteHop {
1788 pubkey: nodes[1].node.get_our_node_id(),
1789 short_channel_id: chan_2.0.contents.short_channel_id,
1791 cltv_expiry_delta: TEST_FINAL_CLTV,
1793 hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1794 hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1795 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1797 // Claim the rebalances...
1798 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1799 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1801 // Add a duplicate new channel from 2 to 4
1802 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
1804 // Send some payments across both channels
1805 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1806 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1807 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1809 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1811 //TODO: Test that routes work again here as we've been notified that the channel is full
1813 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1814 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1815 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1817 // Close down the channels...
1818 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1819 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1820 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1821 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1822 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1826 fn duplicate_htlc_test() {
1827 // Test that we accept duplicate payment_hash HTLCs across the network and that
1828 // claiming/failing them are all separate and don't effect each other
1829 let mut nodes = create_network(6);
1831 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1832 create_announced_chan_between_nodes(&nodes, 0, 3);
1833 create_announced_chan_between_nodes(&nodes, 1, 3);
1834 create_announced_chan_between_nodes(&nodes, 2, 3);
1835 create_announced_chan_between_nodes(&nodes, 3, 4);
1836 create_announced_chan_between_nodes(&nodes, 3, 5);
1838 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1840 *nodes[0].network_payment_count.borrow_mut() -= 1;
1841 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1843 *nodes[0].network_payment_count.borrow_mut() -= 1;
1844 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1846 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1847 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1848 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1851 #[derive(PartialEq)]
1852 enum HTLCType { NONE, TIMEOUT, SUCCESS }
1853 /// Tests that the given node has broadcast transactions for the given Channel
1855 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
1856 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1857 /// broadcast and the revoked outputs were claimed.
1859 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1860 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1862 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1864 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
1865 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1866 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1868 let mut res = Vec::with_capacity(2);
1869 node_txn.retain(|tx| {
1870 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1871 check_spends!(tx, chan.3.clone());
1872 if commitment_tx.is_none() {
1873 res.push(tx.clone());
1878 if let Some(explicit_tx) = commitment_tx {
1879 res.push(explicit_tx.clone());
1882 assert_eq!(res.len(), 1);
1884 if has_htlc_tx != HTLCType::NONE {
1885 node_txn.retain(|tx| {
1886 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1887 check_spends!(tx, res[0].clone());
1888 if has_htlc_tx == HTLCType::TIMEOUT {
1889 assert!(tx.lock_time != 0);
1891 assert!(tx.lock_time == 0);
1893 res.push(tx.clone());
1897 assert!(res.len() == 2 || res.len() == 3);
1899 assert_eq!(res[1], res[2]);
1903 assert!(node_txn.is_empty());
1907 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1908 /// HTLC transaction.
1909 fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
1910 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1911 assert_eq!(node_txn.len(), 1);
1912 node_txn.retain(|tx| {
1913 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1914 check_spends!(tx, revoked_tx.clone());
1918 assert!(node_txn.is_empty());
1921 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1922 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1924 assert!(node_txn.len() >= 1);
1925 assert_eq!(node_txn[0].input.len(), 1);
1926 let mut found_prev = false;
1928 for tx in prev_txn {
1929 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1930 check_spends!(node_txn[0], tx.clone());
1931 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1932 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1938 assert!(found_prev);
1940 let mut res = Vec::new();
1941 mem::swap(&mut *node_txn, &mut res);
1945 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
1946 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1947 assert_eq!(events_1.len(), 1);
1948 let as_update = match events_1[0] {
1949 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1952 _ => panic!("Unexpected event"),
1955 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1956 assert_eq!(events_2.len(), 1);
1957 let bs_update = match events_2[0] {
1958 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1961 _ => panic!("Unexpected event"),
1965 node.router.handle_channel_update(&as_update).unwrap();
1966 node.router.handle_channel_update(&bs_update).unwrap();
1970 fn do_channel_reserve_test(test_recv: bool) {
1972 use std::sync::atomic::Ordering;
1973 use ln::msgs::HandleError;
1975 macro_rules! get_channel_value_stat {
1976 ($node: expr, $channel_id: expr) => {{
1977 let chan_lock = $node.node.channel_state.lock().unwrap();
1978 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1979 chan.get_value_stat()
1983 let mut nodes = create_network(3);
1984 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
1985 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
1987 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1988 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1990 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1991 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1993 macro_rules! get_route_and_payment_hash {
1994 ($recv_value: expr) => {{
1995 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1996 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1997 (route, payment_hash, payment_preimage)
2001 macro_rules! expect_forward {
2003 let mut events = $node.node.get_and_clear_pending_msg_events();
2004 assert_eq!(events.len(), 1);
2005 check_added_monitors!($node, 1);
2006 let payment_event = SendEvent::from_event(events.remove(0));
2011 macro_rules! expect_payment_received {
2012 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2013 let events = $node.node.get_and_clear_pending_events();
2014 assert_eq!(events.len(), 1);
2016 Event::PaymentReceived { ref payment_hash, amt } => {
2017 assert_eq!($expected_payment_hash, *payment_hash);
2018 assert_eq!($expected_recv_value, amt);
2020 _ => panic!("Unexpected event"),
2025 let feemsat = 239; // somehow we know?
2026 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
2028 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
2030 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
2032 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
2033 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
2034 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
2036 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
2037 _ => panic!("Unknown error variants"),
2041 let mut htlc_id = 0;
2042 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
2043 // nodes[0]'s wealth
2045 let amt_msat = recv_value_0 + total_fee_msat;
2046 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
2049 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
2052 let (stat01_, stat11_, stat12_, stat22_) = (
2053 get_channel_value_stat!(nodes[0], chan_1.2),
2054 get_channel_value_stat!(nodes[1], chan_1.2),
2055 get_channel_value_stat!(nodes[1], chan_2.2),
2056 get_channel_value_stat!(nodes[2], chan_2.2),
2059 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
2060 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
2061 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2062 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2063 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2067 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
2068 // attempt to get channel_reserve violation
2069 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
2070 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
2072 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2073 _ => panic!("Unknown error variants"),
2077 // adding pending output
2078 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
2079 let amt_msat_1 = recv_value_1 + total_fee_msat;
2081 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2082 let payment_event_1 = {
2083 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
2084 check_added_monitors!(nodes[0], 1);
2086 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2087 assert_eq!(events.len(), 1);
2088 SendEvent::from_event(events.remove(0))
2090 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
2092 // channel reserve test with htlc pending output > 0
2093 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
2095 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2096 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
2097 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2098 _ => panic!("Unknown error variants"),
2103 // test channel_reserve test on nodes[1] side
2104 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2106 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
2107 let secp_ctx = Secp256k1::new();
2108 let session_priv = SecretKey::from_slice(&secp_ctx, &{
2109 let mut session_key = [0; 32];
2110 rng::fill_bytes(&mut session_key);
2112 }).expect("RNG is bad!");
2114 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
2115 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2116 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
2117 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
2118 let msg = msgs::UpdateAddHTLC {
2119 channel_id: chan_1.2,
2121 amount_msat: htlc_msat,
2122 payment_hash: our_payment_hash,
2123 cltv_expiry: htlc_cltv,
2124 onion_routing_packet: onion_packet,
2128 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
2130 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
2132 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
2133 assert_eq!(nodes[1].node.list_channels().len(), 1);
2134 assert_eq!(nodes[1].node.list_channels().len(), 1);
2135 check_closed_broadcast!(nodes[1]);
2140 // split the rest to test holding cell
2141 let recv_value_21 = recv_value_2/2;
2142 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
2144 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2145 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat), stat.channel_reserve_msat);
2148 // now see if they go through on both sides
2149 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2150 // but this will stuck in the holding cell
2151 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
2152 check_added_monitors!(nodes[0], 0);
2153 let events = nodes[0].node.get_and_clear_pending_events();
2154 assert_eq!(events.len(), 0);
2156 // test with outbound holding cell amount > 0
2158 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2159 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
2160 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2161 _ => panic!("Unknown error variants"),
2165 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2166 // this will also stuck in the holding cell
2167 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
2168 check_added_monitors!(nodes[0], 0);
2169 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2170 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2172 // flush the pending htlc
2173 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
2174 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2175 check_added_monitors!(nodes[1], 1);
2177 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2178 check_added_monitors!(nodes[0], 1);
2179 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2181 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
2182 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2183 // No commitment_signed so get_event_msg's assert(len == 1) passes
2184 check_added_monitors!(nodes[0], 1);
2186 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2187 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2188 check_added_monitors!(nodes[1], 1);
2190 expect_pending_htlcs_forwardable!(nodes[1]);
2192 let ref payment_event_11 = expect_forward!(nodes[1]);
2193 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
2194 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2196 expect_pending_htlcs_forwardable!(nodes[2]);
2197 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2199 // flush the htlcs in the holding cell
2200 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2201 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
2202 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
2203 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2204 expect_pending_htlcs_forwardable!(nodes[1]);
2206 let ref payment_event_3 = expect_forward!(nodes[1]);
2207 assert_eq!(payment_event_3.msgs.len(), 2);
2208 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
2209 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
2211 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2212 expect_pending_htlcs_forwardable!(nodes[2]);
2214 let events = nodes[2].node.get_and_clear_pending_events();
2215 assert_eq!(events.len(), 2);
2217 Event::PaymentReceived { ref payment_hash, amt } => {
2218 assert_eq!(our_payment_hash_21, *payment_hash);
2219 assert_eq!(recv_value_21, amt);
2221 _ => panic!("Unexpected event"),
2224 Event::PaymentReceived { ref payment_hash, amt } => {
2225 assert_eq!(our_payment_hash_22, *payment_hash);
2226 assert_eq!(recv_value_22, amt);
2228 _ => panic!("Unexpected event"),
2231 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2232 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2233 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2235 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat);
2236 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2237 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2238 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
2240 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2241 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
2245 fn channel_reserve_test() {
2246 do_channel_reserve_test(false);
2247 do_channel_reserve_test(true);
2251 fn channel_monitor_network_test() {
2252 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2253 // tests that ChannelMonitor is able to recover from various states.
2254 let nodes = create_network(5);
2256 // Create some initial channels
2257 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2258 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2259 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2260 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2262 // Rebalance the network a bit by relaying one payment through all the channels...
2263 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2264 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2265 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2266 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2268 // Simple case with no pending HTLCs:
2269 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2271 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2272 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2273 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2274 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2276 get_announce_close_broadcast_events(&nodes, 0, 1);
2277 assert_eq!(nodes[0].node.list_channels().len(), 0);
2278 assert_eq!(nodes[1].node.list_channels().len(), 1);
2280 // One pending HTLC is discarded by the force-close:
2281 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2283 // Simple case of one pending HTLC to HTLC-Timeout
2284 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2286 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2287 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2288 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2289 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2291 get_announce_close_broadcast_events(&nodes, 1, 2);
2292 assert_eq!(nodes[1].node.list_channels().len(), 0);
2293 assert_eq!(nodes[2].node.list_channels().len(), 1);
2295 macro_rules! claim_funds {
2296 ($node: expr, $prev_node: expr, $preimage: expr) => {
2298 assert!($node.node.claim_funds($preimage));
2299 check_added_monitors!($node, 1);
2301 let events = $node.node.get_and_clear_pending_msg_events();
2302 assert_eq!(events.len(), 1);
2304 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2305 assert!(update_add_htlcs.is_empty());
2306 assert!(update_fail_htlcs.is_empty());
2307 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2309 _ => panic!("Unexpected event"),
2315 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2316 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2317 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2319 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2321 // Claim the payment on nodes[3], giving it knowledge of the preimage
2322 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2324 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2325 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2327 check_preimage_claim(&nodes[3], &node_txn);
2329 get_announce_close_broadcast_events(&nodes, 2, 3);
2330 assert_eq!(nodes[2].node.list_channels().len(), 0);
2331 assert_eq!(nodes[3].node.list_channels().len(), 1);
2333 { // Cheat and reset nodes[4]'s height to 1
2334 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2335 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
2338 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2339 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2340 // One pending HTLC to time out:
2341 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2342 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2346 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2347 nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2348 for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
2349 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2350 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2353 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2355 // Claim the payment on nodes[4], giving it knowledge of the preimage
2356 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2358 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2359 nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2360 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2361 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2362 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2365 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2367 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2368 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2370 check_preimage_claim(&nodes[4], &node_txn);
2372 get_announce_close_broadcast_events(&nodes, 3, 4);
2373 assert_eq!(nodes[3].node.list_channels().len(), 0);
2374 assert_eq!(nodes[4].node.list_channels().len(), 0);
2378 fn test_justice_tx() {
2379 // Test justice txn built on revoked HTLC-Success tx, against both sides
2381 let nodes = create_network(2);
2382 // Create some new channels:
2383 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
2385 // A pending HTLC which will be revoked:
2386 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2387 // Get the will-be-revoked local txn from nodes[0]
2388 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
2389 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2390 assert_eq!(revoked_local_txn[0].input.len(), 1);
2391 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2392 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2393 assert_eq!(revoked_local_txn[1].input.len(), 1);
2394 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2395 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2396 // Revoke the old state
2397 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2400 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2401 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2403 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2404 assert_eq!(node_txn.len(), 3);
2405 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2406 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2408 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2409 node_txn.swap_remove(0);
2411 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2413 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2414 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2415 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2416 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2417 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
2419 get_announce_close_broadcast_events(&nodes, 0, 1);
2421 assert_eq!(nodes[0].node.list_channels().len(), 0);
2422 assert_eq!(nodes[1].node.list_channels().len(), 0);
2424 // We test justice_tx build by A on B's revoked HTLC-Success tx
2425 // Create some new channels:
2426 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
2428 // A pending HTLC which will be revoked:
2429 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2430 // Get the will-be-revoked local txn from B
2431 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
2432 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2433 assert_eq!(revoked_local_txn[0].input.len(), 1);
2434 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2435 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2436 // Revoke the old state
2437 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2439 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2440 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2442 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2443 assert_eq!(node_txn.len(), 3);
2444 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2445 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2447 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2448 node_txn.swap_remove(0);
2450 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2452 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2453 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2454 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2455 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2456 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
2458 get_announce_close_broadcast_events(&nodes, 0, 1);
2459 assert_eq!(nodes[0].node.list_channels().len(), 0);
2460 assert_eq!(nodes[1].node.list_channels().len(), 0);
2464 fn revoked_output_claim() {
2465 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2466 // transaction is broadcast by its counterparty
2467 let nodes = create_network(2);
2468 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2469 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2470 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2471 assert_eq!(revoked_local_txn.len(), 1);
2472 // Only output is the full channel value back to nodes[0]:
2473 assert_eq!(revoked_local_txn[0].output.len(), 1);
2474 // Send a payment through, updating everyone's latest commitment txn
2475 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2477 // Inform nodes[1] that nodes[0] broadcast a stale tx
2478 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2479 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2480 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2481 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2483 assert_eq!(node_txn[0], node_txn[2]);
2485 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2486 check_spends!(node_txn[1], chan_1.3.clone());
2488 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2489 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2490 get_announce_close_broadcast_events(&nodes, 0, 1);
2494 fn claim_htlc_outputs_shared_tx() {
2495 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2496 let nodes = create_network(2);
2498 // Create some new channel:
2499 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2501 // Rebalance the network to generate htlc in the two directions
2502 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2503 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
2504 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2505 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2507 // Get the will-be-revoked local txn from node[0]
2508 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2509 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2510 assert_eq!(revoked_local_txn[0].input.len(), 1);
2511 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2512 assert_eq!(revoked_local_txn[1].input.len(), 1);
2513 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2514 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2515 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2517 //Revoke the old state
2518 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2521 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2522 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2523 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2525 let events = nodes[1].node.get_and_clear_pending_events();
2526 assert_eq!(events.len(), 1);
2528 Event::PaymentFailed { payment_hash, .. } => {
2529 assert_eq!(payment_hash, payment_hash_2);
2531 _ => panic!("Unexpected event"),
2534 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2535 assert_eq!(node_txn.len(), 4);
2537 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2538 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2540 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2542 let mut witness_lens = BTreeSet::new();
2543 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2544 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2545 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2546 assert_eq!(witness_lens.len(), 3);
2547 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2548 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2549 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2551 // Next nodes[1] broadcasts its current local tx state:
2552 assert_eq!(node_txn[1].input.len(), 1);
2553 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2555 assert_eq!(node_txn[2].input.len(), 1);
2556 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2557 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2558 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2559 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2560 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2562 get_announce_close_broadcast_events(&nodes, 0, 1);
2563 assert_eq!(nodes[0].node.list_channels().len(), 0);
2564 assert_eq!(nodes[1].node.list_channels().len(), 0);
2568 fn claim_htlc_outputs_single_tx() {
2569 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2570 let nodes = create_network(2);
2572 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2574 // Rebalance the network to generate htlc in the two directions
2575 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2576 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
2577 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2578 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2579 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2581 // Get the will-be-revoked local txn from node[0]
2582 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2584 //Revoke the old state
2585 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2588 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2589 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2590 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2592 let events = nodes[1].node.get_and_clear_pending_events();
2593 assert_eq!(events.len(), 1);
2595 Event::PaymentFailed { payment_hash, .. } => {
2596 assert_eq!(payment_hash, payment_hash_2);
2598 _ => panic!("Unexpected event"),
2601 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2602 assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
2604 assert_eq!(node_txn[0], node_txn[7]);
2605 assert_eq!(node_txn[1], node_txn[8]);
2606 assert_eq!(node_txn[2], node_txn[9]);
2607 assert_eq!(node_txn[3], node_txn[10]);
2608 assert_eq!(node_txn[4], node_txn[11]);
2609 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
2610 assert_eq!(node_txn[4], node_txn[6]);
2612 assert_eq!(node_txn[0].input.len(), 1);
2613 assert_eq!(node_txn[1].input.len(), 1);
2614 assert_eq!(node_txn[2].input.len(), 1);
2616 let mut revoked_tx_map = HashMap::new();
2617 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
2618 node_txn[0].verify(&revoked_tx_map).unwrap();
2619 node_txn[1].verify(&revoked_tx_map).unwrap();
2620 node_txn[2].verify(&revoked_tx_map).unwrap();
2622 let mut witness_lens = BTreeSet::new();
2623 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2624 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2625 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2626 assert_eq!(witness_lens.len(), 3);
2627 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2628 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2629 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2631 assert_eq!(node_txn[3].input.len(), 1);
2632 check_spends!(node_txn[3], chan_1.3.clone());
2634 assert_eq!(node_txn[4].input.len(), 1);
2635 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2636 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2637 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2638 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2639 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2641 get_announce_close_broadcast_events(&nodes, 0, 1);
2642 assert_eq!(nodes[0].node.list_channels().len(), 0);
2643 assert_eq!(nodes[1].node.list_channels().len(), 0);
2647 fn test_htlc_on_chain_success() {
2648 // Test that in case of an unilateral close onchain, we detect the state of output thanks to
2649 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2650 // broadcasting the right event to other nodes in payment path.
2651 // A --------------------> B ----------------------> C (preimage)
2652 // First, C should claim the HTLC output via HTLC-Success when its own latest local
2653 // commitment transaction was broadcast.
2654 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2656 // B should be able to claim via preimage if A then broadcasts its local tx.
2657 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2658 // the HTLC output via the preimage it learned (which, once confirmed should generate a
2659 // PaymentSent event).
2661 let nodes = create_network(3);
2663 // Create some initial channels
2664 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2665 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2667 // Rebalance the network a bit by relaying one payment through all the channels...
2668 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2669 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2671 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2672 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2674 // Broadcast legit commitment tx from C on B's chain
2675 // Broadcast HTLC Success transation by C on received output from C's commitment tx on B's chain
2676 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2677 assert_eq!(commitment_tx.len(), 1);
2678 check_spends!(commitment_tx[0], chan_2.3.clone());
2679 nodes[2].node.claim_funds(our_payment_preimage);
2680 check_added_monitors!(nodes[2], 1);
2681 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2682 assert!(updates.update_add_htlcs.is_empty());
2683 assert!(updates.update_fail_htlcs.is_empty());
2684 assert!(updates.update_fail_malformed_htlcs.is_empty());
2685 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2687 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2688 check_closed_broadcast!(nodes[2]);
2689 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2690 assert_eq!(node_txn.len(), 3);
2691 assert_eq!(node_txn[1], commitment_tx[0]);
2692 assert_eq!(node_txn[0], node_txn[2]);
2693 check_spends!(node_txn[0], commitment_tx[0].clone());
2694 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2695 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2696 assert_eq!(node_txn[0].lock_time, 0);
2698 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2699 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
2700 let events = nodes[1].node.get_and_clear_pending_msg_events();
2702 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2703 assert_eq!(added_monitors.len(), 1);
2704 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2705 added_monitors.clear();
2707 assert_eq!(events.len(), 2);
2709 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2710 _ => panic!("Unexpected event"),
2713 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2714 assert!(update_add_htlcs.is_empty());
2715 assert!(update_fail_htlcs.is_empty());
2716 assert_eq!(update_fulfill_htlcs.len(), 1);
2717 assert!(update_fail_malformed_htlcs.is_empty());
2718 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2720 _ => panic!("Unexpected event"),
2723 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2724 // commitment transaction with a corresponding HTLC-Timeout transaction, as well as a
2725 // timeout-claim of the output that nodes[2] just claimed via success.
2726 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (timeout tx) * 2 (block-rescan)
2727 assert_eq!(node_txn.len(), 4);
2728 assert_eq!(node_txn[0], node_txn[3]);
2729 check_spends!(node_txn[0], commitment_tx[0].clone());
2730 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2731 assert_ne!(node_txn[0].lock_time, 0);
2732 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2733 check_spends!(node_txn[1], chan_2.3.clone());
2734 check_spends!(node_txn[2], node_txn[1].clone());
2735 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2736 assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2737 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2738 assert_ne!(node_txn[2].lock_time, 0);
2742 // Broadcast legit commitment tx from A on B's chain
2743 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2744 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2745 check_spends!(commitment_tx[0], chan_1.3.clone());
2746 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2747 check_closed_broadcast!(nodes[1]);
2748 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2749 assert_eq!(node_txn.len(), 3);
2750 assert_eq!(node_txn[0], node_txn[2]);
2751 check_spends!(node_txn[0], commitment_tx[0].clone());
2752 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2753 assert_eq!(node_txn[0].lock_time, 0);
2754 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2755 check_spends!(node_txn[1], chan_1.3.clone());
2756 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2757 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2758 // we already checked the same situation with A.
2760 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2761 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2762 check_closed_broadcast!(nodes[0]);
2763 let events = nodes[0].node.get_and_clear_pending_events();
2764 assert_eq!(events.len(), 1);
2766 Event::PaymentSent { payment_preimage } => {
2767 assert_eq!(payment_preimage, our_payment_preimage);
2769 _ => panic!("Unexpected event"),
2771 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (HTLC-Timeout tx) * 2 (block-rescan)
2772 assert_eq!(node_txn.len(), 4);
2773 assert_eq!(node_txn[0], node_txn[3]);
2774 check_spends!(node_txn[0], commitment_tx[0].clone());
2775 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2776 assert_ne!(node_txn[0].lock_time, 0);
2777 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2778 check_spends!(node_txn[1], chan_1.3.clone());
2779 check_spends!(node_txn[2], node_txn[1].clone());
2780 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2781 assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2782 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2783 assert_ne!(node_txn[2].lock_time, 0);
2787 fn test_htlc_on_chain_timeout() {
2788 // Test that in case of an unilateral close onchain, we detect the state of output thanks to
2789 // ChainWatchInterface and timeout the HTLC bacward accordingly. So here we test that ChannelManager is
2790 // broadcasting the right event to other nodes in payment path.
2791 // A ------------------> B ----------------------> C (timeout)
2792 // B's commitment tx C's commitment tx
2794 // B's HTLC timeout tx B's timeout tx
2796 let nodes = create_network(3);
2798 // Create some intial channels
2799 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2800 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2802 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2803 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2804 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2806 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2807 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2809 // Brodacast legit commitment tx from C on B's chain
2810 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2811 check_spends!(commitment_tx[0], chan_2.3.clone());
2812 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
2813 check_added_monitors!(nodes[2], 0);
2814 expect_pending_htlcs_forwardable!(nodes[2]);
2815 check_added_monitors!(nodes[2], 1);
2817 let events = nodes[2].node.get_and_clear_pending_msg_events();
2818 assert_eq!(events.len(), 1);
2820 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2821 assert!(update_add_htlcs.is_empty());
2822 assert!(!update_fail_htlcs.is_empty());
2823 assert!(update_fulfill_htlcs.is_empty());
2824 assert!(update_fail_malformed_htlcs.is_empty());
2825 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2827 _ => panic!("Unexpected event"),
2829 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2830 check_closed_broadcast!(nodes[2]);
2831 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2832 assert_eq!(node_txn.len(), 1);
2833 check_spends!(node_txn[0], chan_2.3.clone());
2834 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2836 // Broadcast timeout transaction by B on received output fron C's commitment tx on B's chain
2837 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2838 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2841 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2842 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2843 assert_eq!(node_txn[0], node_txn[5]);
2844 assert_eq!(node_txn[1], node_txn[6]);
2845 assert_eq!(node_txn[2], node_txn[7]);
2846 check_spends!(node_txn[0], commitment_tx[0].clone());
2847 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848 check_spends!(node_txn[1], chan_2.3.clone());
2849 check_spends!(node_txn[2], node_txn[1].clone());
2850 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2851 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2852 check_spends!(node_txn[3], chan_2.3.clone());
2853 check_spends!(node_txn[4], node_txn[3].clone());
2854 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2855 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2856 timeout_tx = node_txn[0].clone();
2860 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
2861 check_added_monitors!(nodes[1], 0);
2862 check_closed_broadcast!(nodes[1]);
2864 expect_pending_htlcs_forwardable!(nodes[1]);
2865 check_added_monitors!(nodes[1], 1);
2866 let events = nodes[1].node.get_and_clear_pending_msg_events();
2867 assert_eq!(events.len(), 1);
2869 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2870 assert!(update_add_htlcs.is_empty());
2871 assert!(!update_fail_htlcs.is_empty());
2872 assert!(update_fulfill_htlcs.is_empty());
2873 assert!(update_fail_malformed_htlcs.is_empty());
2874 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2876 _ => panic!("Unexpected event"),
2878 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
2879 assert_eq!(node_txn.len(), 0);
2881 // Broadcast legit commitment tx from B on A's chain
2882 let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2883 check_spends!(commitment_tx[0], chan_1.3.clone());
2885 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2886 check_closed_broadcast!(nodes[0]);
2887 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2888 assert_eq!(node_txn.len(), 4);
2889 assert_eq!(node_txn[0], node_txn[3]);
2890 check_spends!(node_txn[0], commitment_tx[0].clone());
2891 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2892 check_spends!(node_txn[1], chan_1.3.clone());
2893 check_spends!(node_txn[2], node_txn[1].clone());
2894 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2895 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2899 fn test_simple_commitment_revoked_fail_backward() {
2900 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2901 // and fail backward accordingly.
2903 let nodes = create_network(3);
2905 // Create some initial channels
2906 create_announced_chan_between_nodes(&nodes, 0, 1);
2907 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2909 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2910 // Get the will-be-revoked local txn from nodes[2]
2911 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2912 // Revoke the old state
2913 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2915 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2917 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2918 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2919 check_added_monitors!(nodes[1], 0);
2920 check_closed_broadcast!(nodes[1]);
2922 expect_pending_htlcs_forwardable!(nodes[1]);
2923 check_added_monitors!(nodes[1], 1);
2924 let events = nodes[1].node.get_and_clear_pending_msg_events();
2925 assert_eq!(events.len(), 1);
2927 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
2928 assert!(update_add_htlcs.is_empty());
2929 assert_eq!(update_fail_htlcs.len(), 1);
2930 assert!(update_fulfill_htlcs.is_empty());
2931 assert!(update_fail_malformed_htlcs.is_empty());
2932 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2934 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2935 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2937 let events = nodes[0].node.get_and_clear_pending_msg_events();
2938 assert_eq!(events.len(), 1);
2940 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2941 _ => panic!("Unexpected event"),
2943 let events = nodes[0].node.get_and_clear_pending_events();
2944 assert_eq!(events.len(), 1);
2946 Event::PaymentFailed { .. } => {},
2947 _ => panic!("Unexpected event"),
2950 _ => panic!("Unexpected event"),
2954 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool) {
2955 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2956 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2957 // commitment transaction anymore.
2958 // To do this, we have the peer which will broadcast a revoked commitment transaction send
2959 // a number of update_fail/commitment_signed updates without ever sending the RAA in
2960 // response to our commitment_signed. This is somewhat misbehavior-y, though not
2961 // technically disallowed and we should probably handle it reasonably.
2962 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2963 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2965 // * Once we move it out of our holding cell/add it, we will immediately include it in a
2966 // commitment_signed (implying it will be in the latest remote commitment transaction).
2967 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2968 // and once they revoke the previous commitment transaction (allowing us to send a new
2969 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2970 let mut nodes = create_network(3);
2972 // Create some initial channels
2973 create_announced_chan_between_nodes(&nodes, 0, 1);
2974 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2976 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2977 // Get the will-be-revoked local txn from nodes[2]
2978 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2979 // Revoke the old state
2980 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2982 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2983 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2984 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2986 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, 0));
2987 expect_pending_htlcs_forwardable!(nodes[2]);
2988 check_added_monitors!(nodes[2], 1);
2989 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2990 assert!(updates.update_add_htlcs.is_empty());
2991 assert!(updates.update_fulfill_htlcs.is_empty());
2992 assert!(updates.update_fail_malformed_htlcs.is_empty());
2993 assert_eq!(updates.update_fail_htlcs.len(), 1);
2994 assert!(updates.update_fee.is_none());
2995 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2996 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2997 // Drop the last RAA from 3 -> 2
2999 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, 0));
3000 expect_pending_htlcs_forwardable!(nodes[2]);
3001 check_added_monitors!(nodes[2], 1);
3002 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3003 assert!(updates.update_add_htlcs.is_empty());
3004 assert!(updates.update_fulfill_htlcs.is_empty());
3005 assert!(updates.update_fail_malformed_htlcs.is_empty());
3006 assert_eq!(updates.update_fail_htlcs.len(), 1);
3007 assert!(updates.update_fee.is_none());
3008 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3009 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3010 check_added_monitors!(nodes[1], 1);
3011 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3012 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3013 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3014 check_added_monitors!(nodes[2], 1);
3016 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, 0));
3017 expect_pending_htlcs_forwardable!(nodes[2]);
3018 check_added_monitors!(nodes[2], 1);
3019 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3020 assert!(updates.update_add_htlcs.is_empty());
3021 assert!(updates.update_fulfill_htlcs.is_empty());
3022 assert!(updates.update_fail_malformed_htlcs.is_empty());
3023 assert_eq!(updates.update_fail_htlcs.len(), 1);
3024 assert!(updates.update_fee.is_none());
3025 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3026 // At this point first_payment_hash has dropped out of the latest two commitment
3027 // transactions that nodes[1] is tracking...
3028 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3029 check_added_monitors!(nodes[1], 1);
3030 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3031 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3032 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3033 check_added_monitors!(nodes[2], 1);
3035 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3036 // on nodes[2]'s RAA.
3037 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3038 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3039 nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
3040 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3041 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3042 check_added_monitors!(nodes[1], 0);
3045 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
3046 // One monitor for the new revocation preimage, one as we generate a commitment for
3047 // nodes[0] to fail first_payment_hash backwards.
3048 check_added_monitors!(nodes[1], 1);
3049 let events = nodes[1].node.get_and_clear_pending_events();
3050 assert_eq!(events.len(), 1);
3052 Event::PendingHTLCsForwardable { .. } => { },
3053 _ => panic!("Unexpected event"),
3055 // Deliberately don't process the pending fail-back so they all fail back at once after
3056 // block connection just like the !deliver_bs_raa case
3059 let mut failed_htlcs = HashSet::new();
3060 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3062 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3063 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3065 let events = nodes[1].node.get_and_clear_pending_events();
3066 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3068 Event::PaymentFailed { ref payment_hash, .. } => {
3069 assert_eq!(*payment_hash, fourth_payment_hash);
3071 _ => panic!("Unexpected event"),
3073 if !deliver_bs_raa {
3075 Event::PendingHTLCsForwardable { .. } => { },
3076 _ => panic!("Unexpected event"),
3079 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3080 nodes[1].node.process_pending_htlc_forwards();
3081 check_added_monitors!(nodes[1], 1);
3083 let events = nodes[1].node.get_and_clear_pending_msg_events();
3084 assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3085 match events[if deliver_bs_raa { 1 } else { 0 }] {
3086 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3087 _ => panic!("Unexpected event"),
3091 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3092 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3093 assert_eq!(update_add_htlcs.len(), 1);
3094 assert!(update_fulfill_htlcs.is_empty());
3095 assert!(update_fail_htlcs.is_empty());
3096 assert!(update_fail_malformed_htlcs.is_empty());
3098 _ => panic!("Unexpected event"),
3101 match events[if deliver_bs_raa { 2 } else { 1 }] {
3102 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3103 assert!(update_add_htlcs.is_empty());
3104 assert_eq!(update_fail_htlcs.len(), 3);
3105 assert!(update_fulfill_htlcs.is_empty());
3106 assert!(update_fail_malformed_htlcs.is_empty());
3107 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3109 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
3110 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]).unwrap();
3111 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]).unwrap();
3113 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3115 let events = nodes[0].node.get_and_clear_pending_msg_events();
3116 // If we delievered B's RAA we got an unknown preimage error, not something
3117 // that we should update our routing table for.
3118 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3119 for event in events {
3121 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3122 _ => panic!("Unexpected event"),
3125 let events = nodes[0].node.get_and_clear_pending_events();
3126 assert_eq!(events.len(), 3);
3128 Event::PaymentFailed { ref payment_hash, .. } => {
3129 assert!(failed_htlcs.insert(payment_hash.0));
3131 _ => panic!("Unexpected event"),
3134 Event::PaymentFailed { ref payment_hash, .. } => {
3135 assert!(failed_htlcs.insert(payment_hash.0));
3137 _ => panic!("Unexpected event"),
3140 Event::PaymentFailed { ref payment_hash, .. } => {
3141 assert!(failed_htlcs.insert(payment_hash.0));
3143 _ => panic!("Unexpected event"),
3146 _ => panic!("Unexpected event"),
3149 assert!(failed_htlcs.contains(&first_payment_hash.0));
3150 assert!(failed_htlcs.contains(&second_payment_hash.0));
3151 assert!(failed_htlcs.contains(&third_payment_hash.0));
3155 fn test_commitment_revoked_fail_backward_exhaustive() {
3156 do_test_commitment_revoked_fail_backward_exhaustive(false);
3157 do_test_commitment_revoked_fail_backward_exhaustive(true);
3161 fn test_htlc_ignore_latest_remote_commitment() {
3162 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3163 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3164 let nodes = create_network(2);
3165 create_announced_chan_between_nodes(&nodes, 0, 1);
3167 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3168 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3169 check_closed_broadcast!(nodes[0]);
3171 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3172 assert_eq!(node_txn.len(), 2);
3174 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3175 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3176 check_closed_broadcast!(nodes[1]);
3178 // Duplicate the block_connected call since this may happen due to other listeners
3179 // registering new transactions
3180 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3184 fn test_force_close_fail_back() {
3185 // Check which HTLCs are failed-backwards on channel force-closure
3186 let mut nodes = create_network(3);
3187 create_announced_chan_between_nodes(&nodes, 0, 1);
3188 create_announced_chan_between_nodes(&nodes, 1, 2);
3190 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3192 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3194 let mut payment_event = {
3195 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3196 check_added_monitors!(nodes[0], 1);
3198 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3199 assert_eq!(events.len(), 1);
3200 SendEvent::from_event(events.remove(0))
3203 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3204 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3206 expect_pending_htlcs_forwardable!(nodes[1]);
3208 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3209 assert_eq!(events_2.len(), 1);
3210 payment_event = SendEvent::from_event(events_2.remove(0));
3211 assert_eq!(payment_event.msgs.len(), 1);
3213 check_added_monitors!(nodes[1], 1);
3214 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3215 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3216 check_added_monitors!(nodes[2], 1);
3217 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3219 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3220 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3221 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3223 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3224 check_closed_broadcast!(nodes[2]);
3226 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3227 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3228 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3229 // back to nodes[1] upon timeout otherwise.
3230 assert_eq!(node_txn.len(), 1);
3234 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3235 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3237 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3238 check_closed_broadcast!(nodes[1]);
3240 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3242 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3243 monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
3244 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3246 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3247 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3248 assert_eq!(node_txn.len(), 1);
3249 assert_eq!(node_txn[0].input.len(), 1);
3250 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3251 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3252 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3254 check_spends!(node_txn[0], tx);
3258 fn test_unconf_chan() {
3259 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3260 let nodes = create_network(2);
3261 create_announced_chan_between_nodes(&nodes, 0, 1);
3263 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3264 assert_eq!(channel_state.by_id.len(), 1);
3265 assert_eq!(channel_state.short_to_id.len(), 1);
3266 mem::drop(channel_state);
3268 let mut headers = Vec::new();
3269 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3270 headers.push(header.clone());
3272 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3273 headers.push(header.clone());
3275 while !headers.is_empty() {
3276 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3278 check_closed_broadcast!(nodes[0]);
3279 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3280 assert_eq!(channel_state.by_id.len(), 0);
3281 assert_eq!(channel_state.short_to_id.len(), 0);
3284 macro_rules! get_chan_reestablish_msgs {
3285 ($src_node: expr, $dst_node: expr) => {
3287 let mut res = Vec::with_capacity(1);
3288 for msg in $src_node.node.get_and_clear_pending_msg_events() {
3289 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3290 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3291 res.push(msg.clone());
3293 panic!("Unexpected event")
3301 macro_rules! handle_chan_reestablish_msgs {
3302 ($src_node: expr, $dst_node: expr) => {
3304 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3306 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
3308 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3314 let mut revoke_and_ack = None;
3315 let mut commitment_update = None;
3316 let order = if let Some(ev) = msg_events.get(idx) {
3319 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3320 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3321 revoke_and_ack = Some(msg.clone());
3322 RAACommitmentOrder::RevokeAndACKFirst
3324 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3325 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3326 commitment_update = Some(updates.clone());
3327 RAACommitmentOrder::CommitmentFirst
3329 _ => panic!("Unexpected event"),
3332 RAACommitmentOrder::CommitmentFirst
3335 if let Some(ev) = msg_events.get(idx) {
3337 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3338 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3339 assert!(revoke_and_ack.is_none());
3340 revoke_and_ack = Some(msg.clone());
3342 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3343 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3344 assert!(commitment_update.is_none());
3345 commitment_update = Some(updates.clone());
3347 _ => panic!("Unexpected event"),
3351 (funding_locked, revoke_and_ack, commitment_update, order)
3356 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3357 /// for claims/fails they are separated out.
3358 fn reconnect_nodes(node_a: &Node, node_b: &Node, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
3359 node_a.node.peer_connected(&node_b.node.get_our_node_id());
3360 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3361 node_b.node.peer_connected(&node_a.node.get_our_node_id());
3362 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3364 if send_funding_locked.0 {
3365 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
3367 for reestablish in reestablish_1.iter() {
3368 assert_eq!(reestablish.next_remote_commitment_number, 0);
3371 if send_funding_locked.1 {
3372 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
3374 for reestablish in reestablish_2.iter() {
3375 assert_eq!(reestablish.next_remote_commitment_number, 0);
3378 if send_funding_locked.0 || send_funding_locked.1 {
3379 // If we expect any funding_locked's, both sides better have set
3380 // next_local_commitment_number to 1
3381 for reestablish in reestablish_1.iter() {
3382 assert_eq!(reestablish.next_local_commitment_number, 1);
3384 for reestablish in reestablish_2.iter() {
3385 assert_eq!(reestablish.next_local_commitment_number, 1);
3389 let mut resp_1 = Vec::new();
3390 for msg in reestablish_1 {
3391 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
3392 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3394 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3395 check_added_monitors!(node_b, 1);
3397 check_added_monitors!(node_b, 0);
3400 let mut resp_2 = Vec::new();
3401 for msg in reestablish_2 {
3402 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
3403 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3405 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3406 check_added_monitors!(node_a, 1);
3408 check_added_monitors!(node_a, 0);
3411 // We dont yet support both needing updates, as that would require a different commitment dance:
3412 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3413 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3415 for chan_msgs in resp_1.drain(..) {
3416 if send_funding_locked.0 {
3417 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3418 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3419 if !announcement_event.is_empty() {
3420 assert_eq!(announcement_event.len(), 1);
3421 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3422 //TODO: Test announcement_sigs re-sending
3423 } else { panic!("Unexpected event!"); }
3426 assert!(chan_msgs.0.is_none());
3429 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3430 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3431 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3432 check_added_monitors!(node_a, 1);
3434 assert!(chan_msgs.1.is_none());
3436 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3437 let commitment_update = chan_msgs.2.unwrap();
3438 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3439 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3441 assert!(commitment_update.update_add_htlcs.is_empty());
3443 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3444 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3445 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3446 for update_add in commitment_update.update_add_htlcs {
3447 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
3449 for update_fulfill in commitment_update.update_fulfill_htlcs {
3450 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
3452 for update_fail in commitment_update.update_fail_htlcs {
3453 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
3456 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3457 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3459 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3460 check_added_monitors!(node_a, 1);
3461 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3462 // No commitment_signed so get_event_msg's assert(len == 1) passes
3463 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3464 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3465 check_added_monitors!(node_b, 1);
3468 assert!(chan_msgs.2.is_none());
3472 for chan_msgs in resp_2.drain(..) {
3473 if send_funding_locked.1 {
3474 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3475 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3476 if !announcement_event.is_empty() {
3477 assert_eq!(announcement_event.len(), 1);
3478 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3479 //TODO: Test announcement_sigs re-sending
3480 } else { panic!("Unexpected event!"); }
3483 assert!(chan_msgs.0.is_none());
3486 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3487 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3488 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3489 check_added_monitors!(node_b, 1);
3491 assert!(chan_msgs.1.is_none());
3493 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3494 let commitment_update = chan_msgs.2.unwrap();
3495 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3496 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3498 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3499 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3500 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3501 for update_add in commitment_update.update_add_htlcs {
3502 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
3504 for update_fulfill in commitment_update.update_fulfill_htlcs {
3505 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
3507 for update_fail in commitment_update.update_fail_htlcs {
3508 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
3511 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3512 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3514 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3515 check_added_monitors!(node_b, 1);
3516 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3517 // No commitment_signed so get_event_msg's assert(len == 1) passes
3518 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3519 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3520 check_added_monitors!(node_a, 1);
3523 assert!(chan_msgs.2.is_none());
3529 fn test_simple_peer_disconnect() {
3530 // Test that we can reconnect when there are no lost messages
3531 let nodes = create_network(3);
3532 create_announced_chan_between_nodes(&nodes, 0, 1);
3533 create_announced_chan_between_nodes(&nodes, 1, 2);
3535 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3536 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3537 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3539 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3540 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3541 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3542 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3544 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3545 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3546 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3548 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3549 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3550 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3551 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3553 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3554 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3556 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
3557 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3559 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3561 let events = nodes[0].node.get_and_clear_pending_events();
3562 assert_eq!(events.len(), 2);
3564 Event::PaymentSent { payment_preimage } => {
3565 assert_eq!(payment_preimage, payment_preimage_3);
3567 _ => panic!("Unexpected event"),
3570 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3571 assert_eq!(payment_hash, payment_hash_5);
3572 assert!(rejected_by_dest);
3574 _ => panic!("Unexpected event"),
3578 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3579 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3582 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3583 // Test that we can reconnect when in-flight HTLC updates get dropped
3584 let mut nodes = create_network(2);
3585 if messages_delivered == 0 {
3586 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3587 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3589 create_announced_chan_between_nodes(&nodes, 0, 1);
3592 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3593 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3595 let payment_event = {
3596 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3597 check_added_monitors!(nodes[0], 1);
3599 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3600 assert_eq!(events.len(), 1);
3601 SendEvent::from_event(events.remove(0))
3603 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3605 if messages_delivered < 2 {
3606 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3608 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3609 if messages_delivered >= 3 {
3610 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3611 check_added_monitors!(nodes[1], 1);
3612 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3614 if messages_delivered >= 4 {
3615 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3616 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3617 check_added_monitors!(nodes[0], 1);
3619 if messages_delivered >= 5 {
3620 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
3621 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3622 // No commitment_signed so get_event_msg's assert(len == 1) passes
3623 check_added_monitors!(nodes[0], 1);
3625 if messages_delivered >= 6 {
3626 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3627 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3628 check_added_monitors!(nodes[1], 1);
3635 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3636 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3637 if messages_delivered < 3 {
3638 // Even if the funding_locked messages get exchanged, as long as nothing further was
3639 // received on either side, both sides will need to resend them.
3640 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3641 } else if messages_delivered == 3 {
3642 // nodes[0] still wants its RAA + commitment_signed
3643 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3644 } else if messages_delivered == 4 {
3645 // nodes[0] still wants its commitment_signed
3646 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3647 } else if messages_delivered == 5 {
3648 // nodes[1] still wants its final RAA
3649 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3650 } else if messages_delivered == 6 {
3651 // Everything was delivered...
3652 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3655 let events_1 = nodes[1].node.get_and_clear_pending_events();
3656 assert_eq!(events_1.len(), 1);
3658 Event::PendingHTLCsForwardable { .. } => { },
3659 _ => panic!("Unexpected event"),
3662 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3663 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3664 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3666 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3667 nodes[1].node.process_pending_htlc_forwards();
3669 let events_2 = nodes[1].node.get_and_clear_pending_events();
3670 assert_eq!(events_2.len(), 1);
3672 Event::PaymentReceived { ref payment_hash, amt } => {
3673 assert_eq!(payment_hash_1, *payment_hash);
3674 assert_eq!(amt, 1000000);
3676 _ => panic!("Unexpected event"),
3679 nodes[1].node.claim_funds(payment_preimage_1);
3680 check_added_monitors!(nodes[1], 1);
3682 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3683 assert_eq!(events_3.len(), 1);
3684 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3685 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3686 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3687 assert!(updates.update_add_htlcs.is_empty());
3688 assert!(updates.update_fail_htlcs.is_empty());
3689 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3690 assert!(updates.update_fail_malformed_htlcs.is_empty());
3691 assert!(updates.update_fee.is_none());
3692 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3694 _ => panic!("Unexpected event"),
3697 if messages_delivered >= 1 {
3698 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
3700 let events_4 = nodes[0].node.get_and_clear_pending_events();
3701 assert_eq!(events_4.len(), 1);
3703 Event::PaymentSent { ref payment_preimage } => {
3704 assert_eq!(payment_preimage_1, *payment_preimage);
3706 _ => panic!("Unexpected event"),
3709 if messages_delivered >= 2 {
3710 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3711 check_added_monitors!(nodes[0], 1);
3712 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3714 if messages_delivered >= 3 {
3715 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3716 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3717 check_added_monitors!(nodes[1], 1);
3719 if messages_delivered >= 4 {
3720 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
3721 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3722 // No commitment_signed so get_event_msg's assert(len == 1) passes
3723 check_added_monitors!(nodes[1], 1);
3725 if messages_delivered >= 5 {
3726 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3727 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3728 check_added_monitors!(nodes[0], 1);
3735 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3736 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3737 if messages_delivered < 2 {
3738 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3739 //TODO: Deduplicate PaymentSent events, then enable this if:
3740 //if messages_delivered < 1 {
3741 let events_4 = nodes[0].node.get_and_clear_pending_events();
3742 assert_eq!(events_4.len(), 1);
3744 Event::PaymentSent { ref payment_preimage } => {
3745 assert_eq!(payment_preimage_1, *payment_preimage);
3747 _ => panic!("Unexpected event"),
3750 } else if messages_delivered == 2 {
3751 // nodes[0] still wants its RAA + commitment_signed
3752 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3753 } else if messages_delivered == 3 {
3754 // nodes[0] still wants its commitment_signed
3755 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3756 } else if messages_delivered == 4 {
3757 // nodes[1] still wants its final RAA
3758 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3759 } else if messages_delivered == 5 {
3760 // Everything was delivered...
3761 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3764 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3765 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3766 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3768 // Channel should still work fine...
3769 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3770 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3774 fn test_drop_messages_peer_disconnect_a() {
3775 do_test_drop_messages_peer_disconnect(0);
3776 do_test_drop_messages_peer_disconnect(1);
3777 do_test_drop_messages_peer_disconnect(2);
3778 do_test_drop_messages_peer_disconnect(3);
3782 fn test_drop_messages_peer_disconnect_b() {
3783 do_test_drop_messages_peer_disconnect(4);
3784 do_test_drop_messages_peer_disconnect(5);
3785 do_test_drop_messages_peer_disconnect(6);
3789 fn test_funding_peer_disconnect() {
3790 // Test that we can lock in our funding tx while disconnected
3791 let nodes = create_network(2);
3792 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3794 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3795 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3797 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
3798 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3799 assert_eq!(events_1.len(), 1);
3801 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3802 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3804 _ => panic!("Unexpected event"),
3807 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3809 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3810 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3812 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
3813 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3814 assert_eq!(events_2.len(), 2);
3816 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3817 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3819 _ => panic!("Unexpected event"),
3822 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
3823 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3825 _ => panic!("Unexpected event"),
3828 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3830 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
3831 // rebroadcasting announcement_signatures upon reconnect.
3833 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3834 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3835 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3839 fn test_drop_messages_peer_disconnect_dual_htlc() {
3840 // Test that we can handle reconnecting when both sides of a channel have pending
3841 // commitment_updates when we disconnect.
3842 let mut nodes = create_network(2);
3843 create_announced_chan_between_nodes(&nodes, 0, 1);
3845 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3847 // Now try to send a second payment which will fail to send
3848 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3849 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3851 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3852 check_added_monitors!(nodes[0], 1);
3854 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3855 assert_eq!(events_1.len(), 1);
3857 MessageSendEvent::UpdateHTLCs { .. } => {},
3858 _ => panic!("Unexpected event"),
3861 assert!(nodes[1].node.claim_funds(payment_preimage_1));
3862 check_added_monitors!(nodes[1], 1);
3864 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3865 assert_eq!(events_2.len(), 1);
3867 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
3868 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3869 assert!(update_add_htlcs.is_empty());
3870 assert_eq!(update_fulfill_htlcs.len(), 1);
3871 assert!(update_fail_htlcs.is_empty());
3872 assert!(update_fail_malformed_htlcs.is_empty());
3873 assert!(update_fee.is_none());
3875 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3876 let events_3 = nodes[0].node.get_and_clear_pending_events();
3877 assert_eq!(events_3.len(), 1);
3879 Event::PaymentSent { ref payment_preimage } => {
3880 assert_eq!(*payment_preimage, payment_preimage_1);
3882 _ => panic!("Unexpected event"),
3885 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3886 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3887 // No commitment_signed so get_event_msg's assert(len == 1) passes
3888 check_added_monitors!(nodes[0], 1);
3890 _ => panic!("Unexpected event"),
3893 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3894 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3897 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3898 assert_eq!(reestablish_1.len(), 1);
3899 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3900 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3901 assert_eq!(reestablish_2.len(), 1);
3903 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3904 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3905 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3906 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3908 assert!(as_resp.0.is_none());
3909 assert!(bs_resp.0.is_none());
3911 assert!(bs_resp.1.is_none());
3912 assert!(bs_resp.2.is_none());
3914 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3916 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3917 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3918 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3919 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3920 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3921 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
3922 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3923 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3924 // No commitment_signed so get_event_msg's assert(len == 1) passes
3925 check_added_monitors!(nodes[1], 1);
3927 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3928 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3929 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3930 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3931 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3932 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3933 assert!(bs_second_commitment_signed.update_fee.is_none());
3934 check_added_monitors!(nodes[1], 1);
3936 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3937 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3938 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3939 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3940 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3941 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3942 assert!(as_commitment_signed.update_fee.is_none());
3943 check_added_monitors!(nodes[0], 1);
3945 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3946 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3947 // No commitment_signed so get_event_msg's assert(len == 1) passes
3948 check_added_monitors!(nodes[0], 1);
3950 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3951 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3952 // No commitment_signed so get_event_msg's assert(len == 1) passes
3953 check_added_monitors!(nodes[1], 1);
3955 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3956 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3957 check_added_monitors!(nodes[1], 1);
3959 expect_pending_htlcs_forwardable!(nodes[1]);
3961 let events_5 = nodes[1].node.get_and_clear_pending_events();
3962 assert_eq!(events_5.len(), 1);
3964 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3965 assert_eq!(payment_hash_2, *payment_hash);
3967 _ => panic!("Unexpected event"),
3970 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3971 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3972 check_added_monitors!(nodes[0], 1);
3974 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3978 fn test_simple_monitor_permanent_update_fail() {
3979 // Test that we handle a simple permanent monitor update failure
3980 let mut nodes = create_network(2);
3981 create_announced_chan_between_nodes(&nodes, 0, 1);
3983 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3984 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3986 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
3987 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
3988 check_added_monitors!(nodes[0], 1);
3990 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3991 assert_eq!(events_1.len(), 2);
3993 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3994 _ => panic!("Unexpected event"),
3997 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
3998 _ => panic!("Unexpected event"),
4001 // TODO: Once we hit the chain with the failure transaction we should check that we get a
4002 // PaymentFailed event
4004 assert_eq!(nodes[0].node.list_channels().len(), 0);
4007 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
4008 // Test that we can recover from a simple temporary monitor update failure optionally with
4009 // a disconnect in between
4010 let mut nodes = create_network(2);
4011 create_announced_chan_between_nodes(&nodes, 0, 1);
4013 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4014 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
4016 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4017 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
4018 check_added_monitors!(nodes[0], 1);
4020 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4021 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4022 assert_eq!(nodes[0].node.list_channels().len(), 1);
4025 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4026 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4027 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4030 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4031 nodes[0].node.test_restore_channel_monitor();
4032 check_added_monitors!(nodes[0], 1);
4034 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
4035 assert_eq!(events_2.len(), 1);
4036 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
4037 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4038 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4039 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4041 expect_pending_htlcs_forwardable!(nodes[1]);
4043 let events_3 = nodes[1].node.get_and_clear_pending_events();
4044 assert_eq!(events_3.len(), 1);
4046 Event::PaymentReceived { ref payment_hash, amt } => {
4047 assert_eq!(payment_hash_1, *payment_hash);
4048 assert_eq!(amt, 1000000);
4050 _ => panic!("Unexpected event"),
4053 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
4055 // Now set it to failed again...
4056 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4057 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4058 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
4059 check_added_monitors!(nodes[0], 1);
4061 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4062 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4063 assert_eq!(nodes[0].node.list_channels().len(), 1);
4066 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4067 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4068 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4071 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
4072 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
4073 nodes[0].node.test_restore_channel_monitor();
4074 check_added_monitors!(nodes[0], 1);
4075 check_closed_broadcast!(nodes[0]);
4077 // TODO: Once we hit the chain with the failure transaction we should check that we get a
4078 // PaymentFailed event
4080 assert_eq!(nodes[0].node.list_channels().len(), 0);
4084 fn test_simple_monitor_temporary_update_fail() {
4085 do_test_simple_monitor_temporary_update_fail(false);
4086 do_test_simple_monitor_temporary_update_fail(true);
4089 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
4090 let disconnect_flags = 8 | 16;
4092 // Test that we can recover from a temporary monitor update failure with some in-flight
4093 // HTLCs going on at the same time potentially with some disconnection thrown in.
4094 // * First we route a payment, then get a temporary monitor update failure when trying to
4095 // route a second payment. We then claim the first payment.
4096 // * If disconnect_count is set, we will disconnect at this point (which is likely as
4097 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
4098 // the ChannelMonitor on a watchtower).
4099 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
4100 // immediately, otherwise we wait sconnect and deliver them via the reconnect
4101 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
4102 // disconnect_count & !disconnect_flags is 0).
4103 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
4104 // through message sending, potentially disconnect/reconnecting multiple times based on
4105 // disconnect_count, to get the update_fulfill_htlc through.
4106 // * We then walk through more message exchanges to get the original update_add_htlc
4107 // through, swapping message ordering based on disconnect_count & 8 and optionally
4108 // disconnect/reconnecting based on disconnect_count.
4109 let mut nodes = create_network(2);
4110 create_announced_chan_between_nodes(&nodes, 0, 1);
4112 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4114 // Now try to send a second payment which will fail to send
4115 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4116 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4118 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4119 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
4120 check_added_monitors!(nodes[0], 1);
4122 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4123 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4124 assert_eq!(nodes[0].node.list_channels().len(), 1);
4126 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
4127 // but nodes[0] won't respond since it is frozen.
4128 assert!(nodes[1].node.claim_funds(payment_preimage_1));
4129 check_added_monitors!(nodes[1], 1);
4130 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4131 assert_eq!(events_2.len(), 1);
4132 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
4133 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
4134 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4135 assert!(update_add_htlcs.is_empty());
4136 assert_eq!(update_fulfill_htlcs.len(), 1);
4137 assert!(update_fail_htlcs.is_empty());
4138 assert!(update_fail_malformed_htlcs.is_empty());
4139 assert!(update_fee.is_none());
4141 if (disconnect_count & 16) == 0 {
4142 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
4143 let events_3 = nodes[0].node.get_and_clear_pending_events();
4144 assert_eq!(events_3.len(), 1);
4146 Event::PaymentSent { ref payment_preimage } => {
4147 assert_eq!(*payment_preimage, payment_preimage_1);
4149 _ => panic!("Unexpected event"),
4152 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed) {
4153 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4154 } else { panic!(); }
4157 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
4159 _ => panic!("Unexpected event"),
4162 if disconnect_count & !disconnect_flags > 0 {
4163 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4164 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4167 // Now fix monitor updating...
4168 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4169 nodes[0].node.test_restore_channel_monitor();
4170 check_added_monitors!(nodes[0], 1);
4172 macro_rules! disconnect_reconnect_peers { () => { {
4173 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4174 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4176 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4177 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4178 assert_eq!(reestablish_1.len(), 1);
4179 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4180 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4181 assert_eq!(reestablish_2.len(), 1);
4183 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4184 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4185 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4186 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4188 assert!(as_resp.0.is_none());
4189 assert!(bs_resp.0.is_none());
4191 (reestablish_1, reestablish_2, as_resp, bs_resp)
4194 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
4195 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4196 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4198 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4199 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4200 assert_eq!(reestablish_1.len(), 1);
4201 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4202 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4203 assert_eq!(reestablish_2.len(), 1);
4205 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4206 check_added_monitors!(nodes[0], 0);
4207 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4208 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4209 check_added_monitors!(nodes[1], 0);
4210 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4212 assert!(as_resp.0.is_none());
4213 assert!(bs_resp.0.is_none());
4215 assert!(bs_resp.1.is_none());
4216 if (disconnect_count & 16) == 0 {
4217 assert!(bs_resp.2.is_none());
4219 assert!(as_resp.1.is_some());
4220 assert!(as_resp.2.is_some());
4221 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4223 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
4224 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4225 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4226 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
4227 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
4228 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
4230 assert!(as_resp.1.is_none());
4232 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]).unwrap();
4233 let events_3 = nodes[0].node.get_and_clear_pending_events();
4234 assert_eq!(events_3.len(), 1);
4236 Event::PaymentSent { ref payment_preimage } => {
4237 assert_eq!(*payment_preimage, payment_preimage_1);
4239 _ => panic!("Unexpected event"),
4242 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
4243 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4244 // No commitment_signed so get_event_msg's assert(len == 1) passes
4245 check_added_monitors!(nodes[0], 1);
4247 as_resp.1 = Some(as_resp_raa);
4251 if disconnect_count & !disconnect_flags > 1 {
4252 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
4254 if (disconnect_count & 16) == 0 {
4255 assert!(reestablish_1 == second_reestablish_1);
4256 assert!(reestablish_2 == second_reestablish_2);
4258 assert!(as_resp == second_as_resp);
4259 assert!(bs_resp == second_bs_resp);
4262 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
4264 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
4265 assert_eq!(events_4.len(), 2);
4266 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
4267 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
4268 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4271 _ => panic!("Unexpected event"),
4275 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4277 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4278 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4279 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4280 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
4281 check_added_monitors!(nodes[1], 1);
4283 if disconnect_count & !disconnect_flags > 2 {
4284 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4286 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4287 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4289 assert!(as_resp.2.is_none());
4290 assert!(bs_resp.2.is_none());
4293 let as_commitment_update;
4294 let bs_second_commitment_update;
4296 macro_rules! handle_bs_raa { () => {
4297 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4298 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4299 assert!(as_commitment_update.update_add_htlcs.is_empty());
4300 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
4301 assert!(as_commitment_update.update_fail_htlcs.is_empty());
4302 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
4303 assert!(as_commitment_update.update_fee.is_none());
4304 check_added_monitors!(nodes[0], 1);
4307 macro_rules! handle_initial_raa { () => {
4308 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
4309 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4310 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
4311 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
4312 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
4313 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
4314 assert!(bs_second_commitment_update.update_fee.is_none());
4315 check_added_monitors!(nodes[1], 1);
4318 if (disconnect_count & 8) == 0 {
4321 if disconnect_count & !disconnect_flags > 3 {
4322 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4324 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4325 assert!(bs_resp.1.is_none());
4327 assert!(as_resp.2.unwrap() == as_commitment_update);
4328 assert!(bs_resp.2.is_none());
4330 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4333 handle_initial_raa!();
4335 if disconnect_count & !disconnect_flags > 4 {
4336 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4338 assert!(as_resp.1.is_none());
4339 assert!(bs_resp.1.is_none());
4341 assert!(as_resp.2.unwrap() == as_commitment_update);
4342 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4345 handle_initial_raa!();
4347 if disconnect_count & !disconnect_flags > 3 {
4348 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4350 assert!(as_resp.1.is_none());
4351 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4353 assert!(as_resp.2.is_none());
4354 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4356 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4361 if disconnect_count & !disconnect_flags > 4 {
4362 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4364 assert!(as_resp.1.is_none());
4365 assert!(bs_resp.1.is_none());
4367 assert!(as_resp.2.unwrap() == as_commitment_update);
4368 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4372 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
4373 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4374 // No commitment_signed so get_event_msg's assert(len == 1) passes
4375 check_added_monitors!(nodes[0], 1);
4377 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
4378 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4379 // No commitment_signed so get_event_msg's assert(len == 1) passes
4380 check_added_monitors!(nodes[1], 1);
4382 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
4383 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4384 check_added_monitors!(nodes[1], 1);
4386 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
4387 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4388 check_added_monitors!(nodes[0], 1);
4390 expect_pending_htlcs_forwardable!(nodes[1]);
4392 let events_5 = nodes[1].node.get_and_clear_pending_events();
4393 assert_eq!(events_5.len(), 1);
4395 Event::PaymentReceived { ref payment_hash, amt } => {
4396 assert_eq!(payment_hash_2, *payment_hash);
4397 assert_eq!(amt, 1000000);
4399 _ => panic!("Unexpected event"),
4402 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4406 fn test_monitor_temporary_update_fail_a() {
4407 do_test_monitor_temporary_update_fail(0);
4408 do_test_monitor_temporary_update_fail(1);
4409 do_test_monitor_temporary_update_fail(2);
4410 do_test_monitor_temporary_update_fail(3);
4411 do_test_monitor_temporary_update_fail(4);
4412 do_test_monitor_temporary_update_fail(5);
4416 fn test_monitor_temporary_update_fail_b() {
4417 do_test_monitor_temporary_update_fail(2 | 8);
4418 do_test_monitor_temporary_update_fail(3 | 8);
4419 do_test_monitor_temporary_update_fail(4 | 8);
4420 do_test_monitor_temporary_update_fail(5 | 8);
4424 fn test_monitor_temporary_update_fail_c() {
4425 do_test_monitor_temporary_update_fail(1 | 16);
4426 do_test_monitor_temporary_update_fail(2 | 16);
4427 do_test_monitor_temporary_update_fail(3 | 16);
4428 do_test_monitor_temporary_update_fail(2 | 8 | 16);
4429 do_test_monitor_temporary_update_fail(3 | 8 | 16);
4433 fn test_monitor_update_fail_cs() {
4434 // Tests handling of a monitor update failure when processing an incoming commitment_signed
4435 let mut nodes = create_network(2);
4436 create_announced_chan_between_nodes(&nodes, 0, 1);
4438 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4439 let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4440 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4441 check_added_monitors!(nodes[0], 1);
4443 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4444 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4446 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4447 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg).unwrap_err() {
4448 assert_eq!(err, "Failed to update ChannelMonitor");
4449 } else { panic!(); }
4450 check_added_monitors!(nodes[1], 1);
4451 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4453 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4454 nodes[1].node.test_restore_channel_monitor();
4455 check_added_monitors!(nodes[1], 1);
4456 let responses = nodes[1].node.get_and_clear_pending_msg_events();
4457 assert_eq!(responses.len(), 2);
4459 match responses[0] {
4460 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
4461 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4462 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg).unwrap();
4463 check_added_monitors!(nodes[0], 1);
4465 _ => panic!("Unexpected event"),
4467 match responses[1] {
4468 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
4469 assert!(updates.update_add_htlcs.is_empty());
4470 assert!(updates.update_fulfill_htlcs.is_empty());
4471 assert!(updates.update_fail_htlcs.is_empty());
4472 assert!(updates.update_fail_malformed_htlcs.is_empty());
4473 assert!(updates.update_fee.is_none());
4474 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4476 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4477 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed).unwrap_err() {
4478 assert_eq!(err, "Failed to update ChannelMonitor");
4479 } else { panic!(); }
4480 check_added_monitors!(nodes[0], 1);
4481 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4483 _ => panic!("Unexpected event"),
4486 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4487 nodes[0].node.test_restore_channel_monitor();
4488 check_added_monitors!(nodes[0], 1);
4490 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4491 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa).unwrap();
4492 check_added_monitors!(nodes[1], 1);
4494 expect_pending_htlcs_forwardable!(nodes[1]);
4496 let events = nodes[1].node.get_and_clear_pending_events();
4497 assert_eq!(events.len(), 1);
4499 Event::PaymentReceived { payment_hash, amt } => {
4500 assert_eq!(payment_hash, our_payment_hash);
4501 assert_eq!(amt, 1000000);
4503 _ => panic!("Unexpected event"),
4506 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
4509 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
4510 // Tests handling of a monitor update failure when processing an incoming RAA
4511 let mut nodes = create_network(3);
4512 create_announced_chan_between_nodes(&nodes, 0, 1);
4513 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4515 // Rebalance a bit so that we can send backwards from 2 to 1.
4516 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
4518 // Route a first payment that we'll fail backwards
4519 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4521 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
4522 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, 0));
4523 expect_pending_htlcs_forwardable!(nodes[2]);
4524 check_added_monitors!(nodes[2], 1);
4526 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4527 assert!(updates.update_add_htlcs.is_empty());
4528 assert!(updates.update_fulfill_htlcs.is_empty());
4529 assert_eq!(updates.update_fail_htlcs.len(), 1);
4530 assert!(updates.update_fail_malformed_htlcs.is_empty());
4531 assert!(updates.update_fee.is_none());
4532 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4534 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
4535 check_added_monitors!(nodes[0], 0);
4537 // While the second channel is AwaitingRAA, forward a second payment to get it into the
4539 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4540 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4541 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
4542 check_added_monitors!(nodes[0], 1);
4544 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4545 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4546 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
4548 expect_pending_htlcs_forwardable!(nodes[1]);
4549 check_added_monitors!(nodes[1], 0);
4550 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4552 // Now fail monitor updating.
4553 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4554 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap_err() {
4555 assert_eq!(err, "Failed to update ChannelMonitor");
4556 } else { panic!(); }
4557 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4558 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4559 check_added_monitors!(nodes[1], 1);
4561 // Attempt to forward a third payment but fail due to the second channel being unavailable
4564 let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
4565 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4566 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
4567 check_added_monitors!(nodes[0], 1);
4569 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(()); // We succeed in updating the monitor for the first channel
4570 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4571 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4572 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
4573 check_added_monitors!(nodes[1], 0);
4575 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4576 assert_eq!(events_2.len(), 1);
4577 match events_2.remove(0) {
4578 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4579 assert_eq!(node_id, nodes[0].node.get_our_node_id());
4580 assert!(updates.update_fulfill_htlcs.is_empty());
4581 assert_eq!(updates.update_fail_htlcs.len(), 1);
4582 assert!(updates.update_fail_malformed_htlcs.is_empty());
4583 assert!(updates.update_add_htlcs.is_empty());
4584 assert!(updates.update_fee.is_none());
4586 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4587 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
4589 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4590 assert_eq!(msg_events.len(), 1);
4591 match msg_events[0] {
4592 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
4593 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
4594 assert_eq!(msg.contents.flags & 2, 2); // temp disabled
4596 _ => panic!("Unexpected event"),
4599 let events = nodes[0].node.get_and_clear_pending_events();
4600 assert_eq!(events.len(), 1);
4601 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
4602 assert_eq!(payment_hash, payment_hash_3);
4603 assert!(!rejected_by_dest);
4604 } else { panic!("Unexpected event!"); }
4606 _ => panic!("Unexpected event type!"),
4609 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
4610 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
4611 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
4612 let route = nodes[2].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4613 nodes[2].node.send_payment(route, payment_hash_4).unwrap();
4614 check_added_monitors!(nodes[2], 1);
4616 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
4617 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4618 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg) {
4619 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4620 } else { panic!(); }
4621 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4622 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4623 (Some(payment_preimage_4), Some(payment_hash_4))
4624 } else { (None, None) };
4626 // Restore monitor updating, ensuring we immediately get a fail-back update and a
4627 // update_add update.
4628 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4629 nodes[1].node.test_restore_channel_monitor();
4630 check_added_monitors!(nodes[1], 1);
4631 expect_pending_htlcs_forwardable!(nodes[1]);
4632 check_added_monitors!(nodes[1], 1);
4634 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
4635 if test_ignore_second_cs {
4636 assert_eq!(events_3.len(), 3);
4638 assert_eq!(events_3.len(), 2);
4641 // Note that the ordering of the events for different nodes is non-prescriptive, though the
4642 // ordering of the two events that both go to nodes[2] have to stay in the same order.
4643 let messages_a = match events_3.pop().unwrap() {
4644 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
4645 assert_eq!(node_id, nodes[0].node.get_our_node_id());
4646 assert!(updates.update_fulfill_htlcs.is_empty());
4647 assert_eq!(updates.update_fail_htlcs.len(), 1);
4648 assert!(updates.update_fail_malformed_htlcs.is_empty());
4649 assert!(updates.update_add_htlcs.is_empty());
4650 assert!(updates.update_fee.is_none());
4651 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
4653 _ => panic!("Unexpected event type!"),
4655 let raa = if test_ignore_second_cs {
4656 match events_3.remove(1) {
4657 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
4658 assert_eq!(node_id, nodes[2].node.get_our_node_id());
4661 _ => panic!("Unexpected event"),
4664 let send_event_b = SendEvent::from_event(events_3.remove(0));
4665 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
4667 // Now deliver the new messages...
4669 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0).unwrap();
4670 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
4671 let events_4 = nodes[0].node.get_and_clear_pending_events();
4672 assert_eq!(events_4.len(), 1);
4673 if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events_4[0] {
4674 assert_eq!(payment_hash, payment_hash_1);
4675 assert!(rejected_by_dest);
4676 } else { panic!("Unexpected event!"); }
4678 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]).unwrap();
4679 if test_ignore_second_cs {
4680 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg).unwrap();
4681 check_added_monitors!(nodes[2], 1);
4682 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4683 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap()).unwrap();
4684 check_added_monitors!(nodes[2], 1);
4685 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4686 assert!(bs_cs.update_add_htlcs.is_empty());
4687 assert!(bs_cs.update_fail_htlcs.is_empty());
4688 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
4689 assert!(bs_cs.update_fulfill_htlcs.is_empty());
4690 assert!(bs_cs.update_fee.is_none());
4692 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4693 check_added_monitors!(nodes[1], 1);
4694 let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4695 assert!(as_cs.update_add_htlcs.is_empty());
4696 assert!(as_cs.update_fail_htlcs.is_empty());
4697 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
4698 assert!(as_cs.update_fulfill_htlcs.is_empty());
4699 assert!(as_cs.update_fee.is_none());
4701 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
4702 check_added_monitors!(nodes[1], 1);
4703 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
4705 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
4706 check_added_monitors!(nodes[2], 1);
4707 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4709 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
4710 check_added_monitors!(nodes[2], 1);
4711 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
4713 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa).unwrap();
4714 check_added_monitors!(nodes[1], 1);
4715 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4717 commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
4720 expect_pending_htlcs_forwardable!(nodes[2]);
4722 let events_6 = nodes[2].node.get_and_clear_pending_events();
4723 assert_eq!(events_6.len(), 1);
4725 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
4726 _ => panic!("Unexpected event"),
4729 if test_ignore_second_cs {
4730 expect_pending_htlcs_forwardable!(nodes[1]);
4731 check_added_monitors!(nodes[1], 1);
4733 send_event = SendEvent::from_node(&nodes[1]);
4734 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
4735 assert_eq!(send_event.msgs.len(), 1);
4736 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4737 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
4739 expect_pending_htlcs_forwardable!(nodes[0]);
4741 let events_9 = nodes[0].node.get_and_clear_pending_events();
4742 assert_eq!(events_9.len(), 1);
4744 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
4745 _ => panic!("Unexpected event"),
4747 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
4750 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
4754 fn test_monitor_update_fail_raa() {
4755 do_test_monitor_update_fail_raa(false);
4756 do_test_monitor_update_fail_raa(true);
4760 fn test_monitor_update_fail_reestablish() {
4761 // Simple test for message retransmission after monitor update failure on
4762 // channel_reestablish generating a monitor update (which comes from freeing holding cell
4764 let mut nodes = create_network(3);
4765 create_announced_chan_between_nodes(&nodes, 0, 1);
4766 create_announced_chan_between_nodes(&nodes, 1, 2);
4768 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4770 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4771 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4773 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4774 check_added_monitors!(nodes[2], 1);
4775 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4776 assert!(updates.update_add_htlcs.is_empty());
4777 assert!(updates.update_fail_htlcs.is_empty());
4778 assert!(updates.update_fail_malformed_htlcs.is_empty());
4779 assert!(updates.update_fee.is_none());
4780 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4781 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4782 check_added_monitors!(nodes[1], 1);
4783 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4784 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4786 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4787 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4788 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4790 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4791 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4793 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4795 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap_err() {
4796 assert_eq!(err, "Failed to update ChannelMonitor");
4797 } else { panic!(); }
4798 check_added_monitors!(nodes[1], 1);
4800 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4801 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4803 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4804 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4806 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
4807 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
4809 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4811 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap();
4812 check_added_monitors!(nodes[1], 0);
4813 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4815 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4816 nodes[1].node.test_restore_channel_monitor();
4817 check_added_monitors!(nodes[1], 1);
4819 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4820 assert!(updates.update_add_htlcs.is_empty());
4821 assert!(updates.update_fail_htlcs.is_empty());
4822 assert!(updates.update_fail_malformed_htlcs.is_empty());
4823 assert!(updates.update_fee.is_none());
4824 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4825 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4826 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
4828 let events = nodes[0].node.get_and_clear_pending_events();
4829 assert_eq!(events.len(), 1);
4831 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
4832 _ => panic!("Unexpected event"),
4837 fn test_invalid_channel_announcement() {
4838 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4839 let secp_ctx = Secp256k1::new();
4840 let nodes = create_network(2);
4842 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
4844 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4845 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4846 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4847 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4849 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4851 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
4852 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
4854 let as_network_key = nodes[0].node.get_our_node_id();
4855 let bs_network_key = nodes[1].node.get_our_node_id();
4857 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4859 let mut chan_announcement;
4861 macro_rules! dummy_unsigned_msg {
4863 msgs::UnsignedChannelAnnouncement {
4864 features: msgs::GlobalFeatures::new(),
4865 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4866 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4867 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4868 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4869 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4870 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4871 excess_data: Vec::new(),
4876 macro_rules! sign_msg {
4877 ($unsigned_msg: expr) => {
4878 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
4879 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
4880 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
4881 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4882 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4883 chan_announcement = msgs::ChannelAnnouncement {
4884 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4885 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4886 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4887 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4888 contents: $unsigned_msg
4893 let unsigned_msg = dummy_unsigned_msg!();
4894 sign_msg!(unsigned_msg);
4895 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
4896 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4898 // Configured with Network::Testnet
4899 let mut unsigned_msg = dummy_unsigned_msg!();
4900 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4901 sign_msg!(unsigned_msg);
4902 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
4904 let mut unsigned_msg = dummy_unsigned_msg!();
4905 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
4906 sign_msg!(unsigned_msg);
4907 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
4910 struct VecWriter(Vec<u8>);
4911 impl Writer for VecWriter {
4912 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
4913 self.0.extend_from_slice(buf);
4916 fn size_hint(&mut self, size: usize) {
4917 self.0.reserve_exact(size);
4922 fn test_no_txn_manager_serialize_deserialize() {
4923 let mut nodes = create_network(2);
4925 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
4927 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4929 let nodes_0_serialized = nodes[0].node.encode();
4930 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
4931 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4933 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
4934 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4935 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
4936 assert!(chan_0_monitor_read.is_empty());
4938 let mut nodes_0_read = &nodes_0_serialized[..];
4939 let config = UserConfig::new();
4940 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
4941 let (_, nodes_0_deserialized) = {
4942 let mut channel_monitors = HashMap::new();
4943 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
4944 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4945 default_config: config,
4947 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
4948 monitor: nodes[0].chan_monitor.clone(),
4949 chain_monitor: nodes[0].chain_monitor.clone(),
4950 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4951 logger: Arc::new(test_utils::TestLogger::new()),
4952 channel_monitors: &channel_monitors,
4955 assert!(nodes_0_read.is_empty());
4957 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
4958 nodes[0].node = Arc::new(nodes_0_deserialized);
4959 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
4960 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
4961 assert_eq!(nodes[0].node.list_channels().len(), 1);
4962 check_added_monitors!(nodes[0], 1);
4964 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4965 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4966 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4967 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4969 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4970 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4971 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4972 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4974 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4975 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4976 for node in nodes.iter() {
4977 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
4978 node.router.handle_channel_update(&as_update).unwrap();
4979 node.router.handle_channel_update(&bs_update).unwrap();
4982 send_payment(&nodes[0], &[&nodes[1]], 1000000);
4986 fn test_simple_manager_serialize_deserialize() {
4987 let mut nodes = create_network(2);
4988 create_announced_chan_between_nodes(&nodes, 0, 1);
4990 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4991 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4993 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4995 let nodes_0_serialized = nodes[0].node.encode();
4996 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
4997 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4999 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
5000 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
5001 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
5002 assert!(chan_0_monitor_read.is_empty());
5004 let mut nodes_0_read = &nodes_0_serialized[..];
5005 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5006 let (_, nodes_0_deserialized) = {
5007 let mut channel_monitors = HashMap::new();
5008 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
5009 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5010 default_config: UserConfig::new(),
5012 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5013 monitor: nodes[0].chan_monitor.clone(),
5014 chain_monitor: nodes[0].chain_monitor.clone(),
5015 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5016 logger: Arc::new(test_utils::TestLogger::new()),
5017 channel_monitors: &channel_monitors,
5020 assert!(nodes_0_read.is_empty());
5022 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
5023 nodes[0].node = Arc::new(nodes_0_deserialized);
5024 check_added_monitors!(nodes[0], 1);
5026 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5028 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
5029 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
5033 fn test_manager_serialize_deserialize_inconsistent_monitor() {
5034 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
5035 let mut nodes = create_network(4);
5036 create_announced_chan_between_nodes(&nodes, 0, 1);
5037 create_announced_chan_between_nodes(&nodes, 2, 0);
5038 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
5040 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
5042 // Serialize the ChannelManager here, but the monitor we keep up-to-date
5043 let nodes_0_serialized = nodes[0].node.encode();
5045 route_payment(&nodes[0], &[&nodes[3]], 1000000);
5046 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5047 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5048 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5050 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
5052 let mut node_0_monitors_serialized = Vec::new();
5053 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
5054 let mut writer = VecWriter(Vec::new());
5055 monitor.1.write_for_disk(&mut writer).unwrap();
5056 node_0_monitors_serialized.push(writer.0);
5059 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
5060 let mut node_0_monitors = Vec::new();
5061 for serialized in node_0_monitors_serialized.iter() {
5062 let mut read = &serialized[..];
5063 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
5064 assert!(read.is_empty());
5065 node_0_monitors.push(monitor);
5068 let mut nodes_0_read = &nodes_0_serialized[..];
5069 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5070 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5071 default_config: UserConfig::new(),
5073 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5074 monitor: nodes[0].chan_monitor.clone(),
5075 chain_monitor: nodes[0].chain_monitor.clone(),
5076 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5077 logger: Arc::new(test_utils::TestLogger::new()),
5078 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
5080 assert!(nodes_0_read.is_empty());
5082 { // Channel close should result in a commitment tx and an HTLC tx
5083 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5084 assert_eq!(txn.len(), 2);
5085 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
5086 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
5089 for monitor in node_0_monitors.drain(..) {
5090 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
5091 check_added_monitors!(nodes[0], 1);
5093 nodes[0].node = Arc::new(nodes_0_deserialized);
5095 // nodes[1] and nodes[2] have no lost state with nodes[0]...
5096 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5097 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5098 //... and we can even still claim the payment!
5099 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
5101 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
5102 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5103 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
5104 if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
5105 assert_eq!(msg.channel_id, channel_id);
5106 } else { panic!("Unexpected result"); }
5109 macro_rules! check_spendable_outputs {
5110 ($node: expr, $der_idx: expr) => {
5112 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
5113 let mut txn = Vec::new();
5114 for event in events {
5116 Event::SpendableOutputs { ref outputs } => {
5117 for outp in outputs {
5119 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
5121 previous_output: outpoint.clone(),
5122 script_sig: Script::new(),
5124 witness: Vec::new(),
5127 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5128 value: output.value,
5130 let mut spend_tx = Transaction {
5136 let secp_ctx = Secp256k1::new();
5137 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
5138 let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
5139 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5140 let remotesig = secp_ctx.sign(&sighash, key);
5141 spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
5142 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5143 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
5146 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
5148 previous_output: outpoint.clone(),
5149 script_sig: Script::new(),
5150 sequence: *to_self_delay as u32,
5151 witness: Vec::new(),
5154 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5155 value: output.value,
5157 let mut spend_tx = Transaction {
5163 let secp_ctx = Secp256k1::new();
5164 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
5165 let local_delaysig = secp_ctx.sign(&sighash, key);
5166 spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
5167 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5168 spend_tx.input[0].witness.push(vec!(0));
5169 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
5172 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
5173 let secp_ctx = Secp256k1::new();
5175 previous_output: outpoint.clone(),
5176 script_sig: Script::new(),
5178 witness: Vec::new(),
5181 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5182 value: output.value,
5184 let mut spend_tx = Transaction {
5188 output: vec![outp.clone()],
5191 match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
5193 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
5195 Err(_) => panic!("Your RNG is busted"),
5198 Err(_) => panic!("Your rng is busted"),
5201 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
5202 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
5203 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5204 let sig = secp_ctx.sign(&sighash, &secret.secret_key);
5205 spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
5206 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5207 spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
5213 _ => panic!("Unexpected event"),
5222 fn test_claim_sizeable_push_msat() {
5223 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
5224 let nodes = create_network(2);
5226 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5227 nodes[1].node.force_close_channel(&chan.2);
5228 check_closed_broadcast!(nodes[1]);
5229 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5230 assert_eq!(node_txn.len(), 1);
5231 check_spends!(node_txn[0], chan.3.clone());
5232 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
5234 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5235 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5236 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5237 assert_eq!(spend_txn.len(), 1);
5238 check_spends!(spend_txn[0], node_txn[0].clone());
5242 fn test_claim_on_remote_sizeable_push_msat() {
5243 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5244 // to_remote output is encumbered by a P2WPKH
5246 let nodes = create_network(2);
5248 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5249 nodes[0].node.force_close_channel(&chan.2);
5250 check_closed_broadcast!(nodes[0]);
5252 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5253 assert_eq!(node_txn.len(), 1);
5254 check_spends!(node_txn[0], chan.3.clone());
5255 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
5257 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5258 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5259 check_closed_broadcast!(nodes[1]);
5260 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5261 assert_eq!(spend_txn.len(), 2);
5262 assert_eq!(spend_txn[0], spend_txn[1]);
5263 check_spends!(spend_txn[0], node_txn[0].clone());
5267 fn test_claim_on_remote_revoked_sizeable_push_msat() {
5268 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5269 // to_remote output is encumbered by a P2WPKH
5271 let nodes = create_network(2);
5273 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
5274 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5275 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5276 assert_eq!(revoked_local_txn[0].input.len(), 1);
5277 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
5279 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5280 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5281 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5282 check_closed_broadcast!(nodes[1]);
5284 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5285 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5286 assert_eq!(spend_txn.len(), 4);
5287 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
5288 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
5289 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
5290 check_spends!(spend_txn[1], node_txn[0].clone());
5294 fn test_static_spendable_outputs_preimage_tx() {
5295 let nodes = create_network(2);
5297 // Create some initial channels
5298 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5300 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5302 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5303 assert_eq!(commitment_tx[0].input.len(), 1);
5304 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5306 // Settle A's commitment tx on B's chain
5307 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5308 assert!(nodes[1].node.claim_funds(payment_preimage));
5309 check_added_monitors!(nodes[1], 1);
5310 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
5311 let events = nodes[1].node.get_and_clear_pending_msg_events();
5313 MessageSendEvent::UpdateHTLCs { .. } => {},
5314 _ => panic!("Unexpected event"),
5317 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5318 _ => panic!("Unexepected event"),
5321 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5322 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
5323 check_spends!(node_txn[0], commitment_tx[0].clone());
5324 assert_eq!(node_txn[0], node_txn[2]);
5325 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5326 check_spends!(node_txn[1], chan_1.3.clone());
5328 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
5329 assert_eq!(spend_txn.len(), 2);
5330 assert_eq!(spend_txn[0], spend_txn[1]);
5331 check_spends!(spend_txn[0], node_txn[0].clone());
5335 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5336 let nodes = create_network(2);
5338 // Create some initial channels
5339 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5341 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5342 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5343 assert_eq!(revoked_local_txn[0].input.len(), 1);
5344 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5346 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5348 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5349 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5350 check_closed_broadcast!(nodes[1]);
5352 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5353 assert_eq!(node_txn.len(), 3);
5354 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
5355 assert_eq!(node_txn[0].input.len(), 2);
5356 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5358 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5359 assert_eq!(spend_txn.len(), 2);
5360 assert_eq!(spend_txn[0], spend_txn[1]);
5361 check_spends!(spend_txn[0], node_txn[0].clone());
5365 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5366 let nodes = create_network(2);
5368 // Create some initial channels
5369 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5371 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5372 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5373 assert_eq!(revoked_local_txn[0].input.len(), 1);
5374 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5376 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5378 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5379 // A will generate HTLC-Timeout from revoked commitment tx
5380 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5381 check_closed_broadcast!(nodes[0]);
5383 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5384 assert_eq!(revoked_htlc_txn.len(), 3);
5385 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5386 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5387 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5388 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5389 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
5391 // B will generate justice tx from A's revoked commitment/HTLC tx
5392 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5393 check_closed_broadcast!(nodes[1]);
5395 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5396 assert_eq!(node_txn.len(), 4);
5397 assert_eq!(node_txn[3].input.len(), 1);
5398 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5400 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5401 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5402 assert_eq!(spend_txn.len(), 3);
5403 assert_eq!(spend_txn[0], spend_txn[1]);
5404 check_spends!(spend_txn[0], node_txn[0].clone());
5405 check_spends!(spend_txn[2], node_txn[3].clone());
5409 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5410 let nodes = create_network(2);
5412 // Create some initial channels
5413 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5415 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5416 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5417 assert_eq!(revoked_local_txn[0].input.len(), 1);
5418 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5420 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5422 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5423 // B will generate HTLC-Success from revoked commitment tx
5424 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5425 check_closed_broadcast!(nodes[1]);
5426 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5428 assert_eq!(revoked_htlc_txn.len(), 3);
5429 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5430 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5431 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5432 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5434 // A will generate justice tx from B's revoked commitment/HTLC tx
5435 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5436 check_closed_broadcast!(nodes[0]);
5438 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5439 assert_eq!(node_txn.len(), 4);
5440 assert_eq!(node_txn[3].input.len(), 1);
5441 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5443 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5444 let spend_txn = check_spendable_outputs!(nodes[0], 1);
5445 assert_eq!(spend_txn.len(), 5);
5446 assert_eq!(spend_txn[0], spend_txn[2]);
5447 assert_eq!(spend_txn[1], spend_txn[3]);
5448 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
5449 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
5450 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
5454 fn test_onchain_to_onchain_claim() {
5455 // Test that in case of channel closure, we detect the state of output thanks to
5456 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5457 // First, have C claim an HTLC against its own latest commitment transaction.
5458 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5460 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5463 let nodes = create_network(3);
5465 // Create some initial channels
5466 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5467 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5469 // Rebalance the network a bit by relaying one payment through all the channels ...
5470 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5471 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5473 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5474 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5475 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5476 check_spends!(commitment_tx[0], chan_2.3.clone());
5477 nodes[2].node.claim_funds(payment_preimage);
5478 check_added_monitors!(nodes[2], 1);
5479 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5480 assert!(updates.update_add_htlcs.is_empty());
5481 assert!(updates.update_fail_htlcs.is_empty());
5482 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5483 assert!(updates.update_fail_malformed_htlcs.is_empty());
5485 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5486 check_closed_broadcast!(nodes[2]);
5488 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5489 assert_eq!(c_txn.len(), 3);
5490 assert_eq!(c_txn[0], c_txn[2]);
5491 assert_eq!(commitment_tx[0], c_txn[1]);
5492 check_spends!(c_txn[1], chan_2.3.clone());
5493 check_spends!(c_txn[2], c_txn[1].clone());
5494 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5495 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5496 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5497 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5499 // So we broadcast C's commitment tx and HTLC-Success on B's chain, we should successfully be able to extract preimage and update downstream monitor
5500 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5502 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5503 assert_eq!(b_txn.len(), 4);
5504 assert_eq!(b_txn[0], b_txn[3]);
5505 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5506 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5507 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5508 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5509 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5510 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5511 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5512 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5513 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5516 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5517 check_added_monitors!(nodes[1], 1);
5518 match msg_events[0] {
5519 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5520 _ => panic!("Unexpected event"),
5522 match msg_events[1] {
5523 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
5524 assert!(update_add_htlcs.is_empty());
5525 assert!(update_fail_htlcs.is_empty());
5526 assert_eq!(update_fulfill_htlcs.len(), 1);
5527 assert!(update_fail_malformed_htlcs.is_empty());
5528 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5530 _ => panic!("Unexpected event"),
5532 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5533 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5534 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5535 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5536 assert_eq!(b_txn.len(), 3);
5537 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
5538 assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
5539 check_spends!(b_txn[0], commitment_tx[0].clone());
5540 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5541 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5542 assert_eq!(b_txn[2].lock_time, 0); // Success tx
5544 check_closed_broadcast!(nodes[1]);
5548 fn test_duplicate_payment_hash_one_failure_one_success() {
5549 // Topology : A --> B --> C
5550 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5551 let mut nodes = create_network(3);
5553 create_announced_chan_between_nodes(&nodes, 0, 1);
5554 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5556 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5557 *nodes[0].network_payment_count.borrow_mut() -= 1;
5558 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5560 let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5561 assert_eq!(commitment_txn[0].input.len(), 1);
5562 check_spends!(commitment_txn[0], chan_2.3.clone());
5564 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5565 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5566 check_closed_broadcast!(nodes[1]);
5568 let htlc_timeout_tx;
5569 { // Extract one of the two HTLC-Timeout transaction
5570 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5571 assert_eq!(node_txn.len(), 7);
5572 assert_eq!(node_txn[0], node_txn[5]);
5573 assert_eq!(node_txn[1], node_txn[6]);
5574 check_spends!(node_txn[0], commitment_txn[0].clone());
5575 assert_eq!(node_txn[0].input.len(), 1);
5576 check_spends!(node_txn[1], commitment_txn[0].clone());
5577 assert_eq!(node_txn[1].input.len(), 1);
5578 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5579 check_spends!(node_txn[2], chan_2.3.clone());
5580 check_spends!(node_txn[3], node_txn[2].clone());
5581 check_spends!(node_txn[4], node_txn[2].clone());
5582 htlc_timeout_tx = node_txn[1].clone();
5585 nodes[2].node.claim_funds(our_payment_preimage);
5586 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5587 check_added_monitors!(nodes[2], 2);
5588 let events = nodes[2].node.get_and_clear_pending_msg_events();
5590 MessageSendEvent::UpdateHTLCs { .. } => {},
5591 _ => panic!("Unexpected event"),
5594 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5595 _ => panic!("Unexepected event"),
5597 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5598 assert_eq!(htlc_success_txn.len(), 5);
5599 check_spends!(htlc_success_txn[2], chan_2.3.clone());
5600 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5601 assert_eq!(htlc_success_txn[0].input.len(), 1);
5602 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5603 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5604 assert_eq!(htlc_success_txn[1].input.len(), 1);
5605 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5606 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5607 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
5608 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
5610 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5611 expect_pending_htlcs_forwardable!(nodes[1]);
5612 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5613 assert!(htlc_updates.update_add_htlcs.is_empty());
5614 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5615 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5616 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5617 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5618 check_added_monitors!(nodes[1], 1);
5620 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
5621 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5623 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5624 let events = nodes[0].node.get_and_clear_pending_msg_events();
5625 assert_eq!(events.len(), 1);
5627 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5629 _ => { panic!("Unexpected event"); }
5632 let events = nodes[0].node.get_and_clear_pending_events();
5634 Event::PaymentFailed { ref payment_hash, .. } => {
5635 assert_eq!(*payment_hash, duplicate_payment_hash);
5637 _ => panic!("Unexpected event"),
5640 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5641 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5642 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5643 assert!(updates.update_add_htlcs.is_empty());
5644 assert!(updates.update_fail_htlcs.is_empty());
5645 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5646 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5647 assert!(updates.update_fail_malformed_htlcs.is_empty());
5648 check_added_monitors!(nodes[1], 1);
5650 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
5651 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5653 let events = nodes[0].node.get_and_clear_pending_events();
5655 Event::PaymentSent { ref payment_preimage } => {
5656 assert_eq!(*payment_preimage, our_payment_preimage);
5658 _ => panic!("Unexpected event"),
5663 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5664 let nodes = create_network(2);
5666 // Create some initial channels
5667 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5669 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5670 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5671 assert_eq!(local_txn[0].input.len(), 1);
5672 check_spends!(local_txn[0], chan_1.3.clone());
5674 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5675 nodes[1].node.claim_funds(payment_preimage);
5676 check_added_monitors!(nodes[1], 1);
5677 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5678 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5679 let events = nodes[1].node.get_and_clear_pending_msg_events();
5681 MessageSendEvent::UpdateHTLCs { .. } => {},
5682 _ => panic!("Unexpected event"),
5685 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5686 _ => panic!("Unexepected event"),
5688 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5689 assert_eq!(node_txn[0].input.len(), 1);
5690 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5691 check_spends!(node_txn[0], local_txn[0].clone());
5693 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5694 let spend_txn = check_spendable_outputs!(nodes[1], 1);
5695 assert_eq!(spend_txn.len(), 2);
5696 check_spends!(spend_txn[0], node_txn[0].clone());
5697 check_spends!(spend_txn[1], node_txn[2].clone());
5701 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5702 let nodes = create_network(2);
5704 // Create some initial channels
5705 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5707 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5708 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5709 assert_eq!(local_txn[0].input.len(), 1);
5710 check_spends!(local_txn[0], chan_1.3.clone());
5712 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5713 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5714 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5715 check_closed_broadcast!(nodes[0]);
5717 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5718 assert_eq!(node_txn[0].input.len(), 1);
5719 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5720 check_spends!(node_txn[0], local_txn[0].clone());
5722 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5723 let spend_txn = check_spendable_outputs!(nodes[0], 1);
5724 assert_eq!(spend_txn.len(), 8);
5725 assert_eq!(spend_txn[0], spend_txn[2]);
5726 assert_eq!(spend_txn[0], spend_txn[4]);
5727 assert_eq!(spend_txn[0], spend_txn[6]);
5728 assert_eq!(spend_txn[1], spend_txn[3]);
5729 assert_eq!(spend_txn[1], spend_txn[5]);
5730 assert_eq!(spend_txn[1], spend_txn[7]);
5731 check_spends!(spend_txn[0], local_txn[0].clone());
5732 check_spends!(spend_txn[1], node_txn[0].clone());
5736 fn test_static_output_closing_tx() {
5737 let nodes = create_network(2);
5739 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5741 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5742 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5744 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5745 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
5746 let spend_txn = check_spendable_outputs!(nodes[0], 2);
5747 assert_eq!(spend_txn.len(), 1);
5748 check_spends!(spend_txn[0], closing_tx.clone());
5750 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
5751 let spend_txn = check_spendable_outputs!(nodes[1], 2);
5752 assert_eq!(spend_txn.len(), 1);
5753 check_spends!(spend_txn[0], closing_tx);
5756 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5757 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5760 run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5764 // 0: node1 fail backward
5765 // 1: final node fail backward
5766 // 2: payment completed but the user reject the payment
5767 // 3: final node fail backward (but tamper onion payloads from node0)
5768 // 100: trigger error in the intermediate node and tamper returnning fail_htlc
5769 // 200: trigger error in the final node and tamper returnning fail_htlc
5770 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5771 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5772 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5775 use ln::msgs::HTLCFailChannelUpdate;
5777 // reset block height
5778 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5779 for ix in 0..nodes.len() {
5780 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
5783 macro_rules! expect_event {
5784 ($node: expr, $event_type: path) => {{
5785 let events = $node.node.get_and_clear_pending_events();
5786 assert_eq!(events.len(), 1);
5788 $event_type { .. } => {},
5789 _ => panic!("Unexpected event"),
5794 macro_rules! expect_htlc_forward {
5796 expect_event!($node, Event::PendingHTLCsForwardable);
5797 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
5798 $node.node.process_pending_htlc_forwards();
5802 // 0 ~~> 2 send payment
5803 nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
5804 check_added_monitors!(nodes[0], 1);
5805 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5806 // temper update_add (0 => 1)
5807 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5808 if test_case == 0 || test_case == 3 || test_case == 100 {
5809 callback_msg(&mut update_add_0);
5812 // 0 => 1 update_add & CS
5813 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
5814 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5816 let update_1_0 = match test_case {
5817 0|100 => { // intermediate node failure; fail backward to 0
5818 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5819 assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5822 1|2|3|200 => { // final node failure; forwarding to 2
5823 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5825 if test_case != 200 {
5828 expect_htlc_forward!(&nodes[1]);
5830 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5831 check_added_monitors!(&nodes[1], 1);
5832 assert_eq!(update_1.update_add_htlcs.len(), 1);
5833 // tamper update_add (1 => 2)
5834 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5835 if test_case != 3 && test_case != 200 {
5836 callback_msg(&mut update_add_1);
5840 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
5841 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5843 if test_case == 2 || test_case == 200 {
5844 expect_htlc_forward!(&nodes[2]);
5845 expect_event!(&nodes[2], Event::PaymentReceived);
5847 expect_pending_htlcs_forwardable!(nodes[2]);
5850 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5851 if test_case == 2 || test_case == 200 {
5852 check_added_monitors!(&nodes[2], 1);
5854 assert!(update_2_1.update_fail_htlcs.len() == 1);
5856 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5857 if test_case == 200 {
5858 callback_fail(&mut fail_msg);
5862 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
5863 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5865 // backward fail on 1
5866 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5867 assert!(update_1_0.update_fail_htlcs.len() == 1);
5870 _ => unreachable!(),
5873 // 1 => 0 commitment_signed_dance
5874 if update_1_0.update_fail_htlcs.len() > 0 {
5875 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5876 if test_case == 100 {
5877 callback_fail(&mut fail_msg);
5879 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
5881 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
5884 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5886 let events = nodes[0].node.get_and_clear_pending_events();
5887 assert_eq!(events.len(), 1);
5888 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5889 assert_eq!(*rejected_by_dest, !expected_retryable);
5890 assert_eq!(*error_code, expected_error_code);
5892 panic!("Uexpected event");
5895 let events = nodes[0].node.get_and_clear_pending_msg_events();
5896 if expected_channel_update.is_some() {
5897 assert_eq!(events.len(), 1);
5899 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5901 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5902 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5903 panic!("channel_update not found!");
5906 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5907 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5908 assert!(*short_channel_id == *expected_short_channel_id);
5909 assert!(*is_permanent == *expected_is_permanent);
5911 panic!("Unexpected message event");
5914 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5915 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5916 assert!(*node_id == *expected_node_id);
5917 assert!(*is_permanent == *expected_is_permanent);
5919 panic!("Unexpected message event");
5924 _ => panic!("Unexpected message event"),
5927 assert_eq!(events.len(), 0);
5931 impl msgs::ChannelUpdate {
5932 fn dummy() -> msgs::ChannelUpdate {
5933 use secp256k1::ffi::Signature as FFISignature;
5934 use secp256k1::Signature;
5935 msgs::ChannelUpdate {
5936 signature: Signature::from(FFISignature::new()),
5937 contents: msgs::UnsignedChannelUpdate {
5938 chain_hash: Sha256dHash::from_data(&vec![0u8][..]),
5939 short_channel_id: 0,
5942 cltv_expiry_delta: 0,
5943 htlc_minimum_msat: 0,
5945 fee_proportional_millionths: 0,
5946 excess_data: vec![],
5953 fn test_onion_failure() {
5954 use ln::msgs::ChannelUpdate;
5955 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5958 const BADONION: u16 = 0x8000;
5959 const PERM: u16 = 0x4000;
5960 const NODE: u16 = 0x2000;
5961 const UPDATE: u16 = 0x1000;
5963 let mut nodes = create_network(3);
5964 for node in nodes.iter() {
5965 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&Secp256k1::without_caps(), &[3; 32]).unwrap());
5967 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
5968 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5969 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5971 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
5973 // intermediate node failure
5974 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5975 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
5976 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5977 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5978 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5979 onion_payloads[0].realm = 3;
5980 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
5981 }, ||{}, true, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5983 // final node failure
5984 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5985 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
5986 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5987 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5988 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5989 onion_payloads[1].realm = 3;
5990 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
5991 }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5993 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5994 // receiving simulated fail messages
5995 // intermediate node failure
5996 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5998 msg.amount_msat -= 1;
6000 // and tamper returing error message
6001 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6002 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6003 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6004 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
6006 // final node failure
6007 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6008 // and tamper returing error message
6009 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6010 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6011 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6013 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6014 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
6016 // intermediate node failure
6017 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6018 msg.amount_msat -= 1;
6020 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6021 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6022 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6023 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6025 // final node failure
6026 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6027 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6028 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6029 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6031 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6032 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6034 // intermediate node failure
6035 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6036 msg.amount_msat -= 1;
6038 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6039 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6040 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6042 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6043 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6045 // final node failure
6046 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6047 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6048 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6049 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6051 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6052 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6054 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6055 Some(BADONION|PERM|4), None);
6057 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6058 Some(BADONION|PERM|5), None);
6060 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6061 Some(BADONION|PERM|6), None);
6063 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6064 msg.amount_msat -= 1;
6066 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6067 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6068 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6069 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6071 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6072 msg.amount_msat -= 1;
6074 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6075 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6076 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6077 // short_channel_id from the processing node
6078 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6080 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6081 msg.amount_msat -= 1;
6083 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6084 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6085 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6086 // short_channel_id from the processing node
6087 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6089 let mut bogus_route = route.clone();
6090 bogus_route.hops[1].short_channel_id -= 1;
6091 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6092 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
6094 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6095 let mut bogus_route = route.clone();
6096 let route_len = bogus_route.hops.len();
6097 bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
6098 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6100 //TODO: with new config API, we will be able to generate both valid and
6101 //invalid channel_update cases.
6102 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6103 msg.amount_msat -= 1;
6104 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6106 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6107 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6108 msg.cltv_expiry -= 1;
6109 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6111 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6112 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6113 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6114 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6115 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6117 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6118 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6119 }, false, Some(PERM|15), None);
6121 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6122 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6123 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6124 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6125 }, || {}, true, Some(17), None);
6127 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6128 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6129 for f in pending_forwards.iter_mut() {
6131 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6132 forward_info.outgoing_cltv_value += 1,
6137 }, true, Some(18), None);
6139 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6140 // violate amt_to_forward > msg.amount_msat
6141 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6142 for f in pending_forwards.iter_mut() {
6144 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6145 forward_info.amt_to_forward -= 1,
6150 }, true, Some(19), None);
6152 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6153 // disconnect event to the channel between nodes[1] ~ nodes[2]
6154 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6155 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6156 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6157 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6159 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6160 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6161 let mut route = route.clone();
6163 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
6164 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6165 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
6166 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6167 msg.cltv_expiry = htlc_cltv;
6168 msg.onion_routing_packet = onion_packet;
6169 }, ||{}, true, Some(21), None);