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