_ Git - rust-lightning/blob - src/ln/functional_tests.rs

   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.
   4
   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,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};
  14 use ln::onion_utils;
  15 use ln::router::{Route, RouteHop, Router};
  16 use ln::msgs;
  17 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate};
  18 use util::test_utils;
  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;
  24
  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;
  35
  36 use bitcoin_hashes::sha256::Hash as Sha256;
  37 use bitcoin_hashes::Hash;
  38
  39 use secp256k1::{Secp256k1, Message};
  40 use secp256k1::key::{PublicKey,SecretKey};
  41
  42 use rand::{thread_rng,Rng};
  43
  44 use std::cell::RefCell;
  45 use std::collections::{BTreeSet, HashMap, HashSet};
  46 use std::default::Default;
  47 use std::rc::Rc;
  48 use std::sync::{Arc, Mutex};
  49 use std::sync::atomic::Ordering;
  50 use std::time::Instant;
  51 use std::mem;
  52
  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]);
  57         for i in 2..100 {
  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]);
  60         }
  61 }
  62
  63 struct Node {
  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>,
  69         router: Router,
  70         node_seed: [u8; 32],
  71         network_payment_count: Rc<RefCell<u8>>,
  72         network_chan_count: Rc<RefCell<u32>>,
  73 }
  74 impl Drop for Node {
  75         fn drop(&mut self) {
  76                 if !::std::thread::panicking() {
  77                         // Check that we processed all pending events
  78                         assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
  79                         assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
  80                         assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
  81                 }
  82         }
  83 }
  84
  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)
  87 }
  88
  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)
  93 }
  94
  95 macro_rules! get_revoke_commit_msgs {
  96         ($node: expr, $node_id: expr) => {
  97                 {
  98                         let events = $node.node.get_and_clear_pending_msg_events();
  99                         assert_eq!(events.len(), 2);
 100                         (match events[0] {
 101                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 102                                         assert_eq!(*node_id, $node_id);
 103                                         (*msg).clone()
 104                                 },
 105                                 _ => panic!("Unexpected event"),
 106                         }, match events[1] {
 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()
 115                                 },
 116                                 _ => panic!("Unexpected event"),
 117                         })
 118                 }
 119         }
 120 }
 121
 122 macro_rules! get_event_msg {
 123         ($node: expr, $event_type: path, $node_id: expr) => {
 124                 {
 125                         let events = $node.node.get_and_clear_pending_msg_events();
 126                         assert_eq!(events.len(), 1);
 127                         match events[0] {
 128                                 $event_type { ref node_id, ref msg } => {
 129                                         assert_eq!(*node_id, $node_id);
 130                                         (*msg).clone()
 131                                 },
 132                                 _ => panic!("Unexpected event"),
 133                         }
 134                 }
 135         }
 136 }
 137
 138 macro_rules! get_htlc_update_msgs {
 139         ($node: expr, $node_id: expr) => {
 140                 {
 141                         let events = $node.node.get_and_clear_pending_msg_events();
 142                         assert_eq!(events.len(), 1);
 143                         match events[0] {
 144                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 145                                         assert_eq!(*node_id, $node_id);
 146                                         (*updates).clone()
 147                                 },
 148                                 _ => panic!("Unexpected event"),
 149                         }
 150                 }
 151         }
 152 }
 153
 154 macro_rules! get_feerate {
 155         ($node: expr, $channel_id: expr) => {
 156                 {
 157                         let chan_lock = $node.node.channel_state.lock().unwrap();
 158                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
 159                         chan.get_feerate()
 160                 }
 161         }
 162 }
 163
 164
 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();
 169
 170         let chan_id = *node_a.network_chan_count.borrow();
 171         let tx;
 172         let funding_output;
 173
 174         let events_2 = node_a.node.get_and_clear_pending_events();
 175         assert_eq!(events_2.len(), 1);
 176         match events_2[0] {
 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);
 180
 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(),
 183                         }]};
 184                         funding_output = OutPoint::new(tx.txid(), 0);
 185
 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();
 191                 },
 192                 _ => panic!("Unexpected event"),
 193         }
 194
 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();
 196         {
 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();
 201         }
 202
 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();
 204         {
 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();
 209         }
 210
 211         let events_4 = node_a.node.get_and_clear_pending_events();
 212         assert_eq!(events_4.len(), 1);
 213         match events_4[0] {
 214                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 215                         assert_eq!(user_channel_id, 42);
 216                         assert_eq!(*funding_txo, funding_output);
 217                 },
 218                 _ => panic!("Unexpected event"),
 219         };
 220
 221         tx
 222 }
 223
 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();
 227
 228         let channel_id;
 229
 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());
 237                         msg.clone()
 238                 },
 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());
 243                         msg.clone()
 244                 },
 245                 _ => panic!("Unexpected event"),
 246         }), channel_id)
 247 }
 248
 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);
 252         (msgs, chan_id, tx)
 253 }
 254
 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();
 259
 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 } => {
 264                         (msg, update_msg)
 265                 },
 266                 _ => panic!("Unexpected event"),
 267         };
 268
 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);
 277                         update_msg
 278                 },
 279                 _ => panic!("Unexpected event"),
 280         };
 281
 282         *node_a.network_chan_count.borrow_mut() += 1;
 283
 284         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 285 }
 286
 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)
 289 }
 290
 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);
 293         for node in nodes {
 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();
 297         }
 298         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 299 }
 300
 301 macro_rules! check_spends {
 302         ($tx: expr, $spends_tx: expr) => {
 303                 {
 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();
 308                 }
 309         }
 310 }
 311
 312 macro_rules! get_closing_signed_broadcast {
 313         ($node: expr, $dest_pubkey: expr) => {
 314                 {
 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);
 320                                         msg.clone()
 321                                 },
 322                                 _ => panic!("Unexpected event"),
 323                         }, if events.len() == 2 {
 324                                 match events[0] {
 325                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 326                                                 assert_eq!(*node_id, $dest_pubkey);
 327                                                 Some(msg.clone())
 328                                         },
 329                                         _ => panic!("Unexpected event"),
 330                                 }
 331                         } else { None })
 332                 }
 333         }
 334 }
 335
 336 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) {
 337         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) };
 338         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 339         let (tx_a, tx_b);
 340
 341         node_a.close_channel(channel_id).unwrap();
 342         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
 343
 344         let events_1 = node_b.get_and_clear_pending_msg_events();
 345         assert!(events_1.len() >= 1);
 346         let shutdown_b = match events_1[0] {
 347                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 348                         assert_eq!(node_id, &node_a.get_our_node_id());
 349                         msg.clone()
 350                 },
 351                 _ => panic!("Unexpected event"),
 352         };
 353
 354         let closing_signed_b = if !close_inbound_first {
 355                 assert_eq!(events_1.len(), 1);
 356                 None
 357         } else {
 358                 Some(match events_1[1] {
 359                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 360                                 assert_eq!(node_id, &node_a.get_our_node_id());
 361                                 msg.clone()
 362                         },
 363                         _ => panic!("Unexpected event"),
 364                 })
 365         };
 366
 367         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
 368         let (as_update, bs_update) = if close_inbound_first {
 369                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 370                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
 371                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 372                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 373                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 374
 375                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
 376                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 377                 assert!(none_b.is_none());
 378                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 379                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 380                 (as_update, bs_update)
 381         } else {
 382                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 383
 384                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
 385                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 386                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 387                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 388
 389                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
 390                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 391                 assert!(none_a.is_none());
 392                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 393                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 394                 (as_update, bs_update)
 395         };
 396         assert_eq!(tx_a, tx_b);
 397         check_spends!(tx_a, funding_tx);
 398
 399         (as_update, bs_update, tx_a)
 400 }
 401
 402 struct SendEvent {
 403         node_id: PublicKey,
 404         msgs: Vec<msgs::UpdateAddHTLC>,
 405         commitment_msg: msgs::CommitmentSigned,
 406 }
 407 impl SendEvent {
 408         fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 409                 assert!(updates.update_fulfill_htlcs.is_empty());
 410                 assert!(updates.update_fail_htlcs.is_empty());
 411                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 412                 assert!(updates.update_fee.is_none());
 413                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 414         }
 415
 416         fn from_event(event: MessageSendEvent) -> SendEvent {
 417                 match event {
 418                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 419                         _ => panic!("Unexpected event type!"),
 420                 }
 421         }
 422
 423         fn from_node(node: &Node) -> SendEvent {
 424                 let mut events = node.node.get_and_clear_pending_msg_events();
 425                 assert_eq!(events.len(), 1);
 426                 SendEvent::from_event(events.pop().unwrap())
 427         }
 428 }
 429
 430 macro_rules! check_added_monitors {
 431         ($node: expr, $count: expr) => {
 432                 {
 433                         let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
 434                         assert_eq!(added_monitors.len(), $count);
 435                         added_monitors.clear();
 436                 }
 437         }
 438 }
 439
 440 macro_rules! commitment_signed_dance {
 441         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 442                 {
 443                         check_added_monitors!($node_a, 0);
 444                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 445                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
 446                         check_added_monitors!($node_a, 1);
 447                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 448                 }
 449         };
 450         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 451                 {
 452                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 453                         check_added_monitors!($node_b, 0);
 454                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 455                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
 456                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 457                         check_added_monitors!($node_b, 1);
 458                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
 459                         let (bs_revoke_and_ack, extra_msg_option) = {
 460                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 461                                 assert!(events.len() <= 2);
 462                                 (match events[0] {
 463                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 464                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 465                                                 (*msg).clone()
 466                                         },
 467                                         _ => panic!("Unexpected event"),
 468                                 }, events.get(1).map(|e| e.clone()))
 469                         };
 470                         check_added_monitors!($node_b, 1);
 471                         if $fail_backwards {
 472                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 473                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 474                         }
 475                         (extra_msg_option, bs_revoke_and_ack)
 476                 }
 477         };
 478         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 479                 {
 480                         check_added_monitors!($node_a, 0);
 481                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 482                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
 483                         check_added_monitors!($node_a, 1);
 484                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 485                         assert!(extra_msg_option.is_none());
 486                         bs_revoke_and_ack
 487                 }
 488         };
 489         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 490                 {
 491                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 492                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
 493                         {
 494                                 let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
 495                                 if $fail_backwards {
 496                                         assert_eq!(added_monitors.len(), 2);
 497                                         assert!(added_monitors[0].0 != added_monitors[1].0);
 498                                 } else {
 499                                         assert_eq!(added_monitors.len(), 1);
 500                                 }
 501                                 added_monitors.clear();
 502                         }
 503                         extra_msg_option
 504                 }
 505         };
 506         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 507                 {
 508                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 509                 }
 510         };
 511         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 512                 {
 513                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 514                         if $fail_backwards {
 515                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 516                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 517                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 518                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 519                                 } else { panic!("Unexpected event"); }
 520                         } else {
 521                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 522                         }
 523                 }
 524         }
 525 }
 526
 527 macro_rules! get_payment_preimage_hash {
 528         ($node: expr) => {
 529                 {
 530                         let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
 531                         *$node.network_payment_count.borrow_mut() += 1;
 532                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 533                         (payment_preimage, payment_hash)
 534                 }
 535         }
 536 }
 537
 538 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
 539         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 540
 541         let mut payment_event = {
 542                 origin_node.node.send_payment(route, our_payment_hash).unwrap();
 543                 check_added_monitors!(origin_node, 1);
 544
 545                 let mut events = origin_node.node.get_and_clear_pending_msg_events();
 546                 assert_eq!(events.len(), 1);
 547                 SendEvent::from_event(events.remove(0))
 548         };
 549         let mut prev_node = origin_node;
 550
 551         for (idx, &node) in expected_route.iter().enumerate() {
 552                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
 553
 554                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 555                 check_added_monitors!(node, 0);
 556                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
 557
 558                 let events_1 = node.node.get_and_clear_pending_events();
 559                 assert_eq!(events_1.len(), 1);
 560                 match events_1[0] {
 561                         Event::PendingHTLCsForwardable { .. } => { },
 562                         _ => panic!("Unexpected event"),
 563                 };
 564
 565                 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
 566                 node.node.process_pending_htlc_forwards();
 567
 568                 if idx == expected_route.len() - 1 {
 569                         let events_2 = node.node.get_and_clear_pending_events();
 570                         assert_eq!(events_2.len(), 1);
 571                         match events_2[0] {
 572                                 Event::PaymentReceived { ref payment_hash, amt } => {
 573                                         assert_eq!(our_payment_hash, *payment_hash);
 574                                         assert_eq!(amt, recv_value);
 575                                 },
 576                                 _ => panic!("Unexpected event"),
 577                         }
 578                 } else {
 579                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
 580                         assert_eq!(events_2.len(), 1);
 581                         check_added_monitors!(node, 1);
 582                         payment_event = SendEvent::from_event(events_2.remove(0));
 583                         assert_eq!(payment_event.msgs.len(), 1);
 584                 }
 585
 586                 prev_node = node;
 587         }
 588
 589         (our_payment_preimage, our_payment_hash)
 590 }
 591
 592 fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: PaymentPreimage) {
 593         assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
 594         check_added_monitors!(expected_route.last().unwrap(), 1);
 595
 596         let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
 597         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
 598         macro_rules! get_next_msgs {
 599                 ($node: expr) => {
 600                         {
 601                                 let events = $node.node.get_and_clear_pending_msg_events();
 602                                 assert_eq!(events.len(), 1);
 603                                 match events[0] {
 604                                         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 } } => {
 605                                                 assert!(update_add_htlcs.is_empty());
 606                                                 assert_eq!(update_fulfill_htlcs.len(), 1);
 607                                                 assert!(update_fail_htlcs.is_empty());
 608                                                 assert!(update_fail_malformed_htlcs.is_empty());
 609                                                 assert!(update_fee.is_none());
 610                                                 expected_next_node = node_id.clone();
 611                                                 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
 612                                         },
 613                                         _ => panic!("Unexpected event"),
 614                                 }
 615                         }
 616                 }
 617         }
 618
 619         macro_rules! last_update_fulfill_dance {
 620                 ($node: expr, $prev_node: expr) => {
 621                         {
 622                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
 623                                 check_added_monitors!($node, 0);
 624                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 625                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 626                         }
 627                 }
 628         }
 629         macro_rules! mid_update_fulfill_dance {
 630                 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 631                         {
 632                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
 633                                 check_added_monitors!($node, 1);
 634                                 let new_next_msgs = if $new_msgs {
 635                                         get_next_msgs!($node)
 636                                 } else {
 637                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 638                                         None
 639                                 };
 640                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 641                                 next_msgs = new_next_msgs;
 642                         }
 643                 }
 644         }
 645
 646         let mut prev_node = expected_route.last().unwrap();
 647         for (idx, node) in expected_route.iter().rev().enumerate() {
 648                 assert_eq!(expected_next_node, node.node.get_our_node_id());
 649                 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 650                 if next_msgs.is_some() {
 651                         mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 652                 } else if update_next_msgs {
 653                         next_msgs = get_next_msgs!(node);
 654                 } else {
 655                         assert!(node.node.get_and_clear_pending_msg_events().is_empty());
 656                 }
 657                 if !skip_last && idx == expected_route.len() - 1 {
 658                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
 659                 }
 660
 661                 prev_node = node;
 662         }
 663
 664         if !skip_last {
 665                 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
 666                 let events = origin_node.node.get_and_clear_pending_events();
 667                 assert_eq!(events.len(), 1);
 668                 match events[0] {
 669                         Event::PaymentSent { payment_preimage } => {
 670                                 assert_eq!(payment_preimage, our_payment_preimage);
 671                         },
 672                         _ => panic!("Unexpected event"),
 673                 }
 674         }
 675 }
 676
 677 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: PaymentPreimage) {
 678         claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
 679 }
 680
 681 const TEST_FINAL_CLTV: u32 = 32;
 682
 683 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
 684         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();
 685         assert_eq!(route.hops.len(), expected_route.len());
 686         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
 687                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 688         }
 689
 690         send_along_route(origin_node, route, expected_route, recv_value)
 691 }
 692
 693 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
 694         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();
 695         assert_eq!(route.hops.len(), expected_route.len());
 696         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
 697                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 698         }
 699
 700         let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 701
 702         let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
 703         match err {
 704                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
 705                 _ => panic!("Unknown error variants"),
 706         };
 707 }
 708
 709 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
 710         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
 711         claim_payment(&origin, expected_route, our_payment_preimage);
 712 }
 713
 714 fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: PaymentHash) {
 715         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, 0));
 716         check_added_monitors!(expected_route.last().unwrap(), 1);
 717
 718         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
 719         macro_rules! update_fail_dance {
 720                 ($node: expr, $prev_node: expr, $last_node: expr) => {
 721                         {
 722                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
 723                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
 724                         }
 725                 }
 726         }
 727
 728         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
 729         let mut prev_node = expected_route.last().unwrap();
 730         for (idx, node) in expected_route.iter().rev().enumerate() {
 731                 assert_eq!(expected_next_node, node.node.get_our_node_id());
 732                 if next_msgs.is_some() {
 733                         // We may be the "last node" for the purpose of the commitment dance if we're
 734                         // skipping the last node (implying it is disconnected) and we're the
 735                         // second-to-last node!
 736                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
 737                 }
 738
 739                 let events = node.node.get_and_clear_pending_msg_events();
 740                 if !skip_last || idx != expected_route.len() - 1 {
 741                         assert_eq!(events.len(), 1);
 742                         match events[0] {
 743                                 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 } } => {
 744                                         assert!(update_add_htlcs.is_empty());
 745                                         assert!(update_fulfill_htlcs.is_empty());
 746                                         assert_eq!(update_fail_htlcs.len(), 1);
 747                                         assert!(update_fail_malformed_htlcs.is_empty());
 748                                         assert!(update_fee.is_none());
 749                                         expected_next_node = node_id.clone();
 750                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
 751                                 },
 752                                 _ => panic!("Unexpected event"),
 753                         }
 754                 } else {
 755                         assert!(events.is_empty());
 756                 }
 757                 if !skip_last && idx == expected_route.len() - 1 {
 758                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
 759                 }
 760
 761                 prev_node = node;
 762         }
 763
 764         if !skip_last {
 765                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
 766
 767                 let events = origin_node.node.get_and_clear_pending_events();
 768                 assert_eq!(events.len(), 1);
 769                 match events[0] {
 770                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
 771                                 assert_eq!(payment_hash, our_payment_hash);
 772                                 assert!(rejected_by_dest);
 773                         },
 774                         _ => panic!("Unexpected event"),
 775                 }
 776         }
 777 }
 778
 779 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: PaymentHash) {
 780         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
 781 }
 782
 783 fn create_network(node_count: usize) -> Vec<Node> {
 784         let mut nodes = Vec::new();
 785         let mut rng = thread_rng();
 786         let secp_ctx = Secp256k1::new();
 787
 788         let chan_count = Rc::new(RefCell::new(0));
 789         let payment_count = Rc::new(RefCell::new(0));
 790
 791         for i in 0..node_count {
 792                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
 793                 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
 794                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
 795                 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
 796                 let mut seed = [0; 32];
 797                 rng.fill_bytes(&mut seed);
 798                 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, Arc::clone(&logger)));
 799                 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
 800                 let mut config = UserConfig::new();
 801                 config.channel_options.announced_channel = true;
 802                 config.channel_limits.force_announced_channel_preference = false;
 803                 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();
 804                 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
 805                 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, keys_manager, node_seed: seed,
 806                         network_payment_count: payment_count.clone(),
 807                         network_chan_count: chan_count.clone(),
 808                 });
 809         }
 810
 811         nodes
 812 }
 813
 814 #[test]
 815 fn test_async_inbound_update_fee() {
 816         let mut nodes = create_network(2);
 817         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 818         let channel_id = chan.2;
 819
 820         // balancing
 821         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 822
 823         // A                                        B
 824         // update_fee                            ->
 825         // send (1) commitment_signed            -.
 826         //                                       <- update_add_htlc/commitment_signed
 827         // send (2) RAA (awaiting remote revoke) -.
 828         // (1) commitment_signed is delivered    ->
 829         //                                       .- send (3) RAA (awaiting remote revoke)
 830         // (2) RAA is delivered                  ->
 831         //                                       .- send (4) commitment_signed
 832         //                                       <- (3) RAA is delivered
 833         // send (5) commitment_signed            -.
 834         //                                       <- (4) commitment_signed is delivered
 835         // send (6) RAA                          -.
 836         // (5) commitment_signed is delivered    ->
 837         //                                       <- RAA
 838         // (6) RAA is delivered                  ->
 839
 840         // First nodes[0] generates an update_fee
 841         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 842         check_added_monitors!(nodes[0], 1);
 843
 844         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 845         assert_eq!(events_0.len(), 1);
 846         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 847                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 848                         (update_fee.as_ref(), commitment_signed)
 849                 },
 850                 _ => panic!("Unexpected event"),
 851         };
 852
 853         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 854
 855         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 856         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 857         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();
 858         check_added_monitors!(nodes[1], 1);
 859
 860         let payment_event = {
 861                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 862                 assert_eq!(events_1.len(), 1);
 863                 SendEvent::from_event(events_1.remove(0))
 864         };
 865         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 866         assert_eq!(payment_event.msgs.len(), 1);
 867
 868         // ...now when the messages get delivered everyone should be happy
 869         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 870         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 871         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 872         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 873         check_added_monitors!(nodes[0], 1);
 874
 875         // deliver(1), generate (3):
 876         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 877         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 878         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 879         check_added_monitors!(nodes[1], 1);
 880
 881         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
 882         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 883         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 884         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 885         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 886         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 887         assert!(bs_update.update_fee.is_none()); // (4)
 888         check_added_monitors!(nodes[1], 1);
 889
 890         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
 891         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 892         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 893         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 894         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 895         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 896         assert!(as_update.update_fee.is_none()); // (5)
 897         check_added_monitors!(nodes[0], 1);
 898
 899         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
 900         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 901         // only (6) so get_event_msg's assert(len == 1) passes
 902         check_added_monitors!(nodes[0], 1);
 903
 904         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
 905         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 906         check_added_monitors!(nodes[1], 1);
 907
 908         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
 909         check_added_monitors!(nodes[0], 1);
 910
 911         let events_2 = nodes[0].node.get_and_clear_pending_events();
 912         assert_eq!(events_2.len(), 1);
 913         match events_2[0] {
 914                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 915                 _ => panic!("Unexpected event"),
 916         }
 917
 918         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
 919         check_added_monitors!(nodes[1], 1);
 920 }
 921
 922 #[test]
 923 fn test_update_fee_unordered_raa() {
 924         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 925         // crash in an earlier version of the update_fee patch)
 926         let mut nodes = create_network(2);
 927         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 928         let channel_id = chan.2;
 929
 930         // balancing
 931         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 932
 933         // First nodes[0] generates an update_fee
 934         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 935         check_added_monitors!(nodes[0], 1);
 936
 937         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 938         assert_eq!(events_0.len(), 1);
 939         let update_msg = match events_0[0] { // (1)
 940                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 941                         update_fee.as_ref()
 942                 },
 943                 _ => panic!("Unexpected event"),
 944         };
 945
 946         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 947
 948         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 949         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 950         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();
 951         check_added_monitors!(nodes[1], 1);
 952
 953         let payment_event = {
 954                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 955                 assert_eq!(events_1.len(), 1);
 956                 SendEvent::from_event(events_1.remove(0))
 957         };
 958         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 959         assert_eq!(payment_event.msgs.len(), 1);
 960
 961         // ...now when the messages get delivered everyone should be happy
 962         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 963         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 964         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 965         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 966         check_added_monitors!(nodes[0], 1);
 967
 968         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
 969         check_added_monitors!(nodes[1], 1);
 970
 971         // We can't continue, sadly, because our (1) now has a bogus signature
 972 }
 973
 974 #[test]
 975 fn test_multi_flight_update_fee() {
 976         let nodes = create_network(2);
 977         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 978         let channel_id = chan.2;
 979
 980         // A                                        B
 981         // update_fee/commitment_signed          ->
 982         //                                       .- send (1) RAA and (2) commitment_signed
 983         // update_fee (never committed)          ->
 984         // (3) update_fee                        ->
 985         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 986         // don't track which updates correspond to which revoke_and_ack responses so we're in
 987         // AwaitingRAA mode and will not generate the update_fee yet.
 988         //                                       <- (1) RAA delivered
 989         // (3) is generated and send (4) CS      -.
 990         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 991         // know the per_commitment_point to use for it.
 992         //                                       <- (2) commitment_signed delivered
 993         // revoke_and_ack                        ->
 994         //                                          B should send no response here
 995         // (4) commitment_signed delivered       ->
 996         //                                       <- RAA/commitment_signed delivered
 997         // revoke_and_ack                        ->
 998
 999         // First nodes[0] generates an update_fee
1000         let initial_feerate = get_feerate!(nodes[0], channel_id);
1001         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
1002         check_added_monitors!(nodes[0], 1);
1003
1004         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1005         assert_eq!(events_0.len(), 1);
1006         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
1007                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
1008                         (update_fee.as_ref().unwrap(), commitment_signed)
1009                 },
1010                 _ => panic!("Unexpected event"),
1011         };
1012
1013         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
1014         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
1015         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
1016         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1017         check_added_monitors!(nodes[1], 1);
1018
1019         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
1020         // transaction:
1021         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
1022         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1023         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1024
1025         // Create the (3) update_fee message that nodes[0] will generate before it does...
1026         let mut update_msg_2 = msgs::UpdateFee {
1027                 channel_id: update_msg_1.channel_id.clone(),
1028                 feerate_per_kw: (initial_feerate + 30) as u32,
1029         };
1030
1031         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
1032
1033         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
1034         // Deliver (3)
1035         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
1036
1037         // Deliver (1), generating (3) and (4)
1038         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
1039         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1040         check_added_monitors!(nodes[0], 1);
1041         assert!(as_second_update.update_add_htlcs.is_empty());
1042         assert!(as_second_update.update_fulfill_htlcs.is_empty());
1043         assert!(as_second_update.update_fail_htlcs.is_empty());
1044         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
1045         // Check that the update_fee newly generated matches what we delivered:
1046         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
1047         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
1048
1049         // Deliver (2) commitment_signed
1050         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1051         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1052         check_added_monitors!(nodes[0], 1);
1053         // No commitment_signed so get_event_msg's assert(len == 1) passes
1054
1055         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
1056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1057         check_added_monitors!(nodes[1], 1);
1058
1059         // Delever (4)
1060         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
1061         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1062         check_added_monitors!(nodes[1], 1);
1063
1064         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
1065         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1066         check_added_monitors!(nodes[0], 1);
1067
1068         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
1069         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1070         // No commitment_signed so get_event_msg's assert(len == 1) passes
1071         check_added_monitors!(nodes[0], 1);
1072
1073         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
1074         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1075         check_added_monitors!(nodes[1], 1);
1076 }
1077
1078 #[test]
1079 fn test_update_fee_vanilla() {
1080         let nodes = create_network(2);
1081         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1082         let channel_id = chan.2;
1083
1084         let feerate = get_feerate!(nodes[0], channel_id);
1085         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
1086         check_added_monitors!(nodes[0], 1);
1087
1088         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1089         assert_eq!(events_0.len(), 1);
1090         let (update_msg, commitment_signed) = match events_0[0] {
1091                         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 } } => {
1092                         (update_fee.as_ref(), commitment_signed)
1093                 },
1094                 _ => panic!("Unexpected event"),
1095         };
1096         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1097
1098         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1099         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1100         check_added_monitors!(nodes[1], 1);
1101
1102         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1103         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1104         check_added_monitors!(nodes[0], 1);
1105
1106         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
1107         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1108         // No commitment_signed so get_event_msg's assert(len == 1) passes
1109         check_added_monitors!(nodes[0], 1);
1110
1111         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1112         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1113         check_added_monitors!(nodes[1], 1);
1114 }
1115
1116 #[test]
1117 fn test_update_fee_that_funder_cannot_afford() {
1118         let nodes = create_network(2);
1119         let channel_value = 1888;
1120         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
1121         let channel_id = chan.2;
1122
1123         let feerate = 260;
1124         nodes[0].node.update_fee(channel_id, feerate).unwrap();
1125         check_added_monitors!(nodes[0], 1);
1126         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1127
1128         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
1129
1130         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
1131
1132         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
1133         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
1134         {
1135                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1136                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
1137
1138                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
1139                 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
1140                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1141                 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
1142                 actual_fee = channel_value - actual_fee;
1143                 assert_eq!(total_fee, actual_fee);
1144         } //drop the mutex
1145
1146         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
1147         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
1148         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
1149         check_added_monitors!(nodes[0], 1);
1150
1151         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1152
1153         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
1154
1155         //While producing the commitment_signed response after handling a received update_fee request the
1156         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
1157         //Should produce and error.
1158         let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
1159
1160         assert!(match err.err {
1161                 "Funding remote cannot afford proposed new fee" => true,
1162                 _ => false,
1163         });
1164
1165         //clear the message we could not handle
1166         nodes[1].node.get_and_clear_pending_msg_events();
1167 }
1168
1169 #[test]
1170 fn test_update_fee_with_fundee_update_add_htlc() {
1171         let mut nodes = create_network(2);
1172         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1173         let channel_id = chan.2;
1174
1175         // balancing
1176         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1177
1178         let feerate = get_feerate!(nodes[0], channel_id);
1179         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
1180         check_added_monitors!(nodes[0], 1);
1181
1182         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1183         assert_eq!(events_0.len(), 1);
1184         let (update_msg, commitment_signed) = match events_0[0] {
1185                         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 } } => {
1186                         (update_fee.as_ref(), commitment_signed)
1187                 },
1188                 _ => panic!("Unexpected event"),
1189         };
1190         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1191         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1192         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1193         check_added_monitors!(nodes[1], 1);
1194
1195         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
1196
1197         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
1198
1199         // nothing happens since node[1] is in AwaitingRemoteRevoke
1200         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
1201         {
1202                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
1203                 assert_eq!(added_monitors.len(), 0);
1204                 added_monitors.clear();
1205         }
1206         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1207         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1208         // node[1] has nothing to do
1209
1210         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1211         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1212         check_added_monitors!(nodes[0], 1);
1213
1214         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
1215         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1216         // No commitment_signed so get_event_msg's assert(len == 1) passes
1217         check_added_monitors!(nodes[0], 1);
1218         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1219         check_added_monitors!(nodes[1], 1);
1220         // AwaitingRemoteRevoke ends here
1221
1222         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1223         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
1224         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
1225         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
1226         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
1227         assert_eq!(commitment_update.update_fee.is_none(), true);
1228
1229         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
1230         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1231         check_added_monitors!(nodes[0], 1);
1232         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1233
1234         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
1235         check_added_monitors!(nodes[1], 1);
1236         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1237
1238         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
1239         check_added_monitors!(nodes[1], 1);
1240         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1241         // No commitment_signed so get_event_msg's assert(len == 1) passes
1242
1243         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
1244         check_added_monitors!(nodes[0], 1);
1245         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1246
1247         let events = nodes[0].node.get_and_clear_pending_events();
1248         assert_eq!(events.len(), 1);
1249         match events[0] {
1250                 Event::PendingHTLCsForwardable { .. } => { },
1251                 _ => panic!("Unexpected event"),
1252         };
1253         nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
1254         nodes[0].node.process_pending_htlc_forwards();
1255
1256         let events = nodes[0].node.get_and_clear_pending_events();
1257         assert_eq!(events.len(), 1);
1258         match events[0] {
1259                 Event::PaymentReceived { .. } => { },
1260                 _ => panic!("Unexpected event"),
1261         };
1262
1263         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
1264
1265         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
1266         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
1267         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
1268 }
1269
1270 #[test]
1271 fn test_update_fee() {
1272         let nodes = create_network(2);
1273         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1274         let channel_id = chan.2;
1275
1276         // A                                        B
1277         // (1) update_fee/commitment_signed      ->
1278         //                                       <- (2) revoke_and_ack
1279         //                                       .- send (3) commitment_signed
1280         // (4) update_fee/commitment_signed      ->
1281         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
1282         //                                       <- (3) commitment_signed delivered
1283         // send (6) revoke_and_ack               -.
1284         //                                       <- (5) deliver revoke_and_ack
1285         // (6) deliver revoke_and_ack            ->
1286         //                                       .- send (7) commitment_signed in response to (4)
1287         //                                       <- (7) deliver commitment_signed
1288         // revoke_and_ack                        ->
1289
1290         // Create and deliver (1)...
1291         let feerate = get_feerate!(nodes[0], channel_id);
1292         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
1293         check_added_monitors!(nodes[0], 1);
1294
1295         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1296         assert_eq!(events_0.len(), 1);
1297         let (update_msg, commitment_signed) = match events_0[0] {
1298                         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 } } => {
1299                         (update_fee.as_ref(), commitment_signed)
1300                 },
1301                 _ => panic!("Unexpected event"),
1302         };
1303         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1304
1305         // Generate (2) and (3):
1306         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1307         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1308         check_added_monitors!(nodes[1], 1);
1309
1310         // Deliver (2):
1311         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1312         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1313         check_added_monitors!(nodes[0], 1);
1314
1315         // Create and deliver (4)...
1316         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
1317         check_added_monitors!(nodes[0], 1);
1318         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
1319         assert_eq!(events_0.len(), 1);
1320         let (update_msg, commitment_signed) = match events_0[0] {
1321                         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 } } => {
1322                         (update_fee.as_ref(), commitment_signed)
1323                 },
1324                 _ => panic!("Unexpected event"),
1325         };
1326
1327         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
1328         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
1329         check_added_monitors!(nodes[1], 1);
1330         // ... creating (5)
1331         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1332         // No commitment_signed so get_event_msg's assert(len == 1) passes
1333
1334         // Handle (3), creating (6):
1335         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
1336         check_added_monitors!(nodes[0], 1);
1337         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1338         // No commitment_signed so get_event_msg's assert(len == 1) passes
1339
1340         // Deliver (5):
1341         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
1342         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1343         check_added_monitors!(nodes[0], 1);
1344
1345         // Deliver (6), creating (7):
1346         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
1347         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1348         assert!(commitment_update.update_add_htlcs.is_empty());
1349         assert!(commitment_update.update_fulfill_htlcs.is_empty());
1350         assert!(commitment_update.update_fail_htlcs.is_empty());
1351         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1352         assert!(commitment_update.update_fee.is_none());
1353         check_added_monitors!(nodes[1], 1);
1354
1355         // Deliver (7)
1356         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1357         check_added_monitors!(nodes[0], 1);
1358         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1359         // No commitment_signed so get_event_msg's assert(len == 1) passes
1360
1361         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
1362         check_added_monitors!(nodes[1], 1);
1363         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1364
1365         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
1366         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
1367         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
1368 }
1369
1370 #[test]
1371 fn pre_funding_lock_shutdown_test() {
1372         // Test sending a shutdown prior to funding_locked after funding generation
1373         let nodes = create_network(2);
1374         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
1375         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1376         nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
1377         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
1378
1379         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
1380         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1381         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1382         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1383         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1384
1385         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1386         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1387         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1388         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1389         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1390         assert!(node_0_none.is_none());
1391
1392         assert!(nodes[0].node.list_channels().is_empty());
1393         assert!(nodes[1].node.list_channels().is_empty());
1394 }
1395
1396 #[test]
1397 fn updates_shutdown_wait() {
1398         // Test sending a shutdown with outstanding updates pending
1399         let mut nodes = create_network(3);
1400         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1401         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1402         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1403         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1404
1405         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1406
1407         nodes[0].node.close_channel(&chan_1.2).unwrap();
1408         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1409         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1410         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1411         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1412
1413         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1414         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1415
1416         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1417         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
1418         else { panic!("New sends should fail!") };
1419         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
1420         else { panic!("New sends should fail!") };
1421
1422         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1423         check_added_monitors!(nodes[2], 1);
1424         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1425         assert!(updates.update_add_htlcs.is_empty());
1426         assert!(updates.update_fail_htlcs.is_empty());
1427         assert!(updates.update_fail_malformed_htlcs.is_empty());
1428         assert!(updates.update_fee.is_none());
1429         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1430         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
1431         check_added_monitors!(nodes[1], 1);
1432         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1433         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1434
1435         assert!(updates_2.update_add_htlcs.is_empty());
1436         assert!(updates_2.update_fail_htlcs.is_empty());
1437         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1438         assert!(updates_2.update_fee.is_none());
1439         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1440         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
1441         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1442
1443         let events = nodes[0].node.get_and_clear_pending_events();
1444         assert_eq!(events.len(), 1);
1445         match events[0] {
1446                 Event::PaymentSent { ref payment_preimage } => {
1447                         assert_eq!(our_payment_preimage, *payment_preimage);
1448                 },
1449                 _ => panic!("Unexpected event"),
1450         }
1451
1452         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1453         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1454         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1455         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1456         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1457         assert!(node_0_none.is_none());
1458
1459         assert!(nodes[0].node.list_channels().is_empty());
1460
1461         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1462         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1463         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1464         assert!(nodes[1].node.list_channels().is_empty());
1465         assert!(nodes[2].node.list_channels().is_empty());
1466 }
1467
1468 #[test]
1469 fn htlc_fail_async_shutdown() {
1470         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
1471         let mut nodes = create_network(3);
1472         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1473         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1474
1475         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1476         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1477         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
1478         check_added_monitors!(nodes[0], 1);
1479         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1480         assert_eq!(updates.update_add_htlcs.len(), 1);
1481         assert!(updates.update_fulfill_htlcs.is_empty());
1482         assert!(updates.update_fail_htlcs.is_empty());
1483         assert!(updates.update_fail_malformed_htlcs.is_empty());
1484         assert!(updates.update_fee.is_none());
1485
1486         nodes[1].node.close_channel(&chan_1.2).unwrap();
1487         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1488         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1489         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1490
1491         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
1492         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
1493         check_added_monitors!(nodes[1], 1);
1494         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1495         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
1496
1497         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1498         assert!(updates_2.update_add_htlcs.is_empty());
1499         assert!(updates_2.update_fulfill_htlcs.is_empty());
1500         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
1501         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1502         assert!(updates_2.update_fee.is_none());
1503
1504         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
1505         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1506
1507         let events = nodes[0].node.get_and_clear_pending_events();
1508         assert_eq!(events.len(), 1);
1509         match events[0] {
1510                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
1511                         assert_eq!(our_payment_hash, *payment_hash);
1512                         assert!(!rejected_by_dest);
1513                 },
1514                 _ => panic!("Unexpected event"),
1515         }
1516
1517         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
1518         assert_eq!(msg_events.len(), 2);
1519         let node_0_closing_signed = match msg_events[0] {
1520                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1521                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
1522                         (*msg).clone()
1523                 },
1524                 _ => panic!("Unexpected event"),
1525         };
1526         match msg_events[1] {
1527                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1528                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
1529                 },
1530                 _ => panic!("Unexpected event"),
1531         }
1532
1533         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1534         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1535         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1536         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1537         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1538         assert!(node_0_none.is_none());
1539
1540         assert!(nodes[0].node.list_channels().is_empty());
1541
1542         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1543         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1544         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1545         assert!(nodes[1].node.list_channels().is_empty());
1546         assert!(nodes[2].node.list_channels().is_empty());
1547 }
1548
1549 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1550         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1551         // messages delivered prior to disconnect
1552         let nodes = create_network(3);
1553         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1554         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1555
1556         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1557
1558         nodes[1].node.close_channel(&chan_1.2).unwrap();
1559         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1560         if recv_count > 0 {
1561                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
1562                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1563                 if recv_count > 1 {
1564                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
1565                 }
1566         }
1567
1568         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1569         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1570
1571         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
1572         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1573         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
1574         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1575
1576         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
1577         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1578         assert!(node_1_shutdown == node_1_2nd_shutdown);
1579
1580         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
1581         let node_0_2nd_shutdown = if recv_count > 0 {
1582                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1583                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
1584                 node_0_2nd_shutdown
1585         } else {
1586                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1587                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
1588                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1589         };
1590         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
1591
1592         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1593         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1594
1595         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1596         check_added_monitors!(nodes[2], 1);
1597         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1598         assert!(updates.update_add_htlcs.is_empty());
1599         assert!(updates.update_fail_htlcs.is_empty());
1600         assert!(updates.update_fail_malformed_htlcs.is_empty());
1601         assert!(updates.update_fee.is_none());
1602         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1603         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
1604         check_added_monitors!(nodes[1], 1);
1605         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1606         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1607
1608         assert!(updates_2.update_add_htlcs.is_empty());
1609         assert!(updates_2.update_fail_htlcs.is_empty());
1610         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1611         assert!(updates_2.update_fee.is_none());
1612         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1613         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
1614         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1615
1616         let events = nodes[0].node.get_and_clear_pending_events();
1617         assert_eq!(events.len(), 1);
1618         match events[0] {
1619                 Event::PaymentSent { ref payment_preimage } => {
1620                         assert_eq!(our_payment_preimage, *payment_preimage);
1621                 },
1622                 _ => panic!("Unexpected event"),
1623         }
1624
1625         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1626         if recv_count > 0 {
1627                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
1628                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1629                 assert!(node_1_closing_signed.is_some());
1630         }
1631
1632         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1633         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1634
1635         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
1636         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1637         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
1638         if recv_count == 0 {
1639                 // If all closing_signeds weren't delivered we can just resume where we left off...
1640                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1641
1642                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
1643                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1644                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1645
1646                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
1647                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1648                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1649
1650                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
1651                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1652
1653                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
1654                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1655                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1656
1657                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
1658                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1659                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
1660                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1661                 assert!(node_0_none.is_none());
1662         } else {
1663                 // If one node, however, received + responded with an identical closing_signed we end
1664                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1665                 // There isn't really anything better we can do simply, but in the future we might
1666                 // explore storing a set of recently-closed channels that got disconnected during
1667                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1668                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1669                 // transaction.
1670                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1671
1672                 if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
1673                                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
1674                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1675                         let msgs::ErrorMessage {ref channel_id, ..} = msg;
1676                         assert_eq!(*channel_id, chan_1.2);
1677                 } else { panic!("Needed SendErrorMessage close"); }
1678
1679                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1680                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1681                 // closing_signed so we do it ourselves
1682                 let events = nodes[0].node.get_and_clear_pending_msg_events();
1683                 assert_eq!(events.len(), 1);
1684                 match events[0] {
1685                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1686                                 assert_eq!(msg.contents.flags & 2, 2);
1687                         },
1688                         _ => panic!("Unexpected event"),
1689                 }
1690         }
1691
1692         assert!(nodes[0].node.list_channels().is_empty());
1693
1694         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1695         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1696         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1697         assert!(nodes[1].node.list_channels().is_empty());
1698         assert!(nodes[2].node.list_channels().is_empty());
1699 }
1700
1701 #[test]
1702 fn test_shutdown_rebroadcast() {
1703         do_test_shutdown_rebroadcast(0);
1704         do_test_shutdown_rebroadcast(1);
1705         do_test_shutdown_rebroadcast(2);
1706 }
1707
1708 #[test]
1709 fn fake_network_test() {
1710         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1711         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1712         let nodes = create_network(4);
1713
1714         // Create some initial channels
1715         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
1716         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
1717         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1718
1719         // Rebalance the network a bit by relaying one payment through all the channels...
1720         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1721         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1722         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1723         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1724
1725         // Send some more payments
1726         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1727         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1728         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1729
1730         // Test failure packets
1731         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1732         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1733
1734         // Add a new channel that skips 3
1735         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
1736
1737         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1738         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1739         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1740         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1741         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1742         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1743         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1744
1745         // Do some rebalance loop payments, simultaneously
1746         let mut hops = Vec::with_capacity(3);
1747         hops.push(RouteHop {
1748                 pubkey: nodes[2].node.get_our_node_id(),
1749                 short_channel_id: chan_2.0.contents.short_channel_id,
1750                 fee_msat: 0,
1751                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1752         });
1753         hops.push(RouteHop {
1754                 pubkey: nodes[3].node.get_our_node_id(),
1755                 short_channel_id: chan_3.0.contents.short_channel_id,
1756                 fee_msat: 0,
1757                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1758         });
1759         hops.push(RouteHop {
1760                 pubkey: nodes[1].node.get_our_node_id(),
1761                 short_channel_id: chan_4.0.contents.short_channel_id,
1762                 fee_msat: 1000000,
1763                 cltv_expiry_delta: TEST_FINAL_CLTV,
1764         });
1765         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;
1766         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;
1767         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1768
1769         let mut hops = Vec::with_capacity(3);
1770         hops.push(RouteHop {
1771                 pubkey: nodes[3].node.get_our_node_id(),
1772                 short_channel_id: chan_4.0.contents.short_channel_id,
1773                 fee_msat: 0,
1774                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1775         });
1776         hops.push(RouteHop {
1777                 pubkey: nodes[2].node.get_our_node_id(),
1778                 short_channel_id: chan_3.0.contents.short_channel_id,
1779                 fee_msat: 0,
1780                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1781         });
1782         hops.push(RouteHop {
1783                 pubkey: nodes[1].node.get_our_node_id(),
1784                 short_channel_id: chan_2.0.contents.short_channel_id,
1785                 fee_msat: 1000000,
1786                 cltv_expiry_delta: TEST_FINAL_CLTV,
1787         });
1788         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;
1789         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;
1790         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1791
1792         // Claim the rebalances...
1793         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1794         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1795
1796         // Add a duplicate new channel from 2 to 4
1797         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
1798
1799         // Send some payments across both channels
1800         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1801         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1802         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1803
1804         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1805
1806         //TODO: Test that routes work again here as we've been notified that the channel is full
1807
1808         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1809         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1810         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1811
1812         // Close down the channels...
1813         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1814         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1815         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1816         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1817         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1818 }
1819
1820 #[test]
1821 fn duplicate_htlc_test() {
1822         // Test that we accept duplicate payment_hash HTLCs across the network and that
1823         // claiming/failing them are all separate and don't effect each other
1824         let mut nodes = create_network(6);
1825
1826         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1827         create_announced_chan_between_nodes(&nodes, 0, 3);
1828         create_announced_chan_between_nodes(&nodes, 1, 3);
1829         create_announced_chan_between_nodes(&nodes, 2, 3);
1830         create_announced_chan_between_nodes(&nodes, 3, 4);
1831         create_announced_chan_between_nodes(&nodes, 3, 5);
1832
1833         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1834
1835         *nodes[0].network_payment_count.borrow_mut() -= 1;
1836         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1837
1838         *nodes[0].network_payment_count.borrow_mut() -= 1;
1839         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1840
1841         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1842         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1843         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1844 }
1845
1846 #[derive(PartialEq)]
1847 enum HTLCType { NONE, TIMEOUT, SUCCESS }
1848 /// Tests that the given node has broadcast transactions for the given Channel
1849 ///
1850 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
1851 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1852 /// broadcast and the revoked outputs were claimed.
1853 ///
1854 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1855 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1856 ///
1857 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1858 /// also fail.
1859 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
1860         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1861         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1862
1863         let mut res = Vec::with_capacity(2);
1864         node_txn.retain(|tx| {
1865                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1866                         check_spends!(tx, chan.3.clone());
1867                         if commitment_tx.is_none() {
1868                                 res.push(tx.clone());
1869                         }
1870                         false
1871                 } else { true }
1872         });
1873         if let Some(explicit_tx) = commitment_tx {
1874                 res.push(explicit_tx.clone());
1875         }
1876
1877         assert_eq!(res.len(), 1);
1878
1879         if has_htlc_tx != HTLCType::NONE {
1880                 node_txn.retain(|tx| {
1881                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1882                                 check_spends!(tx, res[0].clone());
1883                                 if has_htlc_tx == HTLCType::TIMEOUT {
1884                                         assert!(tx.lock_time != 0);
1885                                 } else {
1886                                         assert!(tx.lock_time == 0);
1887                                 }
1888                                 res.push(tx.clone());
1889                                 false
1890                         } else { true }
1891                 });
1892                 assert!(res.len() == 2 || res.len() == 3);
1893                 if res.len() == 3 {
1894                         assert_eq!(res[1], res[2]);
1895                 }
1896         }
1897
1898         assert!(node_txn.is_empty());
1899         res
1900 }
1901
1902 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1903 /// HTLC transaction.
1904 fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
1905         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1906         assert_eq!(node_txn.len(), 1);
1907         node_txn.retain(|tx| {
1908                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1909                         check_spends!(tx, revoked_tx.clone());
1910                         false
1911                 } else { true }
1912         });
1913         assert!(node_txn.is_empty());
1914 }
1915
1916 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1917         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1918
1919         assert!(node_txn.len() >= 1);
1920         assert_eq!(node_txn[0].input.len(), 1);
1921         let mut found_prev = false;
1922
1923         for tx in prev_txn {
1924                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1925                         check_spends!(node_txn[0], tx.clone());
1926                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1927                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1928
1929                         found_prev = true;
1930                         break;
1931                 }
1932         }
1933         assert!(found_prev);
1934
1935         let mut res = Vec::new();
1936         mem::swap(&mut *node_txn, &mut res);
1937         res
1938 }
1939
1940 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
1941         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1942         assert_eq!(events_1.len(), 1);
1943         let as_update = match events_1[0] {
1944                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1945                         msg.clone()
1946                 },
1947                 _ => panic!("Unexpected event"),
1948         };
1949
1950         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1951         assert_eq!(events_2.len(), 1);
1952         let bs_update = match events_2[0] {
1953                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1954                         msg.clone()
1955                 },
1956                 _ => panic!("Unexpected event"),
1957         };
1958
1959         for node in nodes {
1960                 node.router.handle_channel_update(&as_update).unwrap();
1961                 node.router.handle_channel_update(&bs_update).unwrap();
1962         }
1963 }
1964
1965 macro_rules! expect_pending_htlcs_forwardable {
1966         ($node: expr) => {{
1967                 let events = $node.node.get_and_clear_pending_events();
1968                 assert_eq!(events.len(), 1);
1969                 match events[0] {
1970                         Event::PendingHTLCsForwardable { .. } => { },
1971                         _ => panic!("Unexpected event"),
1972                 };
1973                 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
1974                 $node.node.process_pending_htlc_forwards();
1975         }}
1976 }
1977
1978 fn do_channel_reserve_test(test_recv: bool) {
1979         use util::rng;
1980         use std::sync::atomic::Ordering;
1981         use ln::msgs::HandleError;
1982
1983         macro_rules! get_channel_value_stat {
1984                 ($node: expr, $channel_id: expr) => {{
1985                         let chan_lock = $node.node.channel_state.lock().unwrap();
1986                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1987                         chan.get_value_stat()
1988                 }}
1989         }
1990
1991         let mut nodes = create_network(3);
1992         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
1993         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
1994
1995         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1996         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1997
1998         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1999         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
2000
2001         macro_rules! get_route_and_payment_hash {
2002                 ($recv_value: expr) => {{
2003                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
2004                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2005                         (route, payment_hash, payment_preimage)
2006                 }}
2007         };
2008
2009         macro_rules! expect_forward {
2010                 ($node: expr) => {{
2011                         let mut events = $node.node.get_and_clear_pending_msg_events();
2012                         assert_eq!(events.len(), 1);
2013                         check_added_monitors!($node, 1);
2014                         let payment_event = SendEvent::from_event(events.remove(0));
2015                         payment_event
2016                 }}
2017         }
2018
2019         macro_rules! expect_payment_received {
2020                 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2021                         let events = $node.node.get_and_clear_pending_events();
2022                         assert_eq!(events.len(), 1);
2023                         match events[0] {
2024                                 Event::PaymentReceived { ref payment_hash, amt } => {
2025                                         assert_eq!($expected_payment_hash, *payment_hash);
2026                                         assert_eq!($expected_recv_value, amt);
2027                                 },
2028                                 _ => panic!("Unexpected event"),
2029                         }
2030                 }
2031         };
2032
2033         let feemsat = 239; // somehow we know?
2034         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
2035
2036         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
2037
2038         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
2039         {
2040                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
2041                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
2042                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
2043                 match err {
2044                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
2045                         _ => panic!("Unknown error variants"),
2046                 }
2047         }
2048
2049         let mut htlc_id = 0;
2050         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
2051         // nodes[0]'s wealth
2052         loop {
2053                 let amt_msat = recv_value_0 + total_fee_msat;
2054                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
2055                         break;
2056                 }
2057                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
2058                 htlc_id += 1;
2059
2060                 let (stat01_, stat11_, stat12_, stat22_) = (
2061                         get_channel_value_stat!(nodes[0], chan_1.2),
2062                         get_channel_value_stat!(nodes[1], chan_1.2),
2063                         get_channel_value_stat!(nodes[1], chan_2.2),
2064                         get_channel_value_stat!(nodes[2], chan_2.2),
2065                 );
2066
2067                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
2068                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
2069                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2070                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2071                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2072         }
2073
2074         {
2075                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
2076                 // attempt to get channel_reserve violation
2077                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
2078                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
2079                 match err {
2080                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2081                         _ => panic!("Unknown error variants"),
2082                 }
2083         }
2084
2085         // adding pending output
2086         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
2087         let amt_msat_1 = recv_value_1 + total_fee_msat;
2088
2089         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2090         let payment_event_1 = {
2091                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
2092                 check_added_monitors!(nodes[0], 1);
2093
2094                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2095                 assert_eq!(events.len(), 1);
2096                 SendEvent::from_event(events.remove(0))
2097         };
2098         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
2099
2100         // channel reserve test with htlc pending output > 0
2101         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
2102         {
2103                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2104                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
2105                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2106                         _ => panic!("Unknown error variants"),
2107                 }
2108         }
2109
2110         {
2111                 // test channel_reserve test on nodes[1] side
2112                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2113
2114                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
2115                 let secp_ctx = Secp256k1::new();
2116                 let session_priv = SecretKey::from_slice(&secp_ctx, &{
2117                         let mut session_key = [0; 32];
2118                         rng::fill_bytes(&mut session_key);
2119                         session_key
2120                 }).expect("RNG is bad!");
2121
2122                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
2123                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2124                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
2125                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
2126                 let msg = msgs::UpdateAddHTLC {
2127                         channel_id: chan_1.2,
2128                         htlc_id,
2129                         amount_msat: htlc_msat,
2130                         payment_hash: our_payment_hash,
2131                         cltv_expiry: htlc_cltv,
2132                         onion_routing_packet: onion_packet,
2133                 };
2134
2135                 if test_recv {
2136                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
2137                         match err {
2138                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
2139                         }
2140                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
2141                         assert_eq!(nodes[1].node.list_channels().len(), 1);
2142                         assert_eq!(nodes[1].node.list_channels().len(), 1);
2143                         let channel_close_broadcast = nodes[1].node.get_and_clear_pending_msg_events();
2144                         assert_eq!(channel_close_broadcast.len(), 1);
2145                         match channel_close_broadcast[0] {
2146                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2147                                         assert_eq!(msg.contents.flags & 2, 2);
2148                                 },
2149                                 _ => panic!("Unexpected event"),
2150                         }
2151                         return;
2152                 }
2153         }
2154
2155         // split the rest to test holding cell
2156         let recv_value_21 = recv_value_2/2;
2157         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
2158         {
2159                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2160                 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);
2161         }
2162
2163         // now see if they go through on both sides
2164         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2165         // but this will stuck in the holding cell
2166         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
2167         check_added_monitors!(nodes[0], 0);
2168         let events = nodes[0].node.get_and_clear_pending_events();
2169         assert_eq!(events.len(), 0);
2170
2171         // test with outbound holding cell amount > 0
2172         {
2173                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2174                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
2175                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
2176                         _ => panic!("Unknown error variants"),
2177                 }
2178         }
2179
2180         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2181         // this will also stuck in the holding cell
2182         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
2183         check_added_monitors!(nodes[0], 0);
2184         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2185         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2186
2187         // flush the pending htlc
2188         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
2189         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2190         check_added_monitors!(nodes[1], 1);
2191
2192         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2193         check_added_monitors!(nodes[0], 1);
2194         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2195
2196         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
2197         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2198         // No commitment_signed so get_event_msg's assert(len == 1) passes
2199         check_added_monitors!(nodes[0], 1);
2200
2201         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2202         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2203         check_added_monitors!(nodes[1], 1);
2204
2205         expect_pending_htlcs_forwardable!(nodes[1]);
2206
2207         let ref payment_event_11 = expect_forward!(nodes[1]);
2208         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
2209         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2210
2211         expect_pending_htlcs_forwardable!(nodes[2]);
2212         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2213
2214         // flush the htlcs in the holding cell
2215         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2216         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
2217         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
2218         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2219         expect_pending_htlcs_forwardable!(nodes[1]);
2220
2221         let ref payment_event_3 = expect_forward!(nodes[1]);
2222         assert_eq!(payment_event_3.msgs.len(), 2);
2223         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
2224         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
2225
2226         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2227         expect_pending_htlcs_forwardable!(nodes[2]);
2228
2229         let events = nodes[2].node.get_and_clear_pending_events();
2230         assert_eq!(events.len(), 2);
2231         match events[0] {
2232                 Event::PaymentReceived { ref payment_hash, amt } => {
2233                         assert_eq!(our_payment_hash_21, *payment_hash);
2234                         assert_eq!(recv_value_21, amt);
2235                 },
2236                 _ => panic!("Unexpected event"),
2237         }
2238         match events[1] {
2239                 Event::PaymentReceived { ref payment_hash, amt } => {
2240                         assert_eq!(our_payment_hash_22, *payment_hash);
2241                         assert_eq!(recv_value_22, amt);
2242                 },
2243                 _ => panic!("Unexpected event"),
2244         }
2245
2246         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2247         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2248         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2249
2250         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);
2251         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2252         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2253         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
2254
2255         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2256         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
2257 }
2258
2259 #[test]
2260 fn channel_reserve_test() {
2261         do_channel_reserve_test(false);
2262         do_channel_reserve_test(true);
2263 }
2264
2265 #[test]
2266 fn channel_monitor_network_test() {
2267         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2268         // tests that ChannelMonitor is able to recover from various states.
2269         let nodes = create_network(5);
2270
2271         // Create some initial channels
2272         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2273         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2274         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2275         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2276
2277         // Rebalance the network a bit by relaying one payment through all the channels...
2278         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2279         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2280         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2281         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2282
2283         // Simple case with no pending HTLCs:
2284         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2285         {
2286                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2287                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2288                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2289                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2290         }
2291         get_announce_close_broadcast_events(&nodes, 0, 1);
2292         assert_eq!(nodes[0].node.list_channels().len(), 0);
2293         assert_eq!(nodes[1].node.list_channels().len(), 1);
2294
2295         // One pending HTLC is discarded by the force-close:
2296         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2297
2298         // Simple case of one pending HTLC to HTLC-Timeout
2299         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2300         {
2301                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2302                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2303                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2304                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2305         }
2306         get_announce_close_broadcast_events(&nodes, 1, 2);
2307         assert_eq!(nodes[1].node.list_channels().len(), 0);
2308         assert_eq!(nodes[2].node.list_channels().len(), 1);
2309
2310         macro_rules! claim_funds {
2311                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2312                         {
2313                                 assert!($node.node.claim_funds($preimage));
2314                                 check_added_monitors!($node, 1);
2315
2316                                 let events = $node.node.get_and_clear_pending_msg_events();
2317                                 assert_eq!(events.len(), 1);
2318                                 match events[0] {
2319                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2320                                                 assert!(update_add_htlcs.is_empty());
2321                                                 assert!(update_fail_htlcs.is_empty());
2322                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2323                                         },
2324                                         _ => panic!("Unexpected event"),
2325                                 };
2326                         }
2327                 }
2328         }
2329
2330         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2331         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2332         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2333         {
2334                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2335
2336                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2337                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2338
2339                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2340                 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2341
2342                 check_preimage_claim(&nodes[3], &node_txn);
2343         }
2344         get_announce_close_broadcast_events(&nodes, 2, 3);
2345         assert_eq!(nodes[2].node.list_channels().len(), 0);
2346         assert_eq!(nodes[3].node.list_channels().len(), 1);
2347
2348         { // Cheat and reset nodes[4]'s height to 1
2349                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2350                 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
2351         }
2352
2353         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2354         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2355         // One pending HTLC to time out:
2356         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2357         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2358         // buffer space).
2359
2360         {
2361                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2362                 nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2363                 for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
2364                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2365                         nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2366                 }
2367
2368                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2369
2370                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2371                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2372
2373                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2374                 nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2375                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2376                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2377                         nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2378                 }
2379
2380                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2381
2382                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2383                 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2384
2385                 check_preimage_claim(&nodes[4], &node_txn);
2386         }
2387         get_announce_close_broadcast_events(&nodes, 3, 4);
2388         assert_eq!(nodes[3].node.list_channels().len(), 0);
2389         assert_eq!(nodes[4].node.list_channels().len(), 0);
2390 }
2391
2392 #[test]
2393 fn test_justice_tx() {
2394         // Test justice txn built on revoked HTLC-Success tx, against both sides
2395
2396         let nodes = create_network(2);
2397         // Create some new channels:
2398         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
2399
2400         // A pending HTLC which will be revoked:
2401         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2402         // Get the will-be-revoked local txn from nodes[0]
2403         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
2404         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2405         assert_eq!(revoked_local_txn[0].input.len(), 1);
2406         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2407         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2408         assert_eq!(revoked_local_txn[1].input.len(), 1);
2409         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2410         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2411         // Revoke the old state
2412         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2413
2414         {
2415                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2416                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2417                 {
2418                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2419                         assert_eq!(node_txn.len(), 3);
2420                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2421                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2422
2423                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2424                         node_txn.swap_remove(0);
2425                 }
2426                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2427
2428                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2429                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2430                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2431                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2432                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
2433         }
2434         get_announce_close_broadcast_events(&nodes, 0, 1);
2435
2436         assert_eq!(nodes[0].node.list_channels().len(), 0);
2437         assert_eq!(nodes[1].node.list_channels().len(), 0);
2438
2439         // We test justice_tx build by A on B's revoked HTLC-Success tx
2440         // Create some new channels:
2441         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
2442
2443         // A pending HTLC which will be revoked:
2444         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2445         // Get the will-be-revoked local txn from B
2446         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
2447         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2448         assert_eq!(revoked_local_txn[0].input.len(), 1);
2449         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2450         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2451         // Revoke the old state
2452         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2453         {
2454                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2455                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2456                 {
2457                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2458                         assert_eq!(node_txn.len(), 3);
2459                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2460                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2461
2462                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2463                         node_txn.swap_remove(0);
2464                 }
2465                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2466
2467                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2468                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2469                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2470                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2471                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
2472         }
2473         get_announce_close_broadcast_events(&nodes, 0, 1);
2474         assert_eq!(nodes[0].node.list_channels().len(), 0);
2475         assert_eq!(nodes[1].node.list_channels().len(), 0);
2476 }
2477
2478 #[test]
2479 fn revoked_output_claim() {
2480         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2481         // transaction is broadcast by its counterparty
2482         let nodes = create_network(2);
2483         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2484         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2485         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2486         assert_eq!(revoked_local_txn.len(), 1);
2487         // Only output is the full channel value back to nodes[0]:
2488         assert_eq!(revoked_local_txn[0].output.len(), 1);
2489         // Send a payment through, updating everyone's latest commitment txn
2490         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2491
2492         // Inform nodes[1] that nodes[0] broadcast a stale tx
2493         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2494         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2495         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2496         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2497
2498         assert_eq!(node_txn[0], node_txn[2]);
2499
2500         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2501         check_spends!(node_txn[1], chan_1.3.clone());
2502
2503         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2504         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2505         get_announce_close_broadcast_events(&nodes, 0, 1);
2506 }
2507
2508 #[test]
2509 fn claim_htlc_outputs_shared_tx() {
2510         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2511         let nodes = create_network(2);
2512
2513         // Create some new channel:
2514         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2515
2516         // Rebalance the network to generate htlc in the two directions
2517         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2518         // 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
2519         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2520         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2521
2522         // Get the will-be-revoked local txn from node[0]
2523         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2524         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2525         assert_eq!(revoked_local_txn[0].input.len(), 1);
2526         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2527         assert_eq!(revoked_local_txn[1].input.len(), 1);
2528         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2529         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2530         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2531
2532         //Revoke the old state
2533         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2534
2535         {
2536                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2538                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2539
2540                 let events = nodes[1].node.get_and_clear_pending_events();
2541                 assert_eq!(events.len(), 1);
2542                 match events[0] {
2543                         Event::PaymentFailed { payment_hash, .. } => {
2544                                 assert_eq!(payment_hash, payment_hash_2);
2545                         },
2546                         _ => panic!("Unexpected event"),
2547                 }
2548
2549                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2550                 assert_eq!(node_txn.len(), 4);
2551
2552                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2553                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2554
2555                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2556
2557                 let mut witness_lens = BTreeSet::new();
2558                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2559                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2560                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2561                 assert_eq!(witness_lens.len(), 3);
2562                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2563                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2564                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2565
2566                 // Next nodes[1] broadcasts its current local tx state:
2567                 assert_eq!(node_txn[1].input.len(), 1);
2568                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2569
2570                 assert_eq!(node_txn[2].input.len(), 1);
2571                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2572                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2573                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2574                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2575                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2576         }
2577         get_announce_close_broadcast_events(&nodes, 0, 1);
2578         assert_eq!(nodes[0].node.list_channels().len(), 0);
2579         assert_eq!(nodes[1].node.list_channels().len(), 0);
2580 }
2581
2582 #[test]
2583 fn claim_htlc_outputs_single_tx() {
2584         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2585         let nodes = create_network(2);
2586
2587         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2588
2589         // Rebalance the network to generate htlc in the two directions
2590         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2591         // 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
2592         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2593         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2594         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2595
2596         // Get the will-be-revoked local txn from node[0]
2597         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2598
2599         //Revoke the old state
2600         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2601
2602         {
2603                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2604                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2605                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2606
2607                 let events = nodes[1].node.get_and_clear_pending_events();
2608                 assert_eq!(events.len(), 1);
2609                 match events[0] {
2610                         Event::PaymentFailed { payment_hash, .. } => {
2611                                 assert_eq!(payment_hash, payment_hash_2);
2612                         },
2613                         _ => panic!("Unexpected event"),
2614                 }
2615
2616                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2617                 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)
2618
2619                 assert_eq!(node_txn[0], node_txn[7]);
2620                 assert_eq!(node_txn[1], node_txn[8]);
2621                 assert_eq!(node_txn[2], node_txn[9]);
2622                 assert_eq!(node_txn[3], node_txn[10]);
2623                 assert_eq!(node_txn[4], node_txn[11]);
2624                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
2625                 assert_eq!(node_txn[4], node_txn[6]);
2626
2627                 assert_eq!(node_txn[0].input.len(), 1);
2628                 assert_eq!(node_txn[1].input.len(), 1);
2629                 assert_eq!(node_txn[2].input.len(), 1);
2630
2631                 let mut revoked_tx_map = HashMap::new();
2632                 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
2633                 node_txn[0].verify(&revoked_tx_map).unwrap();
2634                 node_txn[1].verify(&revoked_tx_map).unwrap();
2635                 node_txn[2].verify(&revoked_tx_map).unwrap();
2636
2637                 let mut witness_lens = BTreeSet::new();
2638                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2639                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2640                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2641                 assert_eq!(witness_lens.len(), 3);
2642                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2643                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2644                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2645
2646                 assert_eq!(node_txn[3].input.len(), 1);
2647                 check_spends!(node_txn[3], chan_1.3.clone());
2648
2649                 assert_eq!(node_txn[4].input.len(), 1);
2650                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2651                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2652                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2653                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2654                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2655         }
2656         get_announce_close_broadcast_events(&nodes, 0, 1);
2657         assert_eq!(nodes[0].node.list_channels().len(), 0);
2658         assert_eq!(nodes[1].node.list_channels().len(), 0);
2659 }
2660
2661 #[test]
2662 fn test_htlc_on_chain_success() {
2663         // Test that in case of an unilateral close onchain, we detect the state of output thanks to
2664         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2665         // broadcasting the right event to other nodes in payment path.
2666         // A --------------------> B ----------------------> C (preimage)
2667         // First, C should claim the HTLC output via HTLC-Success when its own latest local
2668         // commitment transaction was broadcast.
2669         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2670         // towards B.
2671         // B should be able to claim via preimage if A then broadcasts its local tx.
2672         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2673         // the HTLC output via the preimage it learned (which, once confirmed should generate a
2674         // PaymentSent event).
2675
2676         let nodes = create_network(3);
2677
2678         // Create some initial channels
2679         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2680         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2681
2682         // Rebalance the network a bit by relaying one payment through all the channels...
2683         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2684         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2685
2686         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2687         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2688
2689         // Broadcast legit commitment tx from C on B's chain
2690         // Broadcast HTLC Success transation by C on received output from C's commitment tx on B's chain
2691         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2692         assert_eq!(commitment_tx.len(), 1);
2693         check_spends!(commitment_tx[0], chan_2.3.clone());
2694         nodes[2].node.claim_funds(our_payment_preimage);
2695         check_added_monitors!(nodes[2], 1);
2696         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2697         assert!(updates.update_add_htlcs.is_empty());
2698         assert!(updates.update_fail_htlcs.is_empty());
2699         assert!(updates.update_fail_malformed_htlcs.is_empty());
2700         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2701
2702         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2703         let events = nodes[2].node.get_and_clear_pending_msg_events();
2704         assert_eq!(events.len(), 1);
2705         match events[0] {
2706                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2707                 _ => panic!("Unexpected event"),
2708         }
2709         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2710         assert_eq!(node_txn.len(), 3);
2711         assert_eq!(node_txn[1], commitment_tx[0]);
2712         assert_eq!(node_txn[0], node_txn[2]);
2713         check_spends!(node_txn[0], commitment_tx[0].clone());
2714         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2715         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2716         assert_eq!(node_txn[0].lock_time, 0);
2717
2718         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2719         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
2720         let events = nodes[1].node.get_and_clear_pending_msg_events();
2721         {
2722                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2723                 assert_eq!(added_monitors.len(), 1);
2724                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2725                 added_monitors.clear();
2726         }
2727         assert_eq!(events.len(), 2);
2728         match events[0] {
2729                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2730                 _ => panic!("Unexpected event"),
2731         }
2732         match events[1] {
2733                 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, .. } } => {
2734                         assert!(update_add_htlcs.is_empty());
2735                         assert!(update_fail_htlcs.is_empty());
2736                         assert_eq!(update_fulfill_htlcs.len(), 1);
2737                         assert!(update_fail_malformed_htlcs.is_empty());
2738                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2739                 },
2740                 _ => panic!("Unexpected event"),
2741         };
2742         {
2743                 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2744                 // commitment transaction with a corresponding HTLC-Timeout transaction, as well as a
2745                 // timeout-claim of the output that nodes[2] just claimed via success.
2746                 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)
2747                 assert_eq!(node_txn.len(), 4);
2748                 assert_eq!(node_txn[0], node_txn[3]);
2749                 check_spends!(node_txn[0], commitment_tx[0].clone());
2750                 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2751                 assert_ne!(node_txn[0].lock_time, 0);
2752                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2753                 check_spends!(node_txn[1], chan_2.3.clone());
2754                 check_spends!(node_txn[2], node_txn[1].clone());
2755                 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2756                 assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2757                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2758                 assert_ne!(node_txn[2].lock_time, 0);
2759                 node_txn.clear();
2760         }
2761
2762         // Broadcast legit commitment tx from A on B's chain
2763         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2764         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2765         check_spends!(commitment_tx[0], chan_1.3.clone());
2766         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2767         let events = nodes[1].node.get_and_clear_pending_msg_events();
2768         assert_eq!(events.len(), 1);
2769         match events[0] {
2770                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2771                 _ => panic!("Unexpected event"),
2772         }
2773         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2774         assert_eq!(node_txn.len(), 3);
2775         assert_eq!(node_txn[0], node_txn[2]);
2776         check_spends!(node_txn[0], commitment_tx[0].clone());
2777         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2778         assert_eq!(node_txn[0].lock_time, 0);
2779         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2780         check_spends!(node_txn[1], chan_1.3.clone());
2781         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2782         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2783         // we already checked the same situation with A.
2784
2785         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2786         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2787         let events = nodes[0].node.get_and_clear_pending_msg_events();
2788         assert_eq!(events.len(), 1);
2789         match events[0] {
2790                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2791                 _ => panic!("Unexpected event"),
2792         }
2793         let events = nodes[0].node.get_and_clear_pending_events();
2794         assert_eq!(events.len(), 1);
2795         match events[0] {
2796                 Event::PaymentSent { payment_preimage } => {
2797                         assert_eq!(payment_preimage, our_payment_preimage);
2798                 },
2799                 _ => panic!("Unexpected event"),
2800         }
2801         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)
2802         assert_eq!(node_txn.len(), 4);
2803         assert_eq!(node_txn[0], node_txn[3]);
2804         check_spends!(node_txn[0], commitment_tx[0].clone());
2805         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2806         assert_ne!(node_txn[0].lock_time, 0);
2807         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2808         check_spends!(node_txn[1], chan_1.3.clone());
2809         check_spends!(node_txn[2], node_txn[1].clone());
2810         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2811         assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2812         assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2813         assert_ne!(node_txn[2].lock_time, 0);
2814 }
2815
2816 #[test]
2817 fn test_htlc_on_chain_timeout() {
2818         // Test that in case of an unilateral close onchain, we detect the state of output thanks to
2819         // ChainWatchInterface and timeout the HTLC  bacward accordingly. So here we test that ChannelManager is
2820         // broadcasting the right event to other nodes in payment path.
2821         // A ------------------> B ----------------------> C (timeout)
2822         //    B's commitment tx                 C's commitment tx
2823         //            \                                  \
2824         //         B's HTLC timeout tx               B's timeout tx
2825
2826         let nodes = create_network(3);
2827
2828         // Create some intial channels
2829         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2830         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2831
2832         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2833         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2834         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2835
2836         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2837         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2838
2839         // Brodacast legit commitment tx from C on B's chain
2840         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2841         check_spends!(commitment_tx[0], chan_2.3.clone());
2842         nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
2843         {
2844                 let mut added_monitors = nodes[2].chan_monitor.added_monitors.lock().unwrap();
2845                 assert_eq!(added_monitors.len(), 1);
2846                 added_monitors.clear();
2847         }
2848         let events = nodes[2].node.get_and_clear_pending_msg_events();
2849         assert_eq!(events.len(), 1);
2850         match events[0] {
2851                 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, .. } } => {
2852                         assert!(update_add_htlcs.is_empty());
2853                         assert!(!update_fail_htlcs.is_empty());
2854                         assert!(update_fulfill_htlcs.is_empty());
2855                         assert!(update_fail_malformed_htlcs.is_empty());
2856                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2857                 },
2858                 _ => panic!("Unexpected event"),
2859         };
2860         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2861         let events = nodes[2].node.get_and_clear_pending_msg_events();
2862         assert_eq!(events.len(), 1);
2863         match events[0] {
2864                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2865                 _ => panic!("Unexpected event"),
2866         }
2867         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2868         assert_eq!(node_txn.len(), 1);
2869         check_spends!(node_txn[0], chan_2.3.clone());
2870         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2871
2872         // Broadcast timeout transaction by B on received output fron C's commitment tx on B's chain
2873         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2874         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2875         let timeout_tx;
2876         {
2877                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2878                 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)
2879                 assert_eq!(node_txn[0], node_txn[5]);
2880                 assert_eq!(node_txn[1], node_txn[6]);
2881                 assert_eq!(node_txn[2], node_txn[7]);
2882                 check_spends!(node_txn[0], commitment_tx[0].clone());
2883                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2884                 check_spends!(node_txn[1], chan_2.3.clone());
2885                 check_spends!(node_txn[2], node_txn[1].clone());
2886                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2887                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888                 check_spends!(node_txn[3], chan_2.3.clone());
2889                 check_spends!(node_txn[4], node_txn[3].clone());
2890                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2891                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2892                 timeout_tx = node_txn[0].clone();
2893                 node_txn.clear();
2894         }
2895
2896         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
2897         let events = nodes[1].node.get_and_clear_pending_msg_events();
2898         check_added_monitors!(nodes[1], 1);
2899         assert_eq!(events.len(), 2);
2900         match events[0] {
2901                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2902                 _ => panic!("Unexpected event"),
2903         }
2904         match events[1] {
2905                 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, .. } } => {
2906                         assert!(update_add_htlcs.is_empty());
2907                         assert!(!update_fail_htlcs.is_empty());
2908                         assert!(update_fulfill_htlcs.is_empty());
2909                         assert!(update_fail_malformed_htlcs.is_empty());
2910                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2911                 },
2912                 _ => panic!("Unexpected event"),
2913         };
2914         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
2915         assert_eq!(node_txn.len(), 0);
2916
2917         // Broadcast legit commitment tx from B on A's chain
2918         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2919         check_spends!(commitment_tx[0], chan_1.3.clone());
2920
2921         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2922         let events = nodes[0].node.get_and_clear_pending_msg_events();
2923         assert_eq!(events.len(), 1);
2924         match events[0] {
2925                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2926                 _ => panic!("Unexpected event"),
2927         }
2928         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
2929         assert_eq!(node_txn.len(), 4);
2930         assert_eq!(node_txn[0], node_txn[3]);
2931         check_spends!(node_txn[0], commitment_tx[0].clone());
2932         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2933         check_spends!(node_txn[1], chan_1.3.clone());
2934         check_spends!(node_txn[2], node_txn[1].clone());
2935         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2936         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2937 }
2938
2939 #[test]
2940 fn test_simple_commitment_revoked_fail_backward() {
2941         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2942         // and fail backward accordingly.
2943
2944         let nodes = create_network(3);
2945
2946         // Create some initial channels
2947         create_announced_chan_between_nodes(&nodes, 0, 1);
2948         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2949
2950         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2951         // Get the will-be-revoked local txn from nodes[2]
2952         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2953         // Revoke the old state
2954         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2955
2956         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2957
2958         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2959         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2960         let events = nodes[1].node.get_and_clear_pending_msg_events();
2961         check_added_monitors!(nodes[1], 1);
2962         assert_eq!(events.len(), 2);
2963         match events[0] {
2964                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2965                 _ => panic!("Unexpected event"),
2966         }
2967         match events[1] {
2968                 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, .. } } => {
2969                         assert!(update_add_htlcs.is_empty());
2970                         assert_eq!(update_fail_htlcs.len(), 1);
2971                         assert!(update_fulfill_htlcs.is_empty());
2972                         assert!(update_fail_malformed_htlcs.is_empty());
2973                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2974
2975                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2976                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2977
2978                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2979                         assert_eq!(events.len(), 1);
2980                         match events[0] {
2981                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2982                                 _ => panic!("Unexpected event"),
2983                         }
2984                         let events = nodes[0].node.get_and_clear_pending_events();
2985                         assert_eq!(events.len(), 1);
2986                         match events[0] {
2987                                 Event::PaymentFailed { .. } => {},
2988                                 _ => panic!("Unexpected event"),
2989                         }
2990                 },
2991                 _ => panic!("Unexpected event"),
2992         }
2993 }
2994
2995 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool) {
2996         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2997         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2998         // commitment transaction anymore.
2999         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3000         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3001         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3002         // technically disallowed and we should probably handle it reasonably.
3003         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3004         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3005         // transactions:
3006         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3007         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3008         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3009         //   and once they revoke the previous commitment transaction (allowing us to send a new
3010         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3011         let mut nodes = create_network(3);
3012
3013         // Create some initial channels
3014         create_announced_chan_between_nodes(&nodes, 0, 1);
3015         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3016
3017         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3018         // Get the will-be-revoked local txn from nodes[2]
3019         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3020         // Revoke the old state
3021         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3022
3023         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3024         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3025         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3026
3027         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, 0));
3028         check_added_monitors!(nodes[2], 1);
3029         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3030         assert!(updates.update_add_htlcs.is_empty());
3031         assert!(updates.update_fulfill_htlcs.is_empty());
3032         assert!(updates.update_fail_malformed_htlcs.is_empty());
3033         assert_eq!(updates.update_fail_htlcs.len(), 1);
3034         assert!(updates.update_fee.is_none());
3035         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3036         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3037         // Drop the last RAA from 3 -> 2
3038
3039         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, 0));
3040         check_added_monitors!(nodes[2], 1);
3041         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3042         assert!(updates.update_add_htlcs.is_empty());
3043         assert!(updates.update_fulfill_htlcs.is_empty());
3044         assert!(updates.update_fail_malformed_htlcs.is_empty());
3045         assert_eq!(updates.update_fail_htlcs.len(), 1);
3046         assert!(updates.update_fee.is_none());
3047         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3048         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3049         check_added_monitors!(nodes[1], 1);
3050         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3051         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3052         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3053         check_added_monitors!(nodes[2], 1);
3054
3055         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, 0));
3056         check_added_monitors!(nodes[2], 1);
3057         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3058         assert!(updates.update_add_htlcs.is_empty());
3059         assert!(updates.update_fulfill_htlcs.is_empty());
3060         assert!(updates.update_fail_malformed_htlcs.is_empty());
3061         assert_eq!(updates.update_fail_htlcs.len(), 1);
3062         assert!(updates.update_fee.is_none());
3063         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3064         // At this point first_payment_hash has dropped out of the latest two commitment
3065         // transactions that nodes[1] is tracking...
3066         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3067         check_added_monitors!(nodes[1], 1);
3068         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3069         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3070         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3071         check_added_monitors!(nodes[2], 1);
3072
3073         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3074         // on nodes[2]'s RAA.
3075         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3076         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3077         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
3078         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3079         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3080         check_added_monitors!(nodes[1], 0);
3081
3082         if deliver_bs_raa {
3083                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
3084                 // One monitor for the new revocation preimage, one as we generate a commitment for
3085                 // nodes[0] to fail first_payment_hash backwards.
3086                 check_added_monitors!(nodes[1], 2);
3087         }
3088
3089         let mut failed_htlcs = HashSet::new();
3090         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3091
3092         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3093         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3094
3095         let events = nodes[1].node.get_and_clear_pending_events();
3096         assert_eq!(events.len(), 1);
3097         match events[0] {
3098                 Event::PaymentFailed { ref payment_hash, .. } => {
3099                         assert_eq!(*payment_hash, fourth_payment_hash);
3100                 },
3101                 _ => panic!("Unexpected event"),
3102         }
3103
3104         if !deliver_bs_raa {
3105                 // If we delivered the RAA already then we already failed first_payment_hash backwards.
3106                 check_added_monitors!(nodes[1], 1);
3107         }
3108
3109         let events = nodes[1].node.get_and_clear_pending_msg_events();
3110         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3111         match events[if deliver_bs_raa { 2 } else { 0 }] {
3112                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3113                 _ => panic!("Unexpected event"),
3114         }
3115         if deliver_bs_raa {
3116                 match events[0] {
3117                         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, .. } } => {
3118                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3119                                 assert_eq!(update_add_htlcs.len(), 1);
3120                                 assert!(update_fulfill_htlcs.is_empty());
3121                                 assert!(update_fail_htlcs.is_empty());
3122                                 assert!(update_fail_malformed_htlcs.is_empty());
3123                         },
3124                         _ => panic!("Unexpected event"),
3125                 }
3126         }
3127         // Due to the way backwards-failing occurs we do the updates in two steps.
3128         let updates = match events[1] {
3129                 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, .. } } => {
3130                         assert!(update_add_htlcs.is_empty());
3131                         assert_eq!(update_fail_htlcs.len(), 1);
3132                         assert!(update_fulfill_htlcs.is_empty());
3133                         assert!(update_fail_malformed_htlcs.is_empty());
3134                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3135
3136                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
3137                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3138                         check_added_monitors!(nodes[0], 1);
3139                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3140                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3141                         check_added_monitors!(nodes[1], 1);
3142                         let bs_second_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3143                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
3144                         check_added_monitors!(nodes[1], 1);
3145                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3146                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3147                         check_added_monitors!(nodes[0], 1);
3148
3149                         if !deliver_bs_raa {
3150                                 // If we delievered B's RAA we got an unknown preimage error, not something
3151                                 // that we should update our routing table for.
3152                                 let events = nodes[0].node.get_and_clear_pending_msg_events();
3153                                 assert_eq!(events.len(), 1);
3154                                 match events[0] {
3155                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3156                                         _ => panic!("Unexpected event"),
3157                                 }
3158                         }
3159                         let events = nodes[0].node.get_and_clear_pending_events();
3160                         assert_eq!(events.len(), 1);
3161                         match events[0] {
3162                                 Event::PaymentFailed { ref payment_hash, .. } => {
3163                                         assert!(failed_htlcs.insert(payment_hash.0));
3164                                 },
3165                                 _ => panic!("Unexpected event"),
3166                         }
3167
3168                         bs_second_update
3169                 },
3170                 _ => panic!("Unexpected event"),
3171         };
3172
3173         assert!(updates.update_add_htlcs.is_empty());
3174         assert_eq!(updates.update_fail_htlcs.len(), 2);
3175         assert!(updates.update_fulfill_htlcs.is_empty());
3176         assert!(updates.update_fail_malformed_htlcs.is_empty());
3177         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3178         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
3179         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
3180
3181         let events = nodes[0].node.get_and_clear_pending_msg_events();
3182         assert_eq!(events.len(), 2);
3183         for event in events {
3184                 match event {
3185                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3186                         _ => panic!("Unexpected event"),
3187                 }
3188         }
3189
3190         let events = nodes[0].node.get_and_clear_pending_events();
3191         assert_eq!(events.len(), 2);
3192         match events[0] {
3193                 Event::PaymentFailed { ref payment_hash, .. } => {
3194                         assert!(failed_htlcs.insert(payment_hash.0));
3195                 },
3196                 _ => panic!("Unexpected event"),
3197         }
3198         match events[1] {
3199                 Event::PaymentFailed { ref payment_hash, .. } => {
3200                         assert!(failed_htlcs.insert(payment_hash.0));
3201                 },
3202                 _ => panic!("Unexpected event"),
3203         }
3204
3205         assert!(failed_htlcs.contains(&first_payment_hash.0));
3206         assert!(failed_htlcs.contains(&second_payment_hash.0));
3207         assert!(failed_htlcs.contains(&third_payment_hash.0));
3208 }
3209
3210 #[test]
3211 fn test_commitment_revoked_fail_backward_exhaustive() {
3212         do_test_commitment_revoked_fail_backward_exhaustive(false);
3213         do_test_commitment_revoked_fail_backward_exhaustive(true);
3214 }
3215
3216 #[test]
3217 fn test_htlc_ignore_latest_remote_commitment() {
3218         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3219         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3220         let nodes = create_network(2);
3221         create_announced_chan_between_nodes(&nodes, 0, 1);
3222
3223         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3224         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3225         {
3226                 let events = nodes[0].node.get_and_clear_pending_msg_events();
3227                 assert_eq!(events.len(), 1);
3228                 match events[0] {
3229                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
3230                                 assert_eq!(flags & 0b10, 0b10);
3231                         },
3232                         _ => panic!("Unexpected event"),
3233                 }
3234         }
3235
3236         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3237         assert_eq!(node_txn.len(), 2);
3238
3239         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3240         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3241
3242         {
3243                 let events = nodes[1].node.get_and_clear_pending_msg_events();
3244                 assert_eq!(events.len(), 1);
3245                 match events[0] {
3246                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
3247                                 assert_eq!(flags & 0b10, 0b10);
3248                         },
3249                         _ => panic!("Unexpected event"),
3250                 }
3251         }
3252
3253         // Duplicate the block_connected call since this may happen due to other listeners
3254         // registering new transactions
3255         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3256 }
3257
3258 #[test]
3259 fn test_force_close_fail_back() {
3260         // Check which HTLCs are failed-backwards on channel force-closure
3261         let mut nodes = create_network(3);
3262         create_announced_chan_between_nodes(&nodes, 0, 1);
3263         create_announced_chan_between_nodes(&nodes, 1, 2);
3264
3265         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3266
3267         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3268
3269         let mut payment_event = {
3270                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3271                 check_added_monitors!(nodes[0], 1);
3272
3273                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3274                 assert_eq!(events.len(), 1);
3275                 SendEvent::from_event(events.remove(0))
3276         };
3277
3278         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3279         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3280
3281         let events_1 = nodes[1].node.get_and_clear_pending_events();
3282         assert_eq!(events_1.len(), 1);
3283         match events_1[0] {
3284                 Event::PendingHTLCsForwardable { .. } => { },
3285                 _ => panic!("Unexpected event"),
3286         };
3287
3288         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3289         nodes[1].node.process_pending_htlc_forwards();
3290
3291         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3292         assert_eq!(events_2.len(), 1);
3293         payment_event = SendEvent::from_event(events_2.remove(0));
3294         assert_eq!(payment_event.msgs.len(), 1);
3295
3296         check_added_monitors!(nodes[1], 1);
3297         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3298         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3299         check_added_monitors!(nodes[2], 1);
3300         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3301
3302         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3303         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3304         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3305
3306         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3307         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
3308         assert_eq!(events_3.len(), 1);
3309         match events_3[0] {
3310                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
3311                         assert_eq!(flags & 0b10, 0b10);
3312                 },
3313                 _ => panic!("Unexpected event"),
3314         }
3315
3316         let tx = {
3317                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3318                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3319                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3320                 // back to nodes[1] upon timeout otherwise.
3321                 assert_eq!(node_txn.len(), 1);
3322                 node_txn.remove(0)
3323         };
3324
3325         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3326         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3327
3328         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3329         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3330         assert_eq!(events_4.len(), 1);
3331         match events_4[0] {
3332                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
3333                         assert_eq!(flags & 0b10, 0b10);
3334                 },
3335                 _ => panic!("Unexpected event"),
3336         }
3337
3338         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3339         {
3340                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3341                 monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
3342                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3343         }
3344         nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3345         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3346         assert_eq!(node_txn.len(), 1);
3347         assert_eq!(node_txn[0].input.len(), 1);
3348         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3349         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3350         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3351
3352         check_spends!(node_txn[0], tx);
3353 }
3354
3355 #[test]
3356 fn test_unconf_chan() {
3357         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3358         let nodes = create_network(2);
3359         create_announced_chan_between_nodes(&nodes, 0, 1);
3360
3361         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3362         assert_eq!(channel_state.by_id.len(), 1);
3363         assert_eq!(channel_state.short_to_id.len(), 1);
3364         mem::drop(channel_state);
3365
3366         let mut headers = Vec::new();
3367         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3368         headers.push(header.clone());
3369         for _i in 2..100 {
3370                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3371                 headers.push(header.clone());
3372         }
3373         while !headers.is_empty() {
3374                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3375         }
3376         {
3377                 let events = nodes[0].node.get_and_clear_pending_msg_events();
3378                 assert_eq!(events.len(), 1);
3379                 match events[0] {
3380                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
3381                                 assert_eq!(flags & 0b10, 0b10);
3382                         },
3383                         _ => panic!("Unexpected event"),
3384                 }
3385         }
3386         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3387         assert_eq!(channel_state.by_id.len(), 0);
3388         assert_eq!(channel_state.short_to_id.len(), 0);
3389 }
3390
3391 macro_rules! get_chan_reestablish_msgs {
3392         ($src_node: expr, $dst_node: expr) => {
3393                 {
3394                         let mut res = Vec::with_capacity(1);
3395                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
3396                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3397                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3398                                         res.push(msg.clone());
3399                                 } else {
3400                                         panic!("Unexpected event")
3401                                 }
3402                         }
3403                         res
3404                 }
3405         }
3406 }
3407
3408 macro_rules! handle_chan_reestablish_msgs {
3409         ($src_node: expr, $dst_node: expr) => {
3410                 {
3411                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3412                         let mut idx = 0;
3413                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
3414                                 idx += 1;
3415                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3416                                 Some(msg.clone())
3417                         } else {
3418                                 None
3419                         };
3420
3421                         let mut revoke_and_ack = None;
3422                         let mut commitment_update = None;
3423                         let order = if let Some(ev) = msg_events.get(idx) {
3424                                 idx += 1;
3425                                 match ev {
3426                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3427                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3428                                                 revoke_and_ack = Some(msg.clone());
3429                                                 RAACommitmentOrder::RevokeAndACKFirst
3430                                         },
3431                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3432                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3433                                                 commitment_update = Some(updates.clone());
3434                                                 RAACommitmentOrder::CommitmentFirst
3435                                         },
3436                                         _ => panic!("Unexpected event"),
3437                                 }
3438                         } else {
3439                                 RAACommitmentOrder::CommitmentFirst
3440                         };
3441
3442                         if let Some(ev) = msg_events.get(idx) {
3443                                 match ev {
3444                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3445                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3446                                                 assert!(revoke_and_ack.is_none());
3447                                                 revoke_and_ack = Some(msg.clone());
3448                                         },
3449                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3450                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3451                                                 assert!(commitment_update.is_none());
3452                                                 commitment_update = Some(updates.clone());
3453                                         },
3454                                         _ => panic!("Unexpected event"),
3455                                 }
3456                         }
3457
3458                         (funding_locked, revoke_and_ack, commitment_update, order)
3459                 }
3460         }
3461 }
3462
3463 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3464 /// for claims/fails they are separated out.
3465 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)) {
3466         node_a.node.peer_connected(&node_b.node.get_our_node_id());
3467         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3468         node_b.node.peer_connected(&node_a.node.get_our_node_id());
3469         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3470
3471         if send_funding_locked.0 {
3472                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
3473                 // from b
3474                 for reestablish in reestablish_1.iter() {
3475                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3476                 }
3477         }
3478         if send_funding_locked.1 {
3479                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
3480                 // from a
3481                 for reestablish in reestablish_2.iter() {
3482                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3483                 }
3484         }
3485         if send_funding_locked.0 || send_funding_locked.1 {
3486                 // If we expect any funding_locked's, both sides better have set
3487                 // next_local_commitment_number to 1
3488                 for reestablish in reestablish_1.iter() {
3489                         assert_eq!(reestablish.next_local_commitment_number, 1);
3490                 }
3491                 for reestablish in reestablish_2.iter() {
3492                         assert_eq!(reestablish.next_local_commitment_number, 1);
3493                 }
3494         }
3495
3496         let mut resp_1 = Vec::new();
3497         for msg in reestablish_1 {
3498                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
3499                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3500         }
3501         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3502                 check_added_monitors!(node_b, 1);
3503         } else {
3504                 check_added_monitors!(node_b, 0);
3505         }
3506
3507         let mut resp_2 = Vec::new();
3508         for msg in reestablish_2 {
3509                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
3510                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3511         }
3512         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3513                 check_added_monitors!(node_a, 1);
3514         } else {
3515                 check_added_monitors!(node_a, 0);
3516         }
3517
3518         // We dont yet support both needing updates, as that would require a different commitment dance:
3519         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3520                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3521
3522         for chan_msgs in resp_1.drain(..) {
3523                 if send_funding_locked.0 {
3524                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3525                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3526                         if !announcement_event.is_empty() {
3527                                 assert_eq!(announcement_event.len(), 1);
3528                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3529                                         //TODO: Test announcement_sigs re-sending
3530                                 } else { panic!("Unexpected event!"); }
3531                         }
3532                 } else {
3533                         assert!(chan_msgs.0.is_none());
3534                 }
3535                 if pending_raa.0 {
3536                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3537                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3538                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3539                         check_added_monitors!(node_a, 1);
3540                 } else {
3541                         assert!(chan_msgs.1.is_none());
3542                 }
3543                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3544                         let commitment_update = chan_msgs.2.unwrap();
3545                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3546                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3547                         } else {
3548                                 assert!(commitment_update.update_add_htlcs.is_empty());
3549                         }
3550                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3551                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3552                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3553                         for update_add in commitment_update.update_add_htlcs {
3554                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
3555                         }
3556                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3557                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
3558                         }
3559                         for update_fail in commitment_update.update_fail_htlcs {
3560                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
3561                         }
3562
3563                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3564                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3565                         } else {
3566                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3567                                 check_added_monitors!(node_a, 1);
3568                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3569                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3570                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3571                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3572                                 check_added_monitors!(node_b, 1);
3573                         }
3574                 } else {
3575                         assert!(chan_msgs.2.is_none());
3576                 }
3577         }
3578
3579         for chan_msgs in resp_2.drain(..) {
3580                 if send_funding_locked.1 {
3581                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3582                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3583                         if !announcement_event.is_empty() {
3584                                 assert_eq!(announcement_event.len(), 1);
3585                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3586                                         //TODO: Test announcement_sigs re-sending
3587                                 } else { panic!("Unexpected event!"); }
3588                         }
3589                 } else {
3590                         assert!(chan_msgs.0.is_none());
3591                 }
3592                 if pending_raa.1 {
3593                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3594                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3595                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3596                         check_added_monitors!(node_b, 1);
3597                 } else {
3598                         assert!(chan_msgs.1.is_none());
3599                 }
3600                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3601                         let commitment_update = chan_msgs.2.unwrap();
3602                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3603                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3604                         }
3605                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3606                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3607                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3608                         for update_add in commitment_update.update_add_htlcs {
3609                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
3610                         }
3611                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3612                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
3613                         }
3614                         for update_fail in commitment_update.update_fail_htlcs {
3615                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
3616                         }
3617
3618                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3619                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3620                         } else {
3621                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3622                                 check_added_monitors!(node_b, 1);
3623                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3624                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3625                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3626                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3627                                 check_added_monitors!(node_a, 1);
3628                         }
3629                 } else {
3630                         assert!(chan_msgs.2.is_none());
3631                 }
3632         }
3633 }
3634
3635 #[test]
3636 fn test_simple_peer_disconnect() {
3637         // Test that we can reconnect when there are no lost messages
3638         let nodes = create_network(3);
3639         create_announced_chan_between_nodes(&nodes, 0, 1);
3640         create_announced_chan_between_nodes(&nodes, 1, 2);
3641
3642         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3643         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3644         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3645
3646         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3647         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3648         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3649         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3650
3651         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3652         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3653         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3654
3655         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3656         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3657         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3658         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3659
3660         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3661         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3662
3663         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
3664         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3665
3666         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3667         {
3668                 let events = nodes[0].node.get_and_clear_pending_events();
3669                 assert_eq!(events.len(), 2);
3670                 match events[0] {
3671                         Event::PaymentSent { payment_preimage } => {
3672                                 assert_eq!(payment_preimage, payment_preimage_3);
3673                         },
3674                         _ => panic!("Unexpected event"),
3675                 }
3676                 match events[1] {
3677                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3678                                 assert_eq!(payment_hash, payment_hash_5);
3679                                 assert!(rejected_by_dest);
3680                         },
3681                         _ => panic!("Unexpected event"),
3682                 }
3683         }
3684
3685         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3686         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3687 }
3688
3689 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3690         // Test that we can reconnect when in-flight HTLC updates get dropped
3691         let mut nodes = create_network(2);
3692         if messages_delivered == 0 {
3693                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3694                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3695         } else {
3696                 create_announced_chan_between_nodes(&nodes, 0, 1);
3697         }
3698
3699         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();
3700         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3701
3702         let payment_event = {
3703                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3704                 check_added_monitors!(nodes[0], 1);
3705
3706                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3707                 assert_eq!(events.len(), 1);
3708                 SendEvent::from_event(events.remove(0))
3709         };
3710         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3711
3712         if messages_delivered < 2 {
3713                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3714         } else {
3715                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3716                 if messages_delivered >= 3 {
3717                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3718                         check_added_monitors!(nodes[1], 1);
3719                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3720
3721                         if messages_delivered >= 4 {
3722                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3723                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3724                                 check_added_monitors!(nodes[0], 1);
3725
3726                                 if messages_delivered >= 5 {
3727                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
3728                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3729                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3730                                         check_added_monitors!(nodes[0], 1);
3731
3732                                         if messages_delivered >= 6 {
3733                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3734                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3735                                                 check_added_monitors!(nodes[1], 1);
3736                                         }
3737                                 }
3738                         }
3739                 }
3740         }
3741
3742         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3743         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3744         if messages_delivered < 3 {
3745                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3746                 // received on either side, both sides will need to resend them.
3747                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3748         } else if messages_delivered == 3 {
3749                 // nodes[0] still wants its RAA + commitment_signed
3750                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3751         } else if messages_delivered == 4 {
3752                 // nodes[0] still wants its commitment_signed
3753                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3754         } else if messages_delivered == 5 {
3755                 // nodes[1] still wants its final RAA
3756                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3757         } else if messages_delivered == 6 {
3758                 // Everything was delivered...
3759                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3760         }
3761
3762         let events_1 = nodes[1].node.get_and_clear_pending_events();
3763         assert_eq!(events_1.len(), 1);
3764         match events_1[0] {
3765                 Event::PendingHTLCsForwardable { .. } => { },
3766                 _ => panic!("Unexpected event"),
3767         };
3768
3769         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3770         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3771         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3772
3773         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3774         nodes[1].node.process_pending_htlc_forwards();
3775
3776         let events_2 = nodes[1].node.get_and_clear_pending_events();
3777         assert_eq!(events_2.len(), 1);
3778         match events_2[0] {
3779                 Event::PaymentReceived { ref payment_hash, amt } => {
3780                         assert_eq!(payment_hash_1, *payment_hash);
3781                         assert_eq!(amt, 1000000);
3782                 },
3783                 _ => panic!("Unexpected event"),
3784         }
3785
3786         nodes[1].node.claim_funds(payment_preimage_1);
3787         check_added_monitors!(nodes[1], 1);
3788
3789         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3790         assert_eq!(events_3.len(), 1);
3791         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3792                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3793                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3794                         assert!(updates.update_add_htlcs.is_empty());
3795                         assert!(updates.update_fail_htlcs.is_empty());
3796                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3797                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3798                         assert!(updates.update_fee.is_none());
3799                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3800                 },
3801                 _ => panic!("Unexpected event"),
3802         };
3803
3804         if messages_delivered >= 1 {
3805                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
3806
3807                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3808                 assert_eq!(events_4.len(), 1);
3809                 match events_4[0] {
3810                         Event::PaymentSent { ref payment_preimage } => {
3811                                 assert_eq!(payment_preimage_1, *payment_preimage);
3812                         },
3813                         _ => panic!("Unexpected event"),
3814                 }
3815
3816                 if messages_delivered >= 2 {
3817                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3818                         check_added_monitors!(nodes[0], 1);
3819                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3820
3821                         if messages_delivered >= 3 {
3822                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3823                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3824                                 check_added_monitors!(nodes[1], 1);
3825
3826                                 if messages_delivered >= 4 {
3827                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
3828                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3829                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3830                                         check_added_monitors!(nodes[1], 1);
3831
3832                                         if messages_delivered >= 5 {
3833                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3834                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3835                                                 check_added_monitors!(nodes[0], 1);
3836                                         }
3837                                 }
3838                         }
3839                 }
3840         }
3841
3842         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3843         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3844         if messages_delivered < 2 {
3845                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3846                 //TODO: Deduplicate PaymentSent events, then enable this if:
3847                 //if messages_delivered < 1 {
3848                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3849                         assert_eq!(events_4.len(), 1);
3850                         match events_4[0] {
3851                                 Event::PaymentSent { ref payment_preimage } => {
3852                                         assert_eq!(payment_preimage_1, *payment_preimage);
3853                                 },
3854                                 _ => panic!("Unexpected event"),
3855                         }
3856                 //}
3857         } else if messages_delivered == 2 {
3858                 // nodes[0] still wants its RAA + commitment_signed
3859                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3860         } else if messages_delivered == 3 {
3861                 // nodes[0] still wants its commitment_signed
3862                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3863         } else if messages_delivered == 4 {
3864                 // nodes[1] still wants its final RAA
3865                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3866         } else if messages_delivered == 5 {
3867                 // Everything was delivered...
3868                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3869         }
3870
3871         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3872         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3873         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3874
3875         // Channel should still work fine...
3876         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3877         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3878 }
3879
3880 #[test]
3881 fn test_drop_messages_peer_disconnect_a() {
3882         do_test_drop_messages_peer_disconnect(0);
3883         do_test_drop_messages_peer_disconnect(1);
3884         do_test_drop_messages_peer_disconnect(2);
3885         do_test_drop_messages_peer_disconnect(3);
3886 }
3887
3888 #[test]
3889 fn test_drop_messages_peer_disconnect_b() {
3890         do_test_drop_messages_peer_disconnect(4);
3891         do_test_drop_messages_peer_disconnect(5);
3892         do_test_drop_messages_peer_disconnect(6);
3893 }
3894
3895 #[test]
3896 fn test_funding_peer_disconnect() {
3897         // Test that we can lock in our funding tx while disconnected
3898         let nodes = create_network(2);
3899         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3900
3901         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3902         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3903
3904         confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
3905         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3906         assert_eq!(events_1.len(), 1);
3907         match events_1[0] {
3908                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3909                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3910                 },
3911                 _ => panic!("Unexpected event"),
3912         }
3913
3914         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3915
3916         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3917         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3918
3919         confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
3920         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3921         assert_eq!(events_2.len(), 2);
3922         match events_2[0] {
3923                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3924                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3925                 },
3926                 _ => panic!("Unexpected event"),
3927         }
3928         match events_2[1] {
3929                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
3930                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3931                 },
3932                 _ => panic!("Unexpected event"),
3933         }
3934
3935         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3936
3937         // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
3938         // rebroadcasting announcement_signatures upon reconnect.
3939
3940         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();
3941         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3942         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3943 }
3944
3945 #[test]
3946 fn test_drop_messages_peer_disconnect_dual_htlc() {
3947         // Test that we can handle reconnecting when both sides of a channel have pending
3948         // commitment_updates when we disconnect.
3949         let mut nodes = create_network(2);
3950         create_announced_chan_between_nodes(&nodes, 0, 1);
3951
3952         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3953
3954         // Now try to send a second payment which will fail to send
3955         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3956         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3957
3958         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3959         check_added_monitors!(nodes[0], 1);
3960
3961         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3962         assert_eq!(events_1.len(), 1);
3963         match events_1[0] {
3964                 MessageSendEvent::UpdateHTLCs { .. } => {},
3965                 _ => panic!("Unexpected event"),
3966         }
3967
3968         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3969         check_added_monitors!(nodes[1], 1);
3970
3971         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3972         assert_eq!(events_2.len(), 1);
3973         match events_2[0] {
3974                 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 } } => {
3975                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3976                         assert!(update_add_htlcs.is_empty());
3977                         assert_eq!(update_fulfill_htlcs.len(), 1);
3978                         assert!(update_fail_htlcs.is_empty());
3979                         assert!(update_fail_malformed_htlcs.is_empty());
3980                         assert!(update_fee.is_none());
3981
3982                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3983                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3984                         assert_eq!(events_3.len(), 1);
3985                         match events_3[0] {
3986                                 Event::PaymentSent { ref payment_preimage } => {
3987                                         assert_eq!(*payment_preimage, payment_preimage_1);
3988                                 },
3989                                 _ => panic!("Unexpected event"),
3990                         }
3991
3992                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3993                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3994                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3995                         check_added_monitors!(nodes[0], 1);
3996                 },
3997                 _ => panic!("Unexpected event"),
3998         }
3999
4000         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4001         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4002
4003         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4004         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4005         assert_eq!(reestablish_1.len(), 1);
4006         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4007         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4008         assert_eq!(reestablish_2.len(), 1);
4009
4010         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4011         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4012         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4013         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4014
4015         assert!(as_resp.0.is_none());
4016         assert!(bs_resp.0.is_none());
4017
4018         assert!(bs_resp.1.is_none());
4019         assert!(bs_resp.2.is_none());
4020
4021         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4022
4023         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4024         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4025         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4026         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4027         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4028         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();
4029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
4030         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4031         // No commitment_signed so get_event_msg's assert(len == 1) passes
4032         check_added_monitors!(nodes[1], 1);
4033
4034         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
4035         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4036         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4037         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4038         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4039         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4040         assert!(bs_second_commitment_signed.update_fee.is_none());
4041         check_added_monitors!(nodes[1], 1);
4042
4043         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4044         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4045         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4046         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4047         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4048         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4049         assert!(as_commitment_signed.update_fee.is_none());
4050         check_added_monitors!(nodes[0], 1);
4051
4052         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
4053         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4054         // No commitment_signed so get_event_msg's assert(len == 1) passes
4055         check_added_monitors!(nodes[0], 1);
4056
4057         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
4058         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4059         // No commitment_signed so get_event_msg's assert(len == 1) passes
4060         check_added_monitors!(nodes[1], 1);
4061
4062         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
4063         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4064         check_added_monitors!(nodes[1], 1);
4065
4066         let events_4 = nodes[1].node.get_and_clear_pending_events();
4067         assert_eq!(events_4.len(), 1);
4068         match events_4[0] {
4069                 Event::PendingHTLCsForwardable { .. } => { },
4070                 _ => panic!("Unexpected event"),
4071         };
4072
4073         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4074         nodes[1].node.process_pending_htlc_forwards();
4075
4076         let events_5 = nodes[1].node.get_and_clear_pending_events();
4077         assert_eq!(events_5.len(), 1);
4078         match events_5[0] {
4079                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
4080                         assert_eq!(payment_hash_2, *payment_hash);
4081                 },
4082                 _ => panic!("Unexpected event"),
4083         }
4084
4085         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
4086         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4087         check_added_monitors!(nodes[0], 1);
4088
4089         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4090 }
4091
4092 #[test]
4093 fn test_simple_monitor_permanent_update_fail() {
4094         // Test that we handle a simple permanent monitor update failure
4095         let mut nodes = create_network(2);
4096         create_announced_chan_between_nodes(&nodes, 0, 1);
4097
4098         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4099         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
4100
4101         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
4102         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
4103         check_added_monitors!(nodes[0], 1);
4104
4105         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4106         assert_eq!(events_1.len(), 2);
4107         match events_1[0] {
4108                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4109                 _ => panic!("Unexpected event"),
4110         };
4111         match events_1[1] {
4112                 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
4113                 _ => panic!("Unexpected event"),
4114         };
4115
4116         // TODO: Once we hit the chain with the failure transaction we should check that we get a
4117         // PaymentFailed event
4118
4119         assert_eq!(nodes[0].node.list_channels().len(), 0);
4120 }
4121
4122 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
4123         // Test that we can recover from a simple temporary monitor update failure optionally with
4124         // a disconnect in between
4125         let mut nodes = create_network(2);
4126         create_announced_chan_between_nodes(&nodes, 0, 1);
4127
4128         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4129         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
4130
4131         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4132         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
4133         check_added_monitors!(nodes[0], 1);
4134
4135         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4136         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4137         assert_eq!(nodes[0].node.list_channels().len(), 1);
4138
4139         if disconnect {
4140                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4141                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4142                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4143         }
4144
4145         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4146         nodes[0].node.test_restore_channel_monitor();
4147         check_added_monitors!(nodes[0], 1);
4148
4149         let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
4150         assert_eq!(events_2.len(), 1);
4151         let payment_event = SendEvent::from_event(events_2.pop().unwrap());
4152         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4153         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4154         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4155
4156         expect_pending_htlcs_forwardable!(nodes[1]);
4157
4158         let events_3 = nodes[1].node.get_and_clear_pending_events();
4159         assert_eq!(events_3.len(), 1);
4160         match events_3[0] {
4161                 Event::PaymentReceived { ref payment_hash, amt } => {
4162                         assert_eq!(payment_hash_1, *payment_hash);
4163                         assert_eq!(amt, 1000000);
4164                 },
4165                 _ => panic!("Unexpected event"),
4166         }
4167
4168         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
4169
4170         // Now set it to failed again...
4171         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4172         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4173         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
4174         check_added_monitors!(nodes[0], 1);
4175
4176         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4177         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4178         assert_eq!(nodes[0].node.list_channels().len(), 1);
4179
4180         if disconnect {
4181                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4182                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4183                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4184         }
4185
4186         // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
4187         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
4188         nodes[0].node.test_restore_channel_monitor();
4189         check_added_monitors!(nodes[0], 1);
4190
4191         let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
4192         assert_eq!(events_5.len(), 1);
4193         match events_5[0] {
4194                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4195                 _ => panic!("Unexpected event"),
4196         }
4197
4198         // TODO: Once we hit the chain with the failure transaction we should check that we get a
4199         // PaymentFailed event
4200
4201         assert_eq!(nodes[0].node.list_channels().len(), 0);
4202 }
4203
4204 #[test]
4205 fn test_simple_monitor_temporary_update_fail() {
4206         do_test_simple_monitor_temporary_update_fail(false);
4207         do_test_simple_monitor_temporary_update_fail(true);
4208 }
4209
4210 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
4211         let disconnect_flags = 8 | 16;
4212
4213         // Test that we can recover from a temporary monitor update failure with some in-flight
4214         // HTLCs going on at the same time potentially with some disconnection thrown in.
4215         // * First we route a payment, then get a temporary monitor update failure when trying to
4216         //   route a second payment. We then claim the first payment.
4217         // * If disconnect_count is set, we will disconnect at this point (which is likely as
4218         //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
4219         //   the ChannelMonitor on a watchtower).
4220         // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
4221         //   immediately, otherwise we wait sconnect and deliver them via the reconnect
4222         //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
4223         //   disconnect_count & !disconnect_flags is 0).
4224         // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
4225         //   through message sending, potentially disconnect/reconnecting multiple times based on
4226         //   disconnect_count, to get the update_fulfill_htlc through.
4227         // * We then walk through more message exchanges to get the original update_add_htlc
4228         //   through, swapping message ordering based on disconnect_count & 8 and optionally
4229         //   disconnect/reconnecting based on disconnect_count.
4230         let mut nodes = create_network(2);
4231         create_announced_chan_between_nodes(&nodes, 0, 1);
4232
4233         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4234
4235         // Now try to send a second payment which will fail to send
4236         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4237         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4238
4239         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4240         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
4241         check_added_monitors!(nodes[0], 1);
4242
4243         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4244         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4245         assert_eq!(nodes[0].node.list_channels().len(), 1);
4246
4247         // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
4248         // but nodes[0] won't respond since it is frozen.
4249         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4250         check_added_monitors!(nodes[1], 1);
4251         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4252         assert_eq!(events_2.len(), 1);
4253         let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
4254                 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 } } => {
4255                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4256                         assert!(update_add_htlcs.is_empty());
4257                         assert_eq!(update_fulfill_htlcs.len(), 1);
4258                         assert!(update_fail_htlcs.is_empty());
4259                         assert!(update_fail_malformed_htlcs.is_empty());
4260                         assert!(update_fee.is_none());
4261
4262                         if (disconnect_count & 16) == 0 {
4263                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
4264                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
4265                                 assert_eq!(events_3.len(), 1);
4266                                 match events_3[0] {
4267                                         Event::PaymentSent { ref payment_preimage } => {
4268                                                 assert_eq!(*payment_preimage, payment_preimage_1);
4269                                         },
4270                                         _ => panic!("Unexpected event"),
4271                                 }
4272
4273                                 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) {
4274                                         assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4275                                 } else { panic!(); }
4276                         }
4277
4278                         (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
4279                 },
4280                 _ => panic!("Unexpected event"),
4281         };
4282
4283         if disconnect_count & !disconnect_flags > 0 {
4284                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4285                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4286         }
4287
4288         // Now fix monitor updating...
4289         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4290         nodes[0].node.test_restore_channel_monitor();
4291         check_added_monitors!(nodes[0], 1);
4292
4293         macro_rules! disconnect_reconnect_peers { () => { {
4294                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4295                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4296
4297                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4298                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4299                 assert_eq!(reestablish_1.len(), 1);
4300                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4301                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4302                 assert_eq!(reestablish_2.len(), 1);
4303
4304                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4305                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4306                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4307                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4308
4309                 assert!(as_resp.0.is_none());
4310                 assert!(bs_resp.0.is_none());
4311
4312                 (reestablish_1, reestablish_2, as_resp, bs_resp)
4313         } } }
4314
4315         let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
4316                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4317                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4318
4319                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4320                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4321                 assert_eq!(reestablish_1.len(), 1);
4322                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4323                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4324                 assert_eq!(reestablish_2.len(), 1);
4325
4326                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4327                 check_added_monitors!(nodes[0], 0);
4328                 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4329                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4330                 check_added_monitors!(nodes[1], 0);
4331                 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4332
4333                 assert!(as_resp.0.is_none());
4334                 assert!(bs_resp.0.is_none());
4335
4336                 assert!(bs_resp.1.is_none());
4337                 if (disconnect_count & 16) == 0 {
4338                         assert!(bs_resp.2.is_none());
4339
4340                         assert!(as_resp.1.is_some());
4341                         assert!(as_resp.2.is_some());
4342                         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4343                 } else {
4344                         assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
4345                         assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4346                         assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4347                         assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
4348                         assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
4349                         assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
4350
4351                         assert!(as_resp.1.is_none());
4352
4353                         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();
4354                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4355                         assert_eq!(events_3.len(), 1);
4356                         match events_3[0] {
4357                                 Event::PaymentSent { ref payment_preimage } => {
4358                                         assert_eq!(*payment_preimage, payment_preimage_1);
4359                                 },
4360                                 _ => panic!("Unexpected event"),
4361                         }
4362
4363                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
4364                         let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4365                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4366                         check_added_monitors!(nodes[0], 1);
4367
4368                         as_resp.1 = Some(as_resp_raa);
4369                         bs_resp.2 = None;
4370                 }
4371
4372                 if disconnect_count & !disconnect_flags > 1 {
4373                         let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
4374
4375                         if (disconnect_count & 16) == 0 {
4376                                 assert!(reestablish_1 == second_reestablish_1);
4377                                 assert!(reestablish_2 == second_reestablish_2);
4378                         }
4379                         assert!(as_resp == second_as_resp);
4380                         assert!(bs_resp == second_bs_resp);
4381                 }
4382
4383                 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
4384         } else {
4385                 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
4386                 assert_eq!(events_4.len(), 2);
4387                 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
4388                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
4389                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4390                                 msg.clone()
4391                         },
4392                         _ => panic!("Unexpected event"),
4393                 })
4394         };
4395
4396         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4397
4398         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4399         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4400         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4401         // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
4402         check_added_monitors!(nodes[1], 1);
4403
4404         if disconnect_count & !disconnect_flags > 2 {
4405                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4406
4407                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4408                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4409
4410                 assert!(as_resp.2.is_none());
4411                 assert!(bs_resp.2.is_none());
4412         }
4413
4414         let as_commitment_update;
4415         let bs_second_commitment_update;
4416
4417         macro_rules! handle_bs_raa { () => {
4418                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4419                 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4420                 assert!(as_commitment_update.update_add_htlcs.is_empty());
4421                 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
4422                 assert!(as_commitment_update.update_fail_htlcs.is_empty());
4423                 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
4424                 assert!(as_commitment_update.update_fee.is_none());
4425                 check_added_monitors!(nodes[0], 1);
4426         } }
4427
4428         macro_rules! handle_initial_raa { () => {
4429                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
4430                 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4431                 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
4432                 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
4433                 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
4434                 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
4435                 assert!(bs_second_commitment_update.update_fee.is_none());
4436                 check_added_monitors!(nodes[1], 1);
4437         } }
4438
4439         if (disconnect_count & 8) == 0 {
4440                 handle_bs_raa!();
4441
4442                 if disconnect_count & !disconnect_flags > 3 {
4443                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4444
4445                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4446                         assert!(bs_resp.1.is_none());
4447
4448                         assert!(as_resp.2.unwrap() == as_commitment_update);
4449                         assert!(bs_resp.2.is_none());
4450
4451                         assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4452                 }
4453
4454                 handle_initial_raa!();
4455
4456                 if disconnect_count & !disconnect_flags > 4 {
4457                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4458
4459                         assert!(as_resp.1.is_none());
4460                         assert!(bs_resp.1.is_none());
4461
4462                         assert!(as_resp.2.unwrap() == as_commitment_update);
4463                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4464                 }
4465         } else {
4466                 handle_initial_raa!();
4467
4468                 if disconnect_count & !disconnect_flags > 3 {
4469                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4470
4471                         assert!(as_resp.1.is_none());
4472                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4473
4474                         assert!(as_resp.2.is_none());
4475                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4476
4477                         assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4478                 }
4479
4480                 handle_bs_raa!();
4481
4482                 if disconnect_count & !disconnect_flags > 4 {
4483                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4484
4485                         assert!(as_resp.1.is_none());
4486                         assert!(bs_resp.1.is_none());
4487
4488                         assert!(as_resp.2.unwrap() == as_commitment_update);
4489                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4490                 }
4491         }
4492
4493         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
4494         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4495         // No commitment_signed so get_event_msg's assert(len == 1) passes
4496         check_added_monitors!(nodes[0], 1);
4497
4498         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
4499         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4500         // No commitment_signed so get_event_msg's assert(len == 1) passes
4501         check_added_monitors!(nodes[1], 1);
4502
4503         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
4504         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4505         check_added_monitors!(nodes[1], 1);
4506
4507         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
4508         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4509         check_added_monitors!(nodes[0], 1);
4510
4511         expect_pending_htlcs_forwardable!(nodes[1]);
4512
4513         let events_5 = nodes[1].node.get_and_clear_pending_events();
4514         assert_eq!(events_5.len(), 1);
4515         match events_5[0] {
4516                 Event::PaymentReceived { ref payment_hash, amt } => {
4517                         assert_eq!(payment_hash_2, *payment_hash);
4518                         assert_eq!(amt, 1000000);
4519                 },
4520                 _ => panic!("Unexpected event"),
4521         }
4522
4523         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4524 }
4525
4526 #[test]
4527 fn test_monitor_temporary_update_fail_a() {
4528         do_test_monitor_temporary_update_fail(0);
4529         do_test_monitor_temporary_update_fail(1);
4530         do_test_monitor_temporary_update_fail(2);
4531         do_test_monitor_temporary_update_fail(3);
4532         do_test_monitor_temporary_update_fail(4);
4533         do_test_monitor_temporary_update_fail(5);
4534 }
4535
4536 #[test]
4537 fn test_monitor_temporary_update_fail_b() {
4538         do_test_monitor_temporary_update_fail(2 | 8);
4539         do_test_monitor_temporary_update_fail(3 | 8);
4540         do_test_monitor_temporary_update_fail(4 | 8);
4541         do_test_monitor_temporary_update_fail(5 | 8);
4542 }
4543
4544 #[test]
4545 fn test_monitor_temporary_update_fail_c() {
4546         do_test_monitor_temporary_update_fail(1 | 16);
4547         do_test_monitor_temporary_update_fail(2 | 16);
4548         do_test_monitor_temporary_update_fail(3 | 16);
4549         do_test_monitor_temporary_update_fail(2 | 8 | 16);
4550         do_test_monitor_temporary_update_fail(3 | 8 | 16);
4551 }
4552
4553 #[test]
4554 fn test_monitor_update_fail_cs() {
4555         // Tests handling of a monitor update failure when processing an incoming commitment_signed
4556         let mut nodes = create_network(2);
4557         create_announced_chan_between_nodes(&nodes, 0, 1);
4558
4559         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4560         let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4561         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4562         check_added_monitors!(nodes[0], 1);
4563
4564         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4565         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4566
4567         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4568         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() {
4569                 assert_eq!(err, "Failed to update ChannelMonitor");
4570         } else { panic!(); }
4571         check_added_monitors!(nodes[1], 1);
4572         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4573
4574         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4575         nodes[1].node.test_restore_channel_monitor();
4576         check_added_monitors!(nodes[1], 1);
4577         let responses = nodes[1].node.get_and_clear_pending_msg_events();
4578         assert_eq!(responses.len(), 2);
4579
4580         match responses[0] {
4581                 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
4582                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4583                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg).unwrap();
4584                         check_added_monitors!(nodes[0], 1);
4585                 },
4586                 _ => panic!("Unexpected event"),
4587         }
4588         match responses[1] {
4589                 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
4590                         assert!(updates.update_add_htlcs.is_empty());
4591                         assert!(updates.update_fulfill_htlcs.is_empty());
4592                         assert!(updates.update_fail_htlcs.is_empty());
4593                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4594                         assert!(updates.update_fee.is_none());
4595                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4596
4597                         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4598                         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() {
4599                                 assert_eq!(err, "Failed to update ChannelMonitor");
4600                         } else { panic!(); }
4601                         check_added_monitors!(nodes[0], 1);
4602                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4603                 },
4604                 _ => panic!("Unexpected event"),
4605         }
4606
4607         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4608         nodes[0].node.test_restore_channel_monitor();
4609         check_added_monitors!(nodes[0], 1);
4610
4611         let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4612         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa).unwrap();
4613         check_added_monitors!(nodes[1], 1);
4614
4615         let mut events = nodes[1].node.get_and_clear_pending_events();
4616         assert_eq!(events.len(), 1);
4617         match events[0] {
4618                 Event::PendingHTLCsForwardable { .. } => { },
4619                 _ => panic!("Unexpected event"),
4620         };
4621         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4622         nodes[1].node.process_pending_htlc_forwards();
4623
4624         events = nodes[1].node.get_and_clear_pending_events();
4625         assert_eq!(events.len(), 1);
4626         match events[0] {
4627                 Event::PaymentReceived { payment_hash, amt } => {
4628                         assert_eq!(payment_hash, our_payment_hash);
4629                         assert_eq!(amt, 1000000);
4630                 },
4631                 _ => panic!("Unexpected event"),
4632         };
4633
4634         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
4635 }
4636
4637 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
4638         // Tests handling of a monitor update failure when processing an incoming RAA
4639         let mut nodes = create_network(3);
4640         create_announced_chan_between_nodes(&nodes, 0, 1);
4641         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4642
4643         // Rebalance a bit so that we can send backwards from 2 to 1.
4644         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
4645
4646         // Route a first payment that we'll fail backwards
4647         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4648
4649         // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
4650         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, 0));
4651         check_added_monitors!(nodes[2], 1);
4652
4653         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4654         assert!(updates.update_add_htlcs.is_empty());
4655         assert!(updates.update_fulfill_htlcs.is_empty());
4656         assert_eq!(updates.update_fail_htlcs.len(), 1);
4657         assert!(updates.update_fail_malformed_htlcs.is_empty());
4658         assert!(updates.update_fee.is_none());
4659         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4660
4661         let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
4662         check_added_monitors!(nodes[0], 0);
4663
4664         // While the second channel is AwaitingRAA, forward a second payment to get it into the
4665         // holding cell.
4666         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4667         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4668         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
4669         check_added_monitors!(nodes[0], 1);
4670
4671         let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4672         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4673         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
4674
4675         let events_1 = nodes[1].node.get_and_clear_pending_events();
4676         assert_eq!(events_1.len(), 1);
4677         match events_1[0] {
4678                 Event::PendingHTLCsForwardable { .. } => { },
4679                 _ => panic!("Unexpected event"),
4680         };
4681
4682         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4683         nodes[1].node.process_pending_htlc_forwards();
4684         check_added_monitors!(nodes[1], 0);
4685         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4686
4687         // Now fail monitor updating.
4688         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4689         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() {
4690                 assert_eq!(err, "Failed to update ChannelMonitor");
4691         } else { panic!(); }
4692         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4693         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4694         check_added_monitors!(nodes[1], 1);
4695
4696         // Attempt to forward a third payment but fail due to the second channel being unavailable
4697         // for forwarding.
4698
4699         let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
4700         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4701         nodes[0].node.send_payment(route, payment_hash_3).unwrap();
4702         check_added_monitors!(nodes[0], 1);
4703
4704         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(()); // We succeed in updating the monitor for the first channel
4705         send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4706         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4707         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
4708         check_added_monitors!(nodes[1], 0);
4709
4710         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4711         assert_eq!(events_2.len(), 1);
4712         match events_2.remove(0) {
4713                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4714                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
4715                         assert!(updates.update_fulfill_htlcs.is_empty());
4716                         assert_eq!(updates.update_fail_htlcs.len(), 1);
4717                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4718                         assert!(updates.update_add_htlcs.is_empty());
4719                         assert!(updates.update_fee.is_none());
4720
4721                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4722                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
4723
4724                         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4725                         assert_eq!(msg_events.len(), 1);
4726                         match msg_events[0] {
4727                                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
4728                                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
4729                                         assert_eq!(msg.contents.flags & 2, 2); // temp disabled
4730                                 },
4731                                 _ => panic!("Unexpected event"),
4732                         }
4733
4734                         let events = nodes[0].node.get_and_clear_pending_events();
4735                         assert_eq!(events.len(), 1);
4736                         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
4737                                 assert_eq!(payment_hash, payment_hash_3);
4738                                 assert!(!rejected_by_dest);
4739                         } else { panic!("Unexpected event!"); }
4740                 },
4741                 _ => panic!("Unexpected event type!"),
4742         };
4743
4744         let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
4745                 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
4746                 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
4747                 let route = nodes[2].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4748                 nodes[2].node.send_payment(route, payment_hash_4).unwrap();
4749                 check_added_monitors!(nodes[2], 1);
4750
4751                 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
4752                 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4753                 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) {
4754                         assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4755                 } else { panic!(); }
4756                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4757                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4758                 (Some(payment_preimage_4), Some(payment_hash_4))
4759         } else { (None, None) };
4760
4761         // Restore monitor updating, ensuring we immediately get a fail-back update and a
4762         // update_add update.
4763         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4764         nodes[1].node.test_restore_channel_monitor();
4765         check_added_monitors!(nodes[1], 2);
4766
4767         let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
4768         if test_ignore_second_cs {
4769                 assert_eq!(events_3.len(), 3);
4770         } else {
4771                 assert_eq!(events_3.len(), 2);
4772         }
4773
4774         // Note that the ordering of the events for different nodes is non-prescriptive, though the
4775         // ordering of the two events that both go to nodes[2] have to stay in the same order.
4776         let messages_a = match events_3.pop().unwrap() {
4777                 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
4778                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
4779                         assert!(updates.update_fulfill_htlcs.is_empty());
4780                         assert_eq!(updates.update_fail_htlcs.len(), 1);
4781                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4782                         assert!(updates.update_add_htlcs.is_empty());
4783                         assert!(updates.update_fee.is_none());
4784                         (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
4785                 },
4786                 _ => panic!("Unexpected event type!"),
4787         };
4788         let raa = if test_ignore_second_cs {
4789                 match events_3.remove(1) {
4790                         MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
4791                                 assert_eq!(node_id, nodes[2].node.get_our_node_id());
4792                                 Some(msg.clone())
4793                         },
4794                         _ => panic!("Unexpected event"),
4795                 }
4796         } else { None };
4797         let send_event_b = SendEvent::from_event(events_3.remove(0));
4798         assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
4799
4800         // Now deliver the new messages...
4801
4802         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0).unwrap();
4803         commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
4804         let events_4 = nodes[0].node.get_and_clear_pending_events();
4805         assert_eq!(events_4.len(), 1);
4806         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events_4[0] {
4807                 assert_eq!(payment_hash, payment_hash_1);
4808                 assert!(rejected_by_dest);
4809         } else { panic!("Unexpected event!"); }
4810
4811         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]).unwrap();
4812         if test_ignore_second_cs {
4813                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg).unwrap();
4814                 check_added_monitors!(nodes[2], 1);
4815                 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4816                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap()).unwrap();
4817                 check_added_monitors!(nodes[2], 1);
4818                 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4819                 assert!(bs_cs.update_add_htlcs.is_empty());
4820                 assert!(bs_cs.update_fail_htlcs.is_empty());
4821                 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
4822                 assert!(bs_cs.update_fulfill_htlcs.is_empty());
4823                 assert!(bs_cs.update_fee.is_none());
4824
4825                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4826                 check_added_monitors!(nodes[1], 1);
4827                 let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4828                 assert!(as_cs.update_add_htlcs.is_empty());
4829                 assert!(as_cs.update_fail_htlcs.is_empty());
4830                 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
4831                 assert!(as_cs.update_fulfill_htlcs.is_empty());
4832                 assert!(as_cs.update_fee.is_none());
4833
4834                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
4835                 check_added_monitors!(nodes[1], 1);
4836                 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
4837
4838                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
4839                 check_added_monitors!(nodes[2], 1);
4840                 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4841
4842                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
4843                 check_added_monitors!(nodes[2], 1);
4844                 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
4845
4846                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa).unwrap();
4847                 check_added_monitors!(nodes[1], 1);
4848                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4849         } else {
4850                 commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
4851         }
4852
4853         let events_5 = nodes[2].node.get_and_clear_pending_events();
4854         assert_eq!(events_5.len(), 1);
4855         match events_5[0] {
4856                 Event::PendingHTLCsForwardable { .. } => { },
4857                 _ => panic!("Unexpected event"),
4858         };
4859
4860         nodes[2].node.channel_state.lock().unwrap().next_forward = Instant::now();
4861         nodes[2].node.process_pending_htlc_forwards();
4862
4863         let events_6 = nodes[2].node.get_and_clear_pending_events();
4864         assert_eq!(events_6.len(), 1);
4865         match events_6[0] {
4866                 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
4867                 _ => panic!("Unexpected event"),
4868         };
4869
4870         if test_ignore_second_cs {
4871                 let events_7 = nodes[1].node.get_and_clear_pending_events();
4872                 assert_eq!(events_7.len(), 1);
4873                 match events_7[0] {
4874                         Event::PendingHTLCsForwardable { .. } => { },
4875                         _ => panic!("Unexpected event"),
4876                 };
4877
4878                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4879                 nodes[1].node.process_pending_htlc_forwards();
4880                 check_added_monitors!(nodes[1], 1);
4881
4882                 send_event = SendEvent::from_node(&nodes[1]);
4883                 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
4884                 assert_eq!(send_event.msgs.len(), 1);
4885                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4886                 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
4887
4888                 let events_8 = nodes[0].node.get_and_clear_pending_events();
4889                 assert_eq!(events_8.len(), 1);
4890                 match events_8[0] {
4891                         Event::PendingHTLCsForwardable { .. } => { },
4892                         _ => panic!("Unexpected event"),
4893                 };
4894
4895                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4896                 nodes[0].node.process_pending_htlc_forwards();
4897
4898                 let events_9 = nodes[0].node.get_and_clear_pending_events();
4899                 assert_eq!(events_9.len(), 1);
4900                 match events_9[0] {
4901                         Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
4902                         _ => panic!("Unexpected event"),
4903                 };
4904                 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
4905         }
4906
4907         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
4908 }
4909
4910 #[test]
4911 fn test_monitor_update_fail_raa() {
4912         do_test_monitor_update_fail_raa(false);
4913         do_test_monitor_update_fail_raa(true);
4914 }
4915
4916 #[test]
4917 fn test_monitor_update_fail_reestablish() {
4918         // Simple test for message retransmission after monitor update failure on
4919         // channel_reestablish generating a monitor update (which comes from freeing holding cell
4920         // HTLCs).
4921         let mut nodes = create_network(3);
4922         create_announced_chan_between_nodes(&nodes, 0, 1);
4923         create_announced_chan_between_nodes(&nodes, 1, 2);
4924
4925         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4926
4927         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4928         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4929
4930         assert!(nodes[2].node.claim_funds(our_payment_preimage));
4931         check_added_monitors!(nodes[2], 1);
4932         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4933         assert!(updates.update_add_htlcs.is_empty());
4934         assert!(updates.update_fail_htlcs.is_empty());
4935         assert!(updates.update_fail_malformed_htlcs.is_empty());
4936         assert!(updates.update_fee.is_none());
4937         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4938         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4939         check_added_monitors!(nodes[1], 1);
4940         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4941         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4942
4943         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4944         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4945         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4946
4947         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4948         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4949
4950         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4951
4952         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() {
4953                 assert_eq!(err, "Failed to update ChannelMonitor");
4954         } else { panic!(); }
4955         check_added_monitors!(nodes[1], 1);
4956
4957         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4958         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4959
4960         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4961         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4962
4963         assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
4964         assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
4965
4966         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4967
4968         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap();
4969         check_added_monitors!(nodes[1], 0);
4970         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4971
4972         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4973         nodes[1].node.test_restore_channel_monitor();
4974         check_added_monitors!(nodes[1], 1);
4975
4976         updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4977         assert!(updates.update_add_htlcs.is_empty());
4978         assert!(updates.update_fail_htlcs.is_empty());
4979         assert!(updates.update_fail_malformed_htlcs.is_empty());
4980         assert!(updates.update_fee.is_none());
4981         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4982         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4983         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
4984
4985         let events = nodes[0].node.get_and_clear_pending_events();
4986         assert_eq!(events.len(), 1);
4987         match events[0] {
4988                 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
4989                 _ => panic!("Unexpected event"),
4990         }
4991 }
4992
4993 #[test]
4994 fn test_invalid_channel_announcement() {
4995         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4996         let secp_ctx = Secp256k1::new();
4997         let nodes = create_network(2);
4998
4999         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
5000
5001         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
5002         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
5003         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5004         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5005
5006         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 } );
5007
5008         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
5009         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
5010
5011         let as_network_key = nodes[0].node.get_our_node_id();
5012         let bs_network_key = nodes[1].node.get_our_node_id();
5013
5014         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
5015
5016         let mut chan_announcement;
5017
5018         macro_rules! dummy_unsigned_msg {
5019                 () => {
5020                         msgs::UnsignedChannelAnnouncement {
5021                                 features: msgs::GlobalFeatures::new(),
5022                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
5023                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
5024                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
5025                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
5026                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
5027                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
5028                                 excess_data: Vec::new(),
5029                         };
5030                 }
5031         }
5032
5033         macro_rules! sign_msg {
5034                 ($unsigned_msg: expr) => {
5035                         let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
5036                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
5037                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
5038                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
5039                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
5040                         chan_announcement = msgs::ChannelAnnouncement {
5041                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
5042                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
5043                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
5044                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
5045                                 contents: $unsigned_msg
5046                         }
5047                 }
5048         }
5049
5050         let unsigned_msg = dummy_unsigned_msg!();
5051         sign_msg!(unsigned_msg);
5052         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
5053         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 } );
5054
5055         // Configured with Network::Testnet
5056         let mut unsigned_msg = dummy_unsigned_msg!();
5057         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
5058         sign_msg!(unsigned_msg);
5059         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
5060
5061         let mut unsigned_msg = dummy_unsigned_msg!();
5062         unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
5063         sign_msg!(unsigned_msg);
5064         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
5065 }
5066
5067 struct VecWriter(Vec<u8>);
5068 impl Writer for VecWriter {
5069         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
5070                 self.0.extend_from_slice(buf);
5071                 Ok(())
5072         }
5073         fn size_hint(&mut self, size: usize) {
5074                 self.0.reserve_exact(size);
5075         }
5076 }
5077
5078 #[test]
5079 fn test_no_txn_manager_serialize_deserialize() {
5080         let mut nodes = create_network(2);
5081
5082         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
5083
5084         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5085
5086         let nodes_0_serialized = nodes[0].node.encode();
5087         let mut chan_0_monitor_serialized = VecWriter(Vec::new());
5088         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
5089
5090         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())));
5091         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
5092         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
5093         assert!(chan_0_monitor_read.is_empty());
5094
5095         let mut nodes_0_read = &nodes_0_serialized[..];
5096         let config = UserConfig::new();
5097         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5098         let (_, nodes_0_deserialized) = {
5099                 let mut channel_monitors = HashMap::new();
5100                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
5101                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5102                         default_config: config,
5103                         keys_manager,
5104                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5105                         monitor: nodes[0].chan_monitor.clone(),
5106                         chain_monitor: nodes[0].chain_monitor.clone(),
5107                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5108                         logger: Arc::new(test_utils::TestLogger::new()),
5109                         channel_monitors: &channel_monitors,
5110                 }).unwrap()
5111         };
5112         assert!(nodes_0_read.is_empty());
5113
5114         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
5115         nodes[0].node = Arc::new(nodes_0_deserialized);
5116         let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
5117         nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
5118         assert_eq!(nodes[0].node.list_channels().len(), 1);
5119         check_added_monitors!(nodes[0], 1);
5120
5121         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5122         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5123         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5124         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5125
5126         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5127         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5128         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5129         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5130
5131         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
5132         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
5133         for node in nodes.iter() {
5134                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
5135                 node.router.handle_channel_update(&as_update).unwrap();
5136                 node.router.handle_channel_update(&bs_update).unwrap();
5137         }
5138
5139         send_payment(&nodes[0], &[&nodes[1]], 1000000);
5140 }
5141
5142 #[test]
5143 fn test_simple_manager_serialize_deserialize() {
5144         let mut nodes = create_network(2);
5145         create_announced_chan_between_nodes(&nodes, 0, 1);
5146
5147         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5148         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5149
5150         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5151
5152         let nodes_0_serialized = nodes[0].node.encode();
5153         let mut chan_0_monitor_serialized = VecWriter(Vec::new());
5154         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
5155
5156         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())));
5157         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
5158         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
5159         assert!(chan_0_monitor_read.is_empty());
5160
5161         let mut nodes_0_read = &nodes_0_serialized[..];
5162         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5163         let (_, nodes_0_deserialized) = {
5164                 let mut channel_monitors = HashMap::new();
5165                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
5166                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5167                         default_config: UserConfig::new(),
5168                         keys_manager,
5169                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5170                         monitor: nodes[0].chan_monitor.clone(),
5171                         chain_monitor: nodes[0].chain_monitor.clone(),
5172                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5173                         logger: Arc::new(test_utils::TestLogger::new()),
5174                         channel_monitors: &channel_monitors,
5175                 }).unwrap()
5176         };
5177         assert!(nodes_0_read.is_empty());
5178
5179         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
5180         nodes[0].node = Arc::new(nodes_0_deserialized);
5181         check_added_monitors!(nodes[0], 1);
5182
5183         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5184
5185         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
5186         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
5187 }
5188
5189 #[test]
5190 fn test_manager_serialize_deserialize_inconsistent_monitor() {
5191         // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
5192         let mut nodes = create_network(4);
5193         create_announced_chan_between_nodes(&nodes, 0, 1);
5194         create_announced_chan_between_nodes(&nodes, 2, 0);
5195         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
5196
5197         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
5198
5199         // Serialize the ChannelManager here, but the monitor we keep up-to-date
5200         let nodes_0_serialized = nodes[0].node.encode();
5201
5202         route_payment(&nodes[0], &[&nodes[3]], 1000000);
5203         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5204         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5205         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5206
5207         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
5208         // nodes[3])
5209         let mut node_0_monitors_serialized = Vec::new();
5210         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
5211                 let mut writer = VecWriter(Vec::new());
5212                 monitor.1.write_for_disk(&mut writer).unwrap();
5213                 node_0_monitors_serialized.push(writer.0);
5214         }
5215
5216         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())));
5217         let mut node_0_monitors = Vec::new();
5218         for serialized in node_0_monitors_serialized.iter() {
5219                 let mut read = &serialized[..];
5220                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
5221                 assert!(read.is_empty());
5222                 node_0_monitors.push(monitor);
5223         }
5224
5225         let mut nodes_0_read = &nodes_0_serialized[..];
5226         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5227         let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5228                 default_config: UserConfig::new(),
5229                 keys_manager,
5230                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5231                 monitor: nodes[0].chan_monitor.clone(),
5232                 chain_monitor: nodes[0].chain_monitor.clone(),
5233                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5234                 logger: Arc::new(test_utils::TestLogger::new()),
5235                 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
5236         }).unwrap();
5237         assert!(nodes_0_read.is_empty());
5238
5239         { // Channel close should result in a commitment tx and an HTLC tx
5240                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5241                 assert_eq!(txn.len(), 2);
5242                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
5243                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
5244         }
5245
5246         for monitor in node_0_monitors.drain(..) {
5247                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
5248                 check_added_monitors!(nodes[0], 1);
5249         }
5250         nodes[0].node = Arc::new(nodes_0_deserialized);
5251
5252         // nodes[1] and nodes[2] have no lost state with nodes[0]...
5253         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5254         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5255         //... and we can even still claim the payment!
5256         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
5257
5258         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
5259         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5260         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
5261         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) {
5262                 assert_eq!(msg.channel_id, channel_id);
5263         } else { panic!("Unexpected result"); }
5264 }
5265
5266 macro_rules! check_spendable_outputs {
5267         ($node: expr, $der_idx: expr) => {
5268                 {
5269                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
5270                         let mut txn = Vec::new();
5271                         for event in events {
5272                                 match event {
5273                                         Event::SpendableOutputs { ref outputs } => {
5274                                                 for outp in outputs {
5275                                                         match *outp {
5276                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
5277                                                                         let input = TxIn {
5278                                                                                 previous_output: outpoint.clone(),
5279                                                                                 script_sig: Script::new(),
5280                                                                                 sequence: 0,
5281                                                                                 witness: Vec::new(),
5282                                                                         };
5283                                                                         let outp = TxOut {
5284                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5285                                                                                 value: output.value,
5286                                                                         };
5287                                                                         let mut spend_tx = Transaction {
5288                                                                                 version: 2,
5289                                                                                 lock_time: 0,
5290                                                                                 input: vec![input],
5291                                                                                 output: vec![outp],
5292                                                                         };
5293                                                                         let secp_ctx = Secp256k1::new();
5294                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
5295                                                                         let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
5296                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5297                                                                         let remotesig = secp_ctx.sign(&sighash, key);
5298                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
5299                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5300                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
5301                                                                         txn.push(spend_tx);
5302                                                                 },
5303                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
5304                                                                         let input = TxIn {
5305                                                                                 previous_output: outpoint.clone(),
5306                                                                                 script_sig: Script::new(),
5307                                                                                 sequence: *to_self_delay as u32,
5308                                                                                 witness: Vec::new(),
5309                                                                         };
5310                                                                         let outp = TxOut {
5311                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5312                                                                                 value: output.value,
5313                                                                         };
5314                                                                         let mut spend_tx = Transaction {
5315                                                                                 version: 2,
5316                                                                                 lock_time: 0,
5317                                                                                 input: vec![input],
5318                                                                                 output: vec![outp],
5319                                                                         };
5320                                                                         let secp_ctx = Secp256k1::new();
5321                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
5322                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
5323                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
5324                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5325                                                                         spend_tx.input[0].witness.push(vec!(0));
5326                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
5327                                                                         txn.push(spend_tx);
5328                                                                 },
5329                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
5330                                                                         let secp_ctx = Secp256k1::new();
5331                                                                         let input = TxIn {
5332                                                                                 previous_output: outpoint.clone(),
5333                                                                                 script_sig: Script::new(),
5334                                                                                 sequence: 0,
5335                                                                                 witness: Vec::new(),
5336                                                                         };
5337                                                                         let outp = TxOut {
5338                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5339                                                                                 value: output.value,
5340                                                                         };
5341                                                                         let mut spend_tx = Transaction {
5342                                                                                 version: 2,
5343                                                                                 lock_time: 0,
5344                                                                                 input: vec![input],
5345                                                                                 output: vec![outp.clone()],
5346                                                                         };
5347                                                                         let secret = {
5348                                                                                 match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
5349                                                                                         Ok(master_key) => {
5350                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
5351                                                                                                         Ok(key) => key,
5352                                                                                                         Err(_) => panic!("Your RNG is busted"),
5353                                                                                                 }
5354                                                                                         }
5355                                                                                         Err(_) => panic!("Your rng is busted"),
5356                                                                                 }
5357                                                                         };
5358                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
5359                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
5360                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5361                                                                         let sig = secp_ctx.sign(&sighash, &secret.secret_key);
5362                                                                         spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
5363                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5364                                                                         spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
5365                                                                         txn.push(spend_tx);
5366                                                                 },
5367                                                         }
5368                                                 }
5369                                         },
5370                                         _ => panic!("Unexpected event"),
5371                                 };
5372                         }
5373                         txn
5374                 }
5375         }
5376 }
5377
5378 #[test]
5379 fn test_claim_sizeable_push_msat() {
5380         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
5381         let nodes = create_network(2);
5382
5383         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5384         nodes[1].node.force_close_channel(&chan.2);
5385         let events = nodes[1].node.get_and_clear_pending_msg_events();
5386         match events[0] {
5387                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5388                 _ => panic!("Unexpected event"),
5389         }
5390         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5391         assert_eq!(node_txn.len(), 1);
5392         check_spends!(node_txn[0], chan.3.clone());
5393         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
5394
5395         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5396         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5397         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5398         assert_eq!(spend_txn.len(), 1);
5399         check_spends!(spend_txn[0], node_txn[0].clone());
5400 }
5401
5402 #[test]
5403 fn test_claim_on_remote_sizeable_push_msat() {
5404         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5405         // to_remote output is encumbered by a P2WPKH
5406
5407         let nodes = create_network(2);
5408
5409         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5410         nodes[0].node.force_close_channel(&chan.2);
5411         let events = nodes[0].node.get_and_clear_pending_msg_events();
5412         match events[0] {
5413                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5414                 _ => panic!("Unexpected event"),
5415         }
5416         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5417         assert_eq!(node_txn.len(), 1);
5418         check_spends!(node_txn[0], chan.3.clone());
5419         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
5420
5421         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5422         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5423         let events = nodes[1].node.get_and_clear_pending_msg_events();
5424         match events[0] {
5425                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5426                 _ => panic!("Unexpected event"),
5427         }
5428         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5429         assert_eq!(spend_txn.len(), 2);
5430         assert_eq!(spend_txn[0], spend_txn[1]);
5431         check_spends!(spend_txn[0], node_txn[0].clone());
5432 }
5433
5434 #[test]
5435 fn test_claim_on_remote_revoked_sizeable_push_msat() {
5436         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5437         // to_remote output is encumbered by a P2WPKH
5438
5439         let nodes = create_network(2);
5440
5441         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
5442         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5443         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5444         assert_eq!(revoked_local_txn[0].input.len(), 1);
5445         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
5446
5447         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5448         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5449         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5450         let events = nodes[1].node.get_and_clear_pending_msg_events();
5451         match events[0] {
5452                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5453                 _ => panic!("Unexpected event"),
5454         }
5455         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5456         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5457         assert_eq!(spend_txn.len(), 4);
5458         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
5459         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
5460         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
5461         check_spends!(spend_txn[1], node_txn[0].clone());
5462 }
5463
5464 #[test]
5465 fn test_static_spendable_outputs_preimage_tx() {
5466         let nodes = create_network(2);
5467
5468         // Create some initial channels
5469         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5470
5471         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5472
5473         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5474         assert_eq!(commitment_tx[0].input.len(), 1);
5475         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5476
5477         // Settle A's commitment tx on B's chain
5478         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5479         assert!(nodes[1].node.claim_funds(payment_preimage));
5480         check_added_monitors!(nodes[1], 1);
5481         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
5482         let events = nodes[1].node.get_and_clear_pending_msg_events();
5483         match events[0] {
5484                 MessageSendEvent::UpdateHTLCs { .. } => {},
5485                 _ => panic!("Unexpected event"),
5486         }
5487         match events[1] {
5488                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5489                 _ => panic!("Unexepected event"),
5490         }
5491
5492         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5493         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
5494         check_spends!(node_txn[0], commitment_tx[0].clone());
5495         assert_eq!(node_txn[0], node_txn[2]);
5496         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5497         check_spends!(node_txn[1], chan_1.3.clone());
5498
5499         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
5500         assert_eq!(spend_txn.len(), 2);
5501         assert_eq!(spend_txn[0], spend_txn[1]);
5502         check_spends!(spend_txn[0], node_txn[0].clone());
5503 }
5504
5505 #[test]
5506 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5507         let nodes = create_network(2);
5508
5509         // Create some initial channels
5510         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5511
5512         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5513         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5514         assert_eq!(revoked_local_txn[0].input.len(), 1);
5515         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5516
5517         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5518
5519         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5520         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5521         let events = nodes[1].node.get_and_clear_pending_msg_events();
5522         match events[0] {
5523                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5524                 _ => panic!("Unexpected event"),
5525         }
5526         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5527         assert_eq!(node_txn.len(), 3);
5528         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
5529         assert_eq!(node_txn[0].input.len(), 2);
5530         check_spends!(node_txn[0], revoked_local_txn[0].clone());
5531
5532         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5533         assert_eq!(spend_txn.len(), 2);
5534         assert_eq!(spend_txn[0], spend_txn[1]);
5535         check_spends!(spend_txn[0], node_txn[0].clone());
5536 }
5537
5538 #[test]
5539 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5540         let nodes = create_network(2);
5541
5542         // Create some initial channels
5543         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5544
5545         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5546         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5547         assert_eq!(revoked_local_txn[0].input.len(), 1);
5548         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5549
5550         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5551
5552         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5553         // A will generate HTLC-Timeout from revoked commitment tx
5554         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5555         let events = nodes[0].node.get_and_clear_pending_msg_events();
5556         match events[0] {
5557                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5558                 _ => panic!("Unexpected event"),
5559         }
5560         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5561         assert_eq!(revoked_htlc_txn.len(), 3);
5562         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5563         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5564         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5565         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5566         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
5567
5568         // B will generate justice tx from A's revoked commitment/HTLC tx
5569         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5570         let events = nodes[1].node.get_and_clear_pending_msg_events();
5571         match events[0] {
5572                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5573                 _ => panic!("Unexpected event"),
5574         }
5575
5576         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5577         assert_eq!(node_txn.len(), 4);
5578         assert_eq!(node_txn[3].input.len(), 1);
5579         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5580
5581         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5582         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5583         assert_eq!(spend_txn.len(), 3);
5584         assert_eq!(spend_txn[0], spend_txn[1]);
5585         check_spends!(spend_txn[0], node_txn[0].clone());
5586         check_spends!(spend_txn[2], node_txn[3].clone());
5587 }
5588
5589 #[test]
5590 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5591         let nodes = create_network(2);
5592
5593         // Create some initial channels
5594         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5595
5596         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5597         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5598         assert_eq!(revoked_local_txn[0].input.len(), 1);
5599         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5600
5601         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5602
5603         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5604         // B will generate HTLC-Success from revoked commitment tx
5605         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5606         let events = nodes[1].node.get_and_clear_pending_msg_events();
5607         match events[0] {
5608                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5609                 _ => panic!("Unexpected event"),
5610         }
5611         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5612
5613         assert_eq!(revoked_htlc_txn.len(), 3);
5614         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5615         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5616         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5617         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5618
5619         // A will generate justice tx from B's revoked commitment/HTLC tx
5620         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5621         let events = nodes[0].node.get_and_clear_pending_msg_events();
5622         match events[0] {
5623                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5624                 _ => panic!("Unexpected event"),
5625         }
5626
5627         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5628         assert_eq!(node_txn.len(), 4);
5629         assert_eq!(node_txn[3].input.len(), 1);
5630         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5631
5632         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5633         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5634         assert_eq!(spend_txn.len(), 5);
5635         assert_eq!(spend_txn[0], spend_txn[2]);
5636         assert_eq!(spend_txn[1], spend_txn[3]);
5637         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
5638         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
5639         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
5640 }
5641
5642 #[test]
5643 fn test_onchain_to_onchain_claim() {
5644         // Test that in case of channel closure, we detect the state of output thanks to
5645         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5646         // First, have C claim an HTLC against its own latest commitment transaction.
5647         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5648         // channel.
5649         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5650         // gets broadcast.
5651
5652         let nodes = create_network(3);
5653
5654         // Create some initial channels
5655         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5656         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5657
5658         // Rebalance the network a bit by relaying one payment through all the channels ...
5659         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5660         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5661
5662         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5663         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5664         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5665         check_spends!(commitment_tx[0], chan_2.3.clone());
5666         nodes[2].node.claim_funds(payment_preimage);
5667         check_added_monitors!(nodes[2], 1);
5668         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5669         assert!(updates.update_add_htlcs.is_empty());
5670         assert!(updates.update_fail_htlcs.is_empty());
5671         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5672         assert!(updates.update_fail_malformed_htlcs.is_empty());
5673
5674         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5675         let events = nodes[2].node.get_and_clear_pending_msg_events();
5676         assert_eq!(events.len(), 1);
5677         match events[0] {
5678                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5679                 _ => panic!("Unexpected event"),
5680         }
5681
5682         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5683         assert_eq!(c_txn.len(), 3);
5684         assert_eq!(c_txn[0], c_txn[2]);
5685         assert_eq!(commitment_tx[0], c_txn[1]);
5686         check_spends!(c_txn[1], chan_2.3.clone());
5687         check_spends!(c_txn[2], c_txn[1].clone());
5688         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5689         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5690         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5691         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5692
5693         // 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
5694         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5695         {
5696                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5697                 assert_eq!(b_txn.len(), 4);
5698                 assert_eq!(b_txn[0], b_txn[3]);
5699                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5700                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5701                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5702                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5703                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5704                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5705                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5706                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5707                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5708                 b_txn.clear();
5709         }
5710         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5711         check_added_monitors!(nodes[1], 1);
5712         match msg_events[0] {
5713                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5714                 _ => panic!("Unexpected event"),
5715         }
5716         match msg_events[1] {
5717                 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, .. } } => {
5718                         assert!(update_add_htlcs.is_empty());
5719                         assert!(update_fail_htlcs.is_empty());
5720                         assert_eq!(update_fulfill_htlcs.len(), 1);
5721                         assert!(update_fail_malformed_htlcs.is_empty());
5722                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5723                 },
5724                 _ => panic!("Unexpected event"),
5725         };
5726         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5727         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5728         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5729         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5730         assert_eq!(b_txn.len(), 3);
5731         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
5732         assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
5733         check_spends!(b_txn[0], commitment_tx[0].clone());
5734         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5735         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5736         assert_eq!(b_txn[2].lock_time, 0); // Success tx
5737         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5738         match msg_events[0] {
5739                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5740                 _ => panic!("Unexpected event"),
5741         }
5742 }
5743
5744 #[test]
5745 fn test_duplicate_payment_hash_one_failure_one_success() {
5746         // Topology : A --> B --> C
5747         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5748         let mut nodes = create_network(3);
5749
5750         create_announced_chan_between_nodes(&nodes, 0, 1);
5751         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5752
5753         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5754         *nodes[0].network_payment_count.borrow_mut() -= 1;
5755         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5756
5757         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5758         assert_eq!(commitment_txn[0].input.len(), 1);
5759         check_spends!(commitment_txn[0], chan_2.3.clone());
5760
5761         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5762         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5763         let htlc_timeout_tx;
5764         { // Extract one of the two HTLC-Timeout transaction
5765                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5766                 assert_eq!(node_txn.len(), 7);
5767                 assert_eq!(node_txn[0], node_txn[5]);
5768                 assert_eq!(node_txn[1], node_txn[6]);
5769                 check_spends!(node_txn[0], commitment_txn[0].clone());
5770                 assert_eq!(node_txn[0].input.len(), 1);
5771                 check_spends!(node_txn[1], commitment_txn[0].clone());
5772                 assert_eq!(node_txn[1].input.len(), 1);
5773                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5774                 check_spends!(node_txn[2], chan_2.3.clone());
5775                 check_spends!(node_txn[3], node_txn[2].clone());
5776                 check_spends!(node_txn[4], node_txn[2].clone());
5777                 htlc_timeout_tx = node_txn[1].clone();
5778         }
5779
5780         let events = nodes[1].node.get_and_clear_pending_msg_events();
5781         match events[0] {
5782                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5783                 _ => panic!("Unexepected event"),
5784         }
5785
5786         nodes[2].node.claim_funds(our_payment_preimage);
5787         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5788         check_added_monitors!(nodes[2], 2);
5789         let events = nodes[2].node.get_and_clear_pending_msg_events();
5790         match events[0] {
5791                 MessageSendEvent::UpdateHTLCs { .. } => {},
5792                 _ => panic!("Unexpected event"),
5793         }
5794         match events[1] {
5795                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5796                 _ => panic!("Unexepected event"),
5797         }
5798         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5799         assert_eq!(htlc_success_txn.len(), 5);
5800         check_spends!(htlc_success_txn[2], chan_2.3.clone());
5801         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5802         assert_eq!(htlc_success_txn[0].input.len(), 1);
5803         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5804         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5805         assert_eq!(htlc_success_txn[1].input.len(), 1);
5806         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5807         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5808         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
5809         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
5810
5811         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5812         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5813         assert!(htlc_updates.update_add_htlcs.is_empty());
5814         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5815         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5816         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5817         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5818         check_added_monitors!(nodes[1], 1);
5819
5820         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
5821         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5822         {
5823                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5824                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5825                 assert_eq!(events.len(), 1);
5826                 match events[0] {
5827                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5828                         },
5829                         _ => { panic!("Unexpected event"); }
5830                 }
5831         }
5832         let events = nodes[0].node.get_and_clear_pending_events();
5833         match events[0] {
5834                 Event::PaymentFailed { ref payment_hash, .. } => {
5835                         assert_eq!(*payment_hash, duplicate_payment_hash);
5836                 }
5837                 _ => panic!("Unexpected event"),
5838         }
5839
5840         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5841         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5842         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5843         assert!(updates.update_add_htlcs.is_empty());
5844         assert!(updates.update_fail_htlcs.is_empty());
5845         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5846         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5847         assert!(updates.update_fail_malformed_htlcs.is_empty());
5848         check_added_monitors!(nodes[1], 1);
5849
5850         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
5851         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5852
5853         let events = nodes[0].node.get_and_clear_pending_events();
5854         match events[0] {
5855                 Event::PaymentSent { ref payment_preimage } => {
5856                         assert_eq!(*payment_preimage, our_payment_preimage);
5857                 }
5858                 _ => panic!("Unexpected event"),
5859         }
5860 }
5861
5862 #[test]
5863 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5864         let nodes = create_network(2);
5865
5866         // Create some initial channels
5867         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5868
5869         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5870         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5871         assert_eq!(local_txn[0].input.len(), 1);
5872         check_spends!(local_txn[0], chan_1.3.clone());
5873
5874         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5875         nodes[1].node.claim_funds(payment_preimage);
5876         check_added_monitors!(nodes[1], 1);
5877         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5878         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5879         let events = nodes[1].node.get_and_clear_pending_msg_events();
5880         match events[0] {
5881                 MessageSendEvent::UpdateHTLCs { .. } => {},
5882                 _ => panic!("Unexpected event"),
5883         }
5884         match events[1] {
5885                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5886                 _ => panic!("Unexepected event"),
5887         }
5888         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5889         assert_eq!(node_txn[0].input.len(), 1);
5890         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5891         check_spends!(node_txn[0], local_txn[0].clone());
5892
5893         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5894         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5895         assert_eq!(spend_txn.len(), 2);
5896         check_spends!(spend_txn[0], node_txn[0].clone());
5897         check_spends!(spend_txn[1], node_txn[2].clone());
5898 }
5899
5900 #[test]
5901 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5902         let nodes = create_network(2);
5903
5904         // Create some initial channels
5905         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5906
5907         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5908         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5909         assert_eq!(local_txn[0].input.len(), 1);
5910         check_spends!(local_txn[0], chan_1.3.clone());
5911
5912         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5913         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5914         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5915         let events = nodes[0].node.get_and_clear_pending_msg_events();
5916         match events[0] {
5917                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5918                 _ => panic!("Unexepected event"),
5919         }
5920         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5921         assert_eq!(node_txn[0].input.len(), 1);
5922         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5923         check_spends!(node_txn[0], local_txn[0].clone());
5924
5925         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5926         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5927         assert_eq!(spend_txn.len(), 8);
5928         assert_eq!(spend_txn[0], spend_txn[2]);
5929         assert_eq!(spend_txn[0], spend_txn[4]);
5930         assert_eq!(spend_txn[0], spend_txn[6]);
5931         assert_eq!(spend_txn[1], spend_txn[3]);
5932         assert_eq!(spend_txn[1], spend_txn[5]);
5933         assert_eq!(spend_txn[1], spend_txn[7]);
5934         check_spends!(spend_txn[0], local_txn[0].clone());
5935         check_spends!(spend_txn[1], node_txn[0].clone());
5936 }
5937
5938 #[test]
5939 fn test_static_output_closing_tx() {
5940         let nodes = create_network(2);
5941
5942         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5943
5944         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5945         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5946
5947         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5948         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
5949         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5950         assert_eq!(spend_txn.len(), 1);
5951         check_spends!(spend_txn[0], closing_tx.clone());
5952
5953         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
5954         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5955         assert_eq!(spend_txn.len(), 1);
5956         check_spends!(spend_txn[0], closing_tx);
5957 }
5958
5959 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>)
5960         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5961                                 F2: FnMut(),
5962 {
5963         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);
5964 }
5965
5966 // test_case
5967 // 0: node1 fail backward
5968 // 1: final node fail backward
5969 // 2: payment completed but the user reject the payment
5970 // 3: final node fail backward (but tamper onion payloads from node0)
5971 // 100: trigger error in the intermediate node and tamper returnning fail_htlc
5972 // 200: trigger error in the final node and tamper returnning fail_htlc
5973 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>)
5974         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5975                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5976                                 F3: FnMut(),
5977 {
5978         use ln::msgs::HTLCFailChannelUpdate;
5979
5980         // reset block height
5981         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5982         for ix in 0..nodes.len() {
5983                 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
5984         }
5985
5986         macro_rules! expect_event {
5987                 ($node: expr, $event_type: path) => {{
5988                         let events = $node.node.get_and_clear_pending_events();
5989                         assert_eq!(events.len(), 1);
5990                         match events[0] {
5991                                 $event_type { .. } => {},
5992                                 _ => panic!("Unexpected event"),
5993                         }
5994                 }}
5995         }
5996
5997         macro_rules! expect_htlc_forward {
5998                 ($node: expr) => {{
5999                         expect_event!($node, Event::PendingHTLCsForwardable);
6000                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
6001                         $node.node.process_pending_htlc_forwards();
6002                 }}
6003         }
6004
6005         // 0 ~~> 2 send payment
6006         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
6007         check_added_monitors!(nodes[0], 1);
6008         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6009         // temper update_add (0 => 1)
6010         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
6011         if test_case == 0 || test_case == 3 || test_case == 100 {
6012                 callback_msg(&mut update_add_0);
6013                 callback_node();
6014         }
6015         // 0 => 1 update_add & CS
6016         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
6017         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
6018
6019         let update_1_0 = match test_case {
6020                 0|100 => { // intermediate node failure; fail backward to 0
6021                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6022                         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));
6023                         update_1_0
6024                 },
6025                 1|2|3|200 => { // final node failure; forwarding to 2
6026                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6027                         // forwarding on 1
6028                         if test_case != 200 {
6029                                 callback_node();
6030                         }
6031                         expect_htlc_forward!(&nodes[1]);
6032
6033                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
6034                         check_added_monitors!(&nodes[1], 1);
6035                         assert_eq!(update_1.update_add_htlcs.len(), 1);
6036                         // tamper update_add (1 => 2)
6037                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
6038                         if test_case != 3 && test_case != 200 {
6039                                 callback_msg(&mut update_add_1);
6040                         }
6041
6042                         // 1 => 2
6043                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
6044                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
6045
6046                         if test_case == 2 || test_case == 200 {
6047                                 expect_htlc_forward!(&nodes[2]);
6048                                 expect_event!(&nodes[2], Event::PaymentReceived);
6049                                 callback_node();
6050                         }
6051
6052                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6053                         if test_case == 2 || test_case == 200 {
6054                                 check_added_monitors!(&nodes[2], 1);
6055                         }
6056                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6057
6058                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6059                         if test_case == 200 {
6060                                 callback_fail(&mut fail_msg);
6061                         }
6062
6063                         // 2 => 1
6064                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
6065                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true, true);
6066
6067                         // backward fail on 1
6068                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6069                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6070                         update_1_0
6071                 },
6072                 _ => unreachable!(),
6073         };
6074
6075         // 1 => 0 commitment_signed_dance
6076         if update_1_0.update_fail_htlcs.len() > 0 {
6077                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6078                 if test_case == 100 {
6079                         callback_fail(&mut fail_msg);
6080                 }
6081                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
6082         } else {
6083                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
6084         };
6085
6086         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6087
6088         let events = nodes[0].node.get_and_clear_pending_events();
6089         assert_eq!(events.len(), 1);
6090         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6091                 assert_eq!(*rejected_by_dest, !expected_retryable);
6092                 assert_eq!(*error_code, expected_error_code);
6093         } else {
6094                 panic!("Uexpected event");
6095         }
6096
6097         let events = nodes[0].node.get_and_clear_pending_msg_events();
6098         if expected_channel_update.is_some() {
6099                 assert_eq!(events.len(), 1);
6100                 match events[0] {
6101                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6102                                 match update {
6103                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6104                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6105                                                         panic!("channel_update not found!");
6106                                                 }
6107                                         },
6108                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6109                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6110                                                         assert!(*short_channel_id == *expected_short_channel_id);
6111                                                         assert!(*is_permanent == *expected_is_permanent);
6112                                                 } else {
6113                                                         panic!("Unexpected message event");
6114                                                 }
6115                                         },
6116                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6117                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6118                                                         assert!(*node_id == *expected_node_id);
6119                                                         assert!(*is_permanent == *expected_is_permanent);
6120                                                 } else {
6121                                                         panic!("Unexpected message event");
6122                                                 }
6123                                         },
6124                                 }
6125                         },
6126                         _ => panic!("Unexpected message event"),
6127                 }
6128         } else {
6129                 assert_eq!(events.len(), 0);
6130         }
6131 }
6132
6133 impl msgs::ChannelUpdate {
6134         fn dummy() -> msgs::ChannelUpdate {
6135                 use secp256k1::ffi::Signature as FFISignature;
6136                 use secp256k1::Signature;
6137                 msgs::ChannelUpdate {
6138                         signature: Signature::from(FFISignature::new()),
6139                         contents: msgs::UnsignedChannelUpdate {
6140                                 chain_hash: Sha256dHash::from_data(&vec![0u8][..]),
6141                                 short_channel_id: 0,
6142                                 timestamp: 0,
6143                                 flags: 0,
6144                                 cltv_expiry_delta: 0,
6145                                 htlc_minimum_msat: 0,
6146                                 fee_base_msat: 0,
6147                                 fee_proportional_millionths: 0,
6148                                 excess_data: vec![],
6149                         }
6150                 }
6151         }
6152 }
6153
6154 #[test]
6155 fn test_onion_failure() {
6156         use ln::msgs::ChannelUpdate;
6157         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6158         use secp256k1;
6159
6160         const BADONION: u16 = 0x8000;
6161         const PERM: u16 = 0x4000;
6162         const NODE: u16 = 0x2000;
6163         const UPDATE: u16 = 0x1000;
6164
6165         let mut nodes = create_network(3);
6166         for node in nodes.iter() {
6167                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&Secp256k1::without_caps(), &[3; 32]).unwrap());
6168         }
6169         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
6170         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6171         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
6172         // positve case
6173         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
6174
6175         // intermediate node failure
6176         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6177                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6178                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6179                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6180                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
6181                 onion_payloads[0].realm = 3;
6182                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6183         }, ||{}, 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
6184
6185         // final node failure
6186         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6187                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6188                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6189                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6190                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
6191                 onion_payloads[1].realm = 3;
6192                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6193         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6194
6195         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6196         // receiving simulated fail messages
6197         // intermediate node failure
6198         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6199                 // trigger error
6200                 msg.amount_msat -= 1;
6201         }, |msg| {
6202                 // and tamper returing error message
6203                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6204                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6205                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6206         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
6207
6208         // final node failure
6209         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6210                 // and tamper returing error message
6211                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6212                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6213                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6214         }, ||{
6215                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6216         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
6217
6218         // intermediate node failure
6219         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6220                 msg.amount_msat -= 1;
6221         }, |msg| {
6222                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6223                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6224                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6225         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6226
6227         // final node failure
6228         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6229                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6230                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6231                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6232         }, ||{
6233                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6234         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6235
6236         // intermediate node failure
6237         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6238                 msg.amount_msat -= 1;
6239         }, |msg| {
6240                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6241                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6242                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6243         }, ||{
6244                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6245         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6246
6247         // final node failure
6248         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6249                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6250                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6251                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6252         }, ||{
6253                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6254         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6255
6256         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6257                 Some(BADONION|PERM|4), None);
6258
6259         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6260                 Some(BADONION|PERM|5), None);
6261
6262         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6263                 Some(BADONION|PERM|6), None);
6264
6265         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6266                 msg.amount_msat -= 1;
6267         }, |msg| {
6268                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6269                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6270                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6271         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6272
6273         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6274                 msg.amount_msat -= 1;
6275         }, |msg| {
6276                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6277                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6278                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6279                 // short_channel_id from the processing node
6280         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6281
6282         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6283                 msg.amount_msat -= 1;
6284         }, |msg| {
6285                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6286                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6287                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6288                 // short_channel_id from the processing node
6289         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6290
6291         let mut bogus_route = route.clone();
6292         bogus_route.hops[1].short_channel_id -= 1;
6293         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6294           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
6295
6296         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6297         let mut bogus_route = route.clone();
6298         let route_len = bogus_route.hops.len();
6299         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
6300         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6301
6302         //TODO: with new config API, we will be able to generate both valid and
6303         //invalid channel_update cases.
6304         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6305                 msg.amount_msat -= 1;
6306         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6307
6308         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6309                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6310                 msg.cltv_expiry -= 1;
6311         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6312
6313         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6314                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6315                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6316                 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6317         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6318
6319         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6320                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6321         }, false, Some(PERM|15), None);
6322
6323         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6324                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6325                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6326                 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6327         }, || {}, true, Some(17), None);
6328
6329         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6330                 for (_, mut pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6331                         for f in pending_forwards.iter_mut() {
6332                                 f.forward_info.outgoing_cltv_value += 1;
6333                         }
6334                 }
6335         }, true, Some(18), None);
6336
6337         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6338                 // violate amt_to_forward > msg.amount_msat
6339                 for (_, mut pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6340                         for f in pending_forwards.iter_mut() {
6341                                 f.forward_info.amt_to_forward -= 1;
6342                         }
6343                 }
6344         }, true, Some(19), None);
6345
6346         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6347                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6348                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6349                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6350         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6351         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6352
6353         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6354                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6355                 let mut route = route.clone();
6356                 let height = 1;
6357                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
6358                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6359                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
6360                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6361                 msg.cltv_expiry = htlc_cltv;
6362                 msg.onion_routing_packet = onion_packet;
6363         }, ||{}, true, Some(21), None);
6364 }