_ 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         // A --------------------> B ----------------------> C (preimage)
2652         // First, C should claim the HTLC output via HTLC-Success when its own latest local
2653         // commitment transaction was broadcast.
2654         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2655         // towards B.
2656         // B should be able to claim via preimage if A then broadcasts its local tx.
2657         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2658         // the HTLC output via the preimage it learned (which, once confirmed should generate a
2659         // PaymentSent event).
2660
2661         let nodes = create_network(3);
2662
2663         // Create some initial channels
2664         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2665         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2666
2667         // Rebalance the network a bit by relaying one payment through all the channels...
2668         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2669         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2670
2671         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2672         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2673
2674         // Broadcast legit commitment tx from C on B's chain
2675         // Broadcast HTLC Success transation by C on received output from C's commitment tx on B's chain
2676         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2677         assert_eq!(commitment_tx.len(), 1);
2678         check_spends!(commitment_tx[0], chan_2.3.clone());
2679         nodes[2].node.claim_funds(our_payment_preimage);
2680         check_added_monitors!(nodes[2], 1);
2681         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2682         assert!(updates.update_add_htlcs.is_empty());
2683         assert!(updates.update_fail_htlcs.is_empty());
2684         assert!(updates.update_fail_malformed_htlcs.is_empty());
2685         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2686
2687         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2688         check_closed_broadcast!(nodes[2]);
2689         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2690         assert_eq!(node_txn.len(), 3);
2691         assert_eq!(node_txn[1], commitment_tx[0]);
2692         assert_eq!(node_txn[0], node_txn[2]);
2693         check_spends!(node_txn[0], commitment_tx[0].clone());
2694         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2695         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2696         assert_eq!(node_txn[0].lock_time, 0);
2697
2698         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2699         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
2700         let events = nodes[1].node.get_and_clear_pending_msg_events();
2701         {
2702                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2703                 assert_eq!(added_monitors.len(), 1);
2704                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2705                 added_monitors.clear();
2706         }
2707         assert_eq!(events.len(), 2);
2708         match events[0] {
2709                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2710                 _ => panic!("Unexpected event"),
2711         }
2712         match events[1] {
2713                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2714                         assert!(update_add_htlcs.is_empty());
2715                         assert!(update_fail_htlcs.is_empty());
2716                         assert_eq!(update_fulfill_htlcs.len(), 1);
2717                         assert!(update_fail_malformed_htlcs.is_empty());
2718                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2719                 },
2720                 _ => panic!("Unexpected event"),
2721         };
2722         {
2723                 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2724                 // commitment transaction with a corresponding HTLC-Timeout transaction, as well as a
2725                 // timeout-claim of the output that nodes[2] just claimed via success.
2726                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (timeout tx) * 2 (block-rescan)
2727                 assert_eq!(node_txn.len(), 4);
2728                 assert_eq!(node_txn[0], node_txn[3]);
2729                 check_spends!(node_txn[0], commitment_tx[0].clone());
2730                 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2731                 assert_ne!(node_txn[0].lock_time, 0);
2732                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2733                 check_spends!(node_txn[1], chan_2.3.clone());
2734                 check_spends!(node_txn[2], node_txn[1].clone());
2735                 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2736                 assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2737                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2738                 assert_ne!(node_txn[2].lock_time, 0);
2739                 node_txn.clear();
2740         }
2741
2742         // Broadcast legit commitment tx from A on B's chain
2743         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2744         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2745         check_spends!(commitment_tx[0], chan_1.3.clone());
2746         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2747         check_closed_broadcast!(nodes[1]);
2748         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2749         assert_eq!(node_txn.len(), 3);
2750         assert_eq!(node_txn[0], node_txn[2]);
2751         check_spends!(node_txn[0], commitment_tx[0].clone());
2752         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2753         assert_eq!(node_txn[0].lock_time, 0);
2754         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2755         check_spends!(node_txn[1], chan_1.3.clone());
2756         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2757         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2758         // we already checked the same situation with A.
2759
2760         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2761         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2762         check_closed_broadcast!(nodes[0]);
2763         let events = nodes[0].node.get_and_clear_pending_events();
2764         assert_eq!(events.len(), 1);
2765         match events[0] {
2766                 Event::PaymentSent { payment_preimage } => {
2767                         assert_eq!(payment_preimage, our_payment_preimage);
2768                 },
2769                 _ => panic!("Unexpected event"),
2770         }
2771         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (HTLC-Timeout tx) * 2 (block-rescan)
2772         assert_eq!(node_txn.len(), 4);
2773         assert_eq!(node_txn[0], node_txn[3]);
2774         check_spends!(node_txn[0], commitment_tx[0].clone());
2775         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2776         assert_ne!(node_txn[0].lock_time, 0);
2777         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2778         check_spends!(node_txn[1], chan_1.3.clone());
2779         check_spends!(node_txn[2], node_txn[1].clone());
2780         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2781         assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2782         assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2783         assert_ne!(node_txn[2].lock_time, 0);
2784 }
2785
2786 #[test]
2787 fn test_htlc_on_chain_timeout() {
2788         // Test that in case of an unilateral close onchain, we detect the state of output thanks to
2789         // ChainWatchInterface and timeout the HTLC  bacward accordingly. So here we test that ChannelManager is
2790         // broadcasting the right event to other nodes in payment path.
2791         // A ------------------> B ----------------------> C (timeout)
2792         //    B's commitment tx                 C's commitment tx
2793         //            \                                  \
2794         //         B's HTLC timeout tx               B's timeout tx
2795
2796         let nodes = create_network(3);
2797
2798         // Create some intial channels
2799         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2800         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2801
2802         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2803         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2804         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2805
2806         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2807         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2808
2809         // Brodacast legit commitment tx from C on B's chain
2810         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2811         check_spends!(commitment_tx[0], chan_2.3.clone());
2812         nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
2813         check_added_monitors!(nodes[2], 0);
2814         expect_pending_htlcs_forwardable!(nodes[2]);
2815         check_added_monitors!(nodes[2], 1);
2816
2817         let events = nodes[2].node.get_and_clear_pending_msg_events();
2818         assert_eq!(events.len(), 1);
2819         match events[0] {
2820                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2821                         assert!(update_add_htlcs.is_empty());
2822                         assert!(!update_fail_htlcs.is_empty());
2823                         assert!(update_fulfill_htlcs.is_empty());
2824                         assert!(update_fail_malformed_htlcs.is_empty());
2825                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2826                 },
2827                 _ => panic!("Unexpected event"),
2828         };
2829         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2830         check_closed_broadcast!(nodes[2]);
2831         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2832         assert_eq!(node_txn.len(), 1);
2833         check_spends!(node_txn[0], chan_2.3.clone());
2834         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2835
2836         // Broadcast timeout transaction by B on received output fron C's commitment tx on B's chain
2837         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2838         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2839         let timeout_tx;
2840         {
2841                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2842                 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2843                 assert_eq!(node_txn[0], node_txn[5]);
2844                 assert_eq!(node_txn[1], node_txn[6]);
2845                 assert_eq!(node_txn[2], node_txn[7]);
2846                 check_spends!(node_txn[0], commitment_tx[0].clone());
2847                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2848                 check_spends!(node_txn[1], chan_2.3.clone());
2849                 check_spends!(node_txn[2], node_txn[1].clone());
2850                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2851                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2852                 check_spends!(node_txn[3], chan_2.3.clone());
2853                 check_spends!(node_txn[4], node_txn[3].clone());
2854                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2855                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2856                 timeout_tx = node_txn[0].clone();
2857                 node_txn.clear();
2858         }
2859
2860         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
2861         check_added_monitors!(nodes[1], 0);
2862         check_closed_broadcast!(nodes[1]);
2863
2864         expect_pending_htlcs_forwardable!(nodes[1]);
2865         check_added_monitors!(nodes[1], 1);
2866         let events = nodes[1].node.get_and_clear_pending_msg_events();
2867         assert_eq!(events.len(), 1);
2868         match events[0] {
2869                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2870                         assert!(update_add_htlcs.is_empty());
2871                         assert!(!update_fail_htlcs.is_empty());
2872                         assert!(update_fulfill_htlcs.is_empty());
2873                         assert!(update_fail_malformed_htlcs.is_empty());
2874                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2875                 },
2876                 _ => panic!("Unexpected event"),
2877         };
2878         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
2879         assert_eq!(node_txn.len(), 0);
2880
2881         // Broadcast legit commitment tx from B on A's chain
2882         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2883         check_spends!(commitment_tx[0], chan_1.3.clone());
2884
2885         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2886         check_closed_broadcast!(nodes[0]);
2887         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2888         assert_eq!(node_txn.len(), 4);
2889         assert_eq!(node_txn[0], node_txn[3]);
2890         check_spends!(node_txn[0], commitment_tx[0].clone());
2891         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2892         check_spends!(node_txn[1], chan_1.3.clone());
2893         check_spends!(node_txn[2], node_txn[1].clone());
2894         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2895         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2896 }
2897
2898 #[test]
2899 fn test_simple_commitment_revoked_fail_backward() {
2900         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2901         // and fail backward accordingly.
2902
2903         let nodes = create_network(3);
2904
2905         // Create some initial channels
2906         create_announced_chan_between_nodes(&nodes, 0, 1);
2907         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2908
2909         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2910         // Get the will-be-revoked local txn from nodes[2]
2911         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2912         // Revoke the old state
2913         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2914
2915         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2916
2917         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2918         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2919         check_added_monitors!(nodes[1], 0);
2920         check_closed_broadcast!(nodes[1]);
2921
2922         expect_pending_htlcs_forwardable!(nodes[1]);
2923         check_added_monitors!(nodes[1], 1);
2924         let events = nodes[1].node.get_and_clear_pending_msg_events();
2925         assert_eq!(events.len(), 1);
2926         match events[0] {
2927                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
2928                         assert!(update_add_htlcs.is_empty());
2929                         assert_eq!(update_fail_htlcs.len(), 1);
2930                         assert!(update_fulfill_htlcs.is_empty());
2931                         assert!(update_fail_malformed_htlcs.is_empty());
2932                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2933
2934                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2935                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2936
2937                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2938                         assert_eq!(events.len(), 1);
2939                         match events[0] {
2940                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2941                                 _ => panic!("Unexpected event"),
2942                         }
2943                         let events = nodes[0].node.get_and_clear_pending_events();
2944                         assert_eq!(events.len(), 1);
2945                         match events[0] {
2946                                 Event::PaymentFailed { .. } => {},
2947                                 _ => panic!("Unexpected event"),
2948                         }
2949                 },
2950                 _ => panic!("Unexpected event"),
2951         }
2952 }
2953
2954 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool) {
2955         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2956         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2957         // commitment transaction anymore.
2958         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2959         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2960         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2961         // technically disallowed and we should probably handle it reasonably.
2962         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2963         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2964         // transactions:
2965         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2966         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2967         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2968         //   and once they revoke the previous commitment transaction (allowing us to send a new
2969         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2970         let mut nodes = create_network(3);
2971
2972         // Create some initial channels
2973         create_announced_chan_between_nodes(&nodes, 0, 1);
2974         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2975
2976         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2977         // Get the will-be-revoked local txn from nodes[2]
2978         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2979         // Revoke the old state
2980         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2981
2982         let value = if use_dust {
2983                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2984                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2985                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2986         } else { 3000000 };
2987
2988         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2989         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2990         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2991
2992         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, 0));
2993         expect_pending_htlcs_forwardable!(nodes[2]);
2994         check_added_monitors!(nodes[2], 1);
2995         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2996         assert!(updates.update_add_htlcs.is_empty());
2997         assert!(updates.update_fulfill_htlcs.is_empty());
2998         assert!(updates.update_fail_malformed_htlcs.is_empty());
2999         assert_eq!(updates.update_fail_htlcs.len(), 1);
3000         assert!(updates.update_fee.is_none());
3001         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3002         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3003         // Drop the last RAA from 3 -> 2
3004
3005         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, 0));
3006         expect_pending_htlcs_forwardable!(nodes[2]);
3007         check_added_monitors!(nodes[2], 1);
3008         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3009         assert!(updates.update_add_htlcs.is_empty());
3010         assert!(updates.update_fulfill_htlcs.is_empty());
3011         assert!(updates.update_fail_malformed_htlcs.is_empty());
3012         assert_eq!(updates.update_fail_htlcs.len(), 1);
3013         assert!(updates.update_fee.is_none());
3014         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3015         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3016         check_added_monitors!(nodes[1], 1);
3017         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3018         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3019         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3020         check_added_monitors!(nodes[2], 1);
3021
3022         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, 0));
3023         expect_pending_htlcs_forwardable!(nodes[2]);
3024         check_added_monitors!(nodes[2], 1);
3025         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3026         assert!(updates.update_add_htlcs.is_empty());
3027         assert!(updates.update_fulfill_htlcs.is_empty());
3028         assert!(updates.update_fail_malformed_htlcs.is_empty());
3029         assert_eq!(updates.update_fail_htlcs.len(), 1);
3030         assert!(updates.update_fee.is_none());
3031         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
3032         // At this point first_payment_hash has dropped out of the latest two commitment
3033         // transactions that nodes[1] is tracking...
3034         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
3035         check_added_monitors!(nodes[1], 1);
3036         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3037         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3038         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
3039         check_added_monitors!(nodes[2], 1);
3040
3041         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3042         // on nodes[2]'s RAA.
3043         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3044         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3045         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
3046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3047         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3048         check_added_monitors!(nodes[1], 0);
3049
3050         if deliver_bs_raa {
3051                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
3052                 // One monitor for the new revocation preimage, one as we generate a commitment for
3053                 // nodes[0] to fail first_payment_hash backwards.
3054                 check_added_monitors!(nodes[1], 1);
3055                 let events = nodes[1].node.get_and_clear_pending_events();
3056                 assert_eq!(events.len(), 1);
3057                 match events[0] {
3058                         Event::PendingHTLCsForwardable { .. } => { },
3059                         _ => panic!("Unexpected event"),
3060                 };
3061                 // Deliberately don't process the pending fail-back so they all fail back at once after
3062                 // block connection just like the !deliver_bs_raa case
3063         }
3064
3065         let mut failed_htlcs = HashSet::new();
3066         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3067
3068         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3069         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3070
3071         let events = nodes[1].node.get_and_clear_pending_events();
3072         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3073         match events[0] {
3074                 Event::PaymentFailed { ref payment_hash, .. } => {
3075                         assert_eq!(*payment_hash, fourth_payment_hash);
3076                 },
3077                 _ => panic!("Unexpected event"),
3078         }
3079         if !deliver_bs_raa {
3080                 match events[1] {
3081                         Event::PendingHTLCsForwardable { .. } => { },
3082                         _ => panic!("Unexpected event"),
3083                 };
3084         }
3085         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3086         nodes[1].node.process_pending_htlc_forwards();
3087         check_added_monitors!(nodes[1], 1);
3088
3089         let events = nodes[1].node.get_and_clear_pending_msg_events();
3090         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3091         match events[if deliver_bs_raa { 1 } else { 0 }] {
3092                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3093                 _ => panic!("Unexpected event"),
3094         }
3095         if deliver_bs_raa {
3096                 match events[0] {
3097                         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, .. } } => {
3098                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3099                                 assert_eq!(update_add_htlcs.len(), 1);
3100                                 assert!(update_fulfill_htlcs.is_empty());
3101                                 assert!(update_fail_htlcs.is_empty());
3102                                 assert!(update_fail_malformed_htlcs.is_empty());
3103                         },
3104                         _ => panic!("Unexpected event"),
3105                 }
3106         }
3107         match events[if deliver_bs_raa { 2 } else { 1 }] {
3108                 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, .. } } => {
3109                         assert!(update_add_htlcs.is_empty());
3110                         assert_eq!(update_fail_htlcs.len(), 3);
3111                         assert!(update_fulfill_htlcs.is_empty());
3112                         assert!(update_fail_malformed_htlcs.is_empty());
3113                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3114
3115                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
3116                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]).unwrap();
3117                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]).unwrap();
3118
3119                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3120
3121                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3122                         // If we delievered B's RAA we got an unknown preimage error, not something
3123                         // that we should update our routing table for.
3124                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3125                         for event in events {
3126                                 match event {
3127                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3128                                         _ => panic!("Unexpected event"),
3129                                 }
3130                         }
3131                         let events = nodes[0].node.get_and_clear_pending_events();
3132                         assert_eq!(events.len(), 3);
3133                         match events[0] {
3134                                 Event::PaymentFailed { ref payment_hash, .. } => {
3135                                         assert!(failed_htlcs.insert(payment_hash.0));
3136                                 },
3137                                 _ => panic!("Unexpected event"),
3138                         }
3139                         match events[1] {
3140                                 Event::PaymentFailed { ref payment_hash, .. } => {
3141                                         assert!(failed_htlcs.insert(payment_hash.0));
3142                                 },
3143                                 _ => panic!("Unexpected event"),
3144                         }
3145                         match events[2] {
3146                                 Event::PaymentFailed { ref payment_hash, .. } => {
3147                                         assert!(failed_htlcs.insert(payment_hash.0));
3148                                 },
3149                                 _ => panic!("Unexpected event"),
3150                         }
3151                 },
3152                 _ => panic!("Unexpected event"),
3153         }
3154
3155         assert!(failed_htlcs.contains(&first_payment_hash.0));
3156         assert!(failed_htlcs.contains(&second_payment_hash.0));
3157         assert!(failed_htlcs.contains(&third_payment_hash.0));
3158 }
3159
3160 #[test]
3161 fn test_commitment_revoked_fail_backward_exhaustive() {
3162         do_test_commitment_revoked_fail_backward_exhaustive(false, true);
3163         do_test_commitment_revoked_fail_backward_exhaustive(true, true);
3164         do_test_commitment_revoked_fail_backward_exhaustive(false, false);
3165         do_test_commitment_revoked_fail_backward_exhaustive(true, false);
3166 }
3167
3168 #[test]
3169 fn test_htlc_ignore_latest_remote_commitment() {
3170         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3171         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3172         let nodes = create_network(2);
3173         create_announced_chan_between_nodes(&nodes, 0, 1);
3174
3175         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3176         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3177         check_closed_broadcast!(nodes[0]);
3178
3179         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3180         assert_eq!(node_txn.len(), 2);
3181
3182         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3183         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3184         check_closed_broadcast!(nodes[1]);
3185
3186         // Duplicate the block_connected call since this may happen due to other listeners
3187         // registering new transactions
3188         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
3189 }
3190
3191 #[test]
3192 fn test_force_close_fail_back() {
3193         // Check which HTLCs are failed-backwards on channel force-closure
3194         let mut nodes = create_network(3);
3195         create_announced_chan_between_nodes(&nodes, 0, 1);
3196         create_announced_chan_between_nodes(&nodes, 1, 2);
3197
3198         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3199
3200         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3201
3202         let mut payment_event = {
3203                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3204                 check_added_monitors!(nodes[0], 1);
3205
3206                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3207                 assert_eq!(events.len(), 1);
3208                 SendEvent::from_event(events.remove(0))
3209         };
3210
3211         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3212         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3213
3214         expect_pending_htlcs_forwardable!(nodes[1]);
3215
3216         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3217         assert_eq!(events_2.len(), 1);
3218         payment_event = SendEvent::from_event(events_2.remove(0));
3219         assert_eq!(payment_event.msgs.len(), 1);
3220
3221         check_added_monitors!(nodes[1], 1);
3222         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3223         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3224         check_added_monitors!(nodes[2], 1);
3225         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3226
3227         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3228         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3229         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3230
3231         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3232         check_closed_broadcast!(nodes[2]);
3233         let tx = {
3234                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3235                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3236                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3237                 // back to nodes[1] upon timeout otherwise.
3238                 assert_eq!(node_txn.len(), 1);
3239                 node_txn.remove(0)
3240         };
3241
3242         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3243         nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3244
3245         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3246         check_closed_broadcast!(nodes[1]);
3247
3248         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3249         {
3250                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3251                 monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
3252                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3253         }
3254         nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
3255         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3256         assert_eq!(node_txn.len(), 1);
3257         assert_eq!(node_txn[0].input.len(), 1);
3258         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3259         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3260         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3261
3262         check_spends!(node_txn[0], tx);
3263 }
3264
3265 #[test]
3266 fn test_unconf_chan() {
3267         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3268         let nodes = create_network(2);
3269         create_announced_chan_between_nodes(&nodes, 0, 1);
3270
3271         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3272         assert_eq!(channel_state.by_id.len(), 1);
3273         assert_eq!(channel_state.short_to_id.len(), 1);
3274         mem::drop(channel_state);
3275
3276         let mut headers = Vec::new();
3277         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3278         headers.push(header.clone());
3279         for _i in 2..100 {
3280                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3281                 headers.push(header.clone());
3282         }
3283         while !headers.is_empty() {
3284                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3285         }
3286         check_closed_broadcast!(nodes[0]);
3287         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3288         assert_eq!(channel_state.by_id.len(), 0);
3289         assert_eq!(channel_state.short_to_id.len(), 0);
3290 }
3291
3292 macro_rules! get_chan_reestablish_msgs {
3293         ($src_node: expr, $dst_node: expr) => {
3294                 {
3295                         let mut res = Vec::with_capacity(1);
3296                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
3297                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3298                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3299                                         res.push(msg.clone());
3300                                 } else {
3301                                         panic!("Unexpected event")
3302                                 }
3303                         }
3304                         res
3305                 }
3306         }
3307 }
3308
3309 macro_rules! handle_chan_reestablish_msgs {
3310         ($src_node: expr, $dst_node: expr) => {
3311                 {
3312                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3313                         let mut idx = 0;
3314                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
3315                                 idx += 1;
3316                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3317                                 Some(msg.clone())
3318                         } else {
3319                                 None
3320                         };
3321
3322                         let mut revoke_and_ack = None;
3323                         let mut commitment_update = None;
3324                         let order = if let Some(ev) = msg_events.get(idx) {
3325                                 idx += 1;
3326                                 match ev {
3327                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3328                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3329                                                 revoke_and_ack = Some(msg.clone());
3330                                                 RAACommitmentOrder::RevokeAndACKFirst
3331                                         },
3332                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3333                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3334                                                 commitment_update = Some(updates.clone());
3335                                                 RAACommitmentOrder::CommitmentFirst
3336                                         },
3337                                         _ => panic!("Unexpected event"),
3338                                 }
3339                         } else {
3340                                 RAACommitmentOrder::CommitmentFirst
3341                         };
3342
3343                         if let Some(ev) = msg_events.get(idx) {
3344                                 match ev {
3345                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3346                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3347                                                 assert!(revoke_and_ack.is_none());
3348                                                 revoke_and_ack = Some(msg.clone());
3349                                         },
3350                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3351                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3352                                                 assert!(commitment_update.is_none());
3353                                                 commitment_update = Some(updates.clone());
3354                                         },
3355                                         _ => panic!("Unexpected event"),
3356                                 }
3357                         }
3358
3359                         (funding_locked, revoke_and_ack, commitment_update, order)
3360                 }
3361         }
3362 }
3363
3364 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3365 /// for claims/fails they are separated out.
3366 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)) {
3367         node_a.node.peer_connected(&node_b.node.get_our_node_id());
3368         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3369         node_b.node.peer_connected(&node_a.node.get_our_node_id());
3370         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3371
3372         if send_funding_locked.0 {
3373                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
3374                 // from b
3375                 for reestablish in reestablish_1.iter() {
3376                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3377                 }
3378         }
3379         if send_funding_locked.1 {
3380                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
3381                 // from a
3382                 for reestablish in reestablish_2.iter() {
3383                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3384                 }
3385         }
3386         if send_funding_locked.0 || send_funding_locked.1 {
3387                 // If we expect any funding_locked's, both sides better have set
3388                 // next_local_commitment_number to 1
3389                 for reestablish in reestablish_1.iter() {
3390                         assert_eq!(reestablish.next_local_commitment_number, 1);
3391                 }
3392                 for reestablish in reestablish_2.iter() {
3393                         assert_eq!(reestablish.next_local_commitment_number, 1);
3394                 }
3395         }
3396
3397         let mut resp_1 = Vec::new();
3398         for msg in reestablish_1 {
3399                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
3400                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3401         }
3402         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3403                 check_added_monitors!(node_b, 1);
3404         } else {
3405                 check_added_monitors!(node_b, 0);
3406         }
3407
3408         let mut resp_2 = Vec::new();
3409         for msg in reestablish_2 {
3410                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
3411                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3412         }
3413         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3414                 check_added_monitors!(node_a, 1);
3415         } else {
3416                 check_added_monitors!(node_a, 0);
3417         }
3418
3419         // We dont yet support both needing updates, as that would require a different commitment dance:
3420         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3421                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3422
3423         for chan_msgs in resp_1.drain(..) {
3424                 if send_funding_locked.0 {
3425                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3426                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3427                         if !announcement_event.is_empty() {
3428                                 assert_eq!(announcement_event.len(), 1);
3429                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3430                                         //TODO: Test announcement_sigs re-sending
3431                                 } else { panic!("Unexpected event!"); }
3432                         }
3433                 } else {
3434                         assert!(chan_msgs.0.is_none());
3435                 }
3436                 if pending_raa.0 {
3437                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3438                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3439                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3440                         check_added_monitors!(node_a, 1);
3441                 } else {
3442                         assert!(chan_msgs.1.is_none());
3443                 }
3444                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3445                         let commitment_update = chan_msgs.2.unwrap();
3446                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3447                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3448                         } else {
3449                                 assert!(commitment_update.update_add_htlcs.is_empty());
3450                         }
3451                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3452                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3453                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3454                         for update_add in commitment_update.update_add_htlcs {
3455                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
3456                         }
3457                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3458                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
3459                         }
3460                         for update_fail in commitment_update.update_fail_htlcs {
3461                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
3462                         }
3463
3464                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3465                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3466                         } else {
3467                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3468                                 check_added_monitors!(node_a, 1);
3469                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3470                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3471                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3472                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3473                                 check_added_monitors!(node_b, 1);
3474                         }
3475                 } else {
3476                         assert!(chan_msgs.2.is_none());
3477                 }
3478         }
3479
3480         for chan_msgs in resp_2.drain(..) {
3481                 if send_funding_locked.1 {
3482                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
3483                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3484                         if !announcement_event.is_empty() {
3485                                 assert_eq!(announcement_event.len(), 1);
3486                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
3487                                         //TODO: Test announcement_sigs re-sending
3488                                 } else { panic!("Unexpected event!"); }
3489                         }
3490                 } else {
3491                         assert!(chan_msgs.0.is_none());
3492                 }
3493                 if pending_raa.1 {
3494                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3495                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
3496                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3497                         check_added_monitors!(node_b, 1);
3498                 } else {
3499                         assert!(chan_msgs.1.is_none());
3500                 }
3501                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3502                         let commitment_update = chan_msgs.2.unwrap();
3503                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3504                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3505                         }
3506                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3507                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
3508                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3509                         for update_add in commitment_update.update_add_htlcs {
3510                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
3511                         }
3512                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3513                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
3514                         }
3515                         for update_fail in commitment_update.update_fail_htlcs {
3516                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
3517                         }
3518
3519                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3520                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3521                         } else {
3522                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3523                                 check_added_monitors!(node_b, 1);
3524                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3525                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3526                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3527                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3528                                 check_added_monitors!(node_a, 1);
3529                         }
3530                 } else {
3531                         assert!(chan_msgs.2.is_none());
3532                 }
3533         }
3534 }
3535
3536 #[test]
3537 fn test_simple_peer_disconnect() {
3538         // Test that we can reconnect when there are no lost messages
3539         let nodes = create_network(3);
3540         create_announced_chan_between_nodes(&nodes, 0, 1);
3541         create_announced_chan_between_nodes(&nodes, 1, 2);
3542
3543         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3544         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3545         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3546
3547         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3548         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3549         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3550         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3551
3552         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3553         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3554         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3555
3556         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3557         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3558         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3559         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3560
3561         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3562         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3563
3564         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
3565         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3566
3567         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3568         {
3569                 let events = nodes[0].node.get_and_clear_pending_events();
3570                 assert_eq!(events.len(), 2);
3571                 match events[0] {
3572                         Event::PaymentSent { payment_preimage } => {
3573                                 assert_eq!(payment_preimage, payment_preimage_3);
3574                         },
3575                         _ => panic!("Unexpected event"),
3576                 }
3577                 match events[1] {
3578                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3579                                 assert_eq!(payment_hash, payment_hash_5);
3580                                 assert!(rejected_by_dest);
3581                         },
3582                         _ => panic!("Unexpected event"),
3583                 }
3584         }
3585
3586         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3587         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3588 }
3589
3590 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3591         // Test that we can reconnect when in-flight HTLC updates get dropped
3592         let mut nodes = create_network(2);
3593         if messages_delivered == 0 {
3594                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
3595                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3596         } else {
3597                 create_announced_chan_between_nodes(&nodes, 0, 1);
3598         }
3599
3600         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();
3601         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3602
3603         let payment_event = {
3604                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3605                 check_added_monitors!(nodes[0], 1);
3606
3607                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3608                 assert_eq!(events.len(), 1);
3609                 SendEvent::from_event(events.remove(0))
3610         };
3611         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3612
3613         if messages_delivered < 2 {
3614                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3615         } else {
3616                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3617                 if messages_delivered >= 3 {
3618                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
3619                         check_added_monitors!(nodes[1], 1);
3620                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3621
3622                         if messages_delivered >= 4 {
3623                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3624                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3625                                 check_added_monitors!(nodes[0], 1);
3626
3627                                 if messages_delivered >= 5 {
3628                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
3629                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3630                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3631                                         check_added_monitors!(nodes[0], 1);
3632
3633                                         if messages_delivered >= 6 {
3634                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3635                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3636                                                 check_added_monitors!(nodes[1], 1);
3637                                         }
3638                                 }
3639                         }
3640                 }
3641         }
3642
3643         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3644         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3645         if messages_delivered < 3 {
3646                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3647                 // received on either side, both sides will need to resend them.
3648                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3649         } else if messages_delivered == 3 {
3650                 // nodes[0] still wants its RAA + commitment_signed
3651                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3652         } else if messages_delivered == 4 {
3653                 // nodes[0] still wants its commitment_signed
3654                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3655         } else if messages_delivered == 5 {
3656                 // nodes[1] still wants its final RAA
3657                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3658         } else if messages_delivered == 6 {
3659                 // Everything was delivered...
3660                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3661         }
3662
3663         let events_1 = nodes[1].node.get_and_clear_pending_events();
3664         assert_eq!(events_1.len(), 1);
3665         match events_1[0] {
3666                 Event::PendingHTLCsForwardable { .. } => { },
3667                 _ => panic!("Unexpected event"),
3668         };
3669
3670         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3671         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3672         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3673
3674         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
3675         nodes[1].node.process_pending_htlc_forwards();
3676
3677         let events_2 = nodes[1].node.get_and_clear_pending_events();
3678         assert_eq!(events_2.len(), 1);
3679         match events_2[0] {
3680                 Event::PaymentReceived { ref payment_hash, amt } => {
3681                         assert_eq!(payment_hash_1, *payment_hash);
3682                         assert_eq!(amt, 1000000);
3683                 },
3684                 _ => panic!("Unexpected event"),
3685         }
3686
3687         nodes[1].node.claim_funds(payment_preimage_1);
3688         check_added_monitors!(nodes[1], 1);
3689
3690         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3691         assert_eq!(events_3.len(), 1);
3692         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3693                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3694                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3695                         assert!(updates.update_add_htlcs.is_empty());
3696                         assert!(updates.update_fail_htlcs.is_empty());
3697                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3698                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3699                         assert!(updates.update_fee.is_none());
3700                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3701                 },
3702                 _ => panic!("Unexpected event"),
3703         };
3704
3705         if messages_delivered >= 1 {
3706                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
3707
3708                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3709                 assert_eq!(events_4.len(), 1);
3710                 match events_4[0] {
3711                         Event::PaymentSent { ref payment_preimage } => {
3712                                 assert_eq!(payment_preimage_1, *payment_preimage);
3713                         },
3714                         _ => panic!("Unexpected event"),
3715                 }
3716
3717                 if messages_delivered >= 2 {
3718                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3719                         check_added_monitors!(nodes[0], 1);
3720                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3721
3722                         if messages_delivered >= 3 {
3723                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3724                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3725                                 check_added_monitors!(nodes[1], 1);
3726
3727                                 if messages_delivered >= 4 {
3728                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
3729                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3730                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3731                                         check_added_monitors!(nodes[1], 1);
3732
3733                                         if messages_delivered >= 5 {
3734                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3735                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3736                                                 check_added_monitors!(nodes[0], 1);
3737                                         }
3738                                 }
3739                         }
3740                 }
3741         }
3742
3743         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3744         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3745         if messages_delivered < 2 {
3746                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3747                 //TODO: Deduplicate PaymentSent events, then enable this if:
3748                 //if messages_delivered < 1 {
3749                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3750                         assert_eq!(events_4.len(), 1);
3751                         match events_4[0] {
3752                                 Event::PaymentSent { ref payment_preimage } => {
3753                                         assert_eq!(payment_preimage_1, *payment_preimage);
3754                                 },
3755                                 _ => panic!("Unexpected event"),
3756                         }
3757                 //}
3758         } else if messages_delivered == 2 {
3759                 // nodes[0] still wants its RAA + commitment_signed
3760                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3761         } else if messages_delivered == 3 {
3762                 // nodes[0] still wants its commitment_signed
3763                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3764         } else if messages_delivered == 4 {
3765                 // nodes[1] still wants its final RAA
3766                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3767         } else if messages_delivered == 5 {
3768                 // Everything was delivered...
3769                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3770         }
3771
3772         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3773         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3774         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3775
3776         // Channel should still work fine...
3777         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3778         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3779 }
3780
3781 #[test]
3782 fn test_drop_messages_peer_disconnect_a() {
3783         do_test_drop_messages_peer_disconnect(0);
3784         do_test_drop_messages_peer_disconnect(1);
3785         do_test_drop_messages_peer_disconnect(2);
3786         do_test_drop_messages_peer_disconnect(3);
3787 }
3788
3789 #[test]
3790 fn test_drop_messages_peer_disconnect_b() {
3791         do_test_drop_messages_peer_disconnect(4);
3792         do_test_drop_messages_peer_disconnect(5);
3793         do_test_drop_messages_peer_disconnect(6);
3794 }
3795
3796 #[test]
3797 fn test_funding_peer_disconnect() {
3798         // Test that we can lock in our funding tx while disconnected
3799         let nodes = create_network(2);
3800         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3801
3802         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3803         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3804
3805         confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
3806         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3807         assert_eq!(events_1.len(), 1);
3808         match events_1[0] {
3809                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3810                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3811                 },
3812                 _ => panic!("Unexpected event"),
3813         }
3814
3815         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3816
3817         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3818         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3819
3820         confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
3821         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3822         assert_eq!(events_2.len(), 2);
3823         match events_2[0] {
3824                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3825                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3826                 },
3827                 _ => panic!("Unexpected event"),
3828         }
3829         match events_2[1] {
3830                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
3831                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3832                 },
3833                 _ => panic!("Unexpected event"),
3834         }
3835
3836         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3837
3838         // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
3839         // rebroadcasting announcement_signatures upon reconnect.
3840
3841         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();
3842         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3843         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3844 }
3845
3846 #[test]
3847 fn test_drop_messages_peer_disconnect_dual_htlc() {
3848         // Test that we can handle reconnecting when both sides of a channel have pending
3849         // commitment_updates when we disconnect.
3850         let mut nodes = create_network(2);
3851         create_announced_chan_between_nodes(&nodes, 0, 1);
3852
3853         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3854
3855         // Now try to send a second payment which will fail to send
3856         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3857         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3858
3859         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3860         check_added_monitors!(nodes[0], 1);
3861
3862         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3863         assert_eq!(events_1.len(), 1);
3864         match events_1[0] {
3865                 MessageSendEvent::UpdateHTLCs { .. } => {},
3866                 _ => panic!("Unexpected event"),
3867         }
3868
3869         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3870         check_added_monitors!(nodes[1], 1);
3871
3872         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3873         assert_eq!(events_2.len(), 1);
3874         match events_2[0] {
3875                 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 } } => {
3876                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3877                         assert!(update_add_htlcs.is_empty());
3878                         assert_eq!(update_fulfill_htlcs.len(), 1);
3879                         assert!(update_fail_htlcs.is_empty());
3880                         assert!(update_fail_malformed_htlcs.is_empty());
3881                         assert!(update_fee.is_none());
3882
3883                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3884                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3885                         assert_eq!(events_3.len(), 1);
3886                         match events_3[0] {
3887                                 Event::PaymentSent { ref payment_preimage } => {
3888                                         assert_eq!(*payment_preimage, payment_preimage_1);
3889                                 },
3890                                 _ => panic!("Unexpected event"),
3891                         }
3892
3893                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3894                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3895                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3896                         check_added_monitors!(nodes[0], 1);
3897                 },
3898                 _ => panic!("Unexpected event"),
3899         }
3900
3901         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3902         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3903
3904         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3905         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3906         assert_eq!(reestablish_1.len(), 1);
3907         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3908         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3909         assert_eq!(reestablish_2.len(), 1);
3910
3911         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3912         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3913         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3914         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3915
3916         assert!(as_resp.0.is_none());
3917         assert!(bs_resp.0.is_none());
3918
3919         assert!(bs_resp.1.is_none());
3920         assert!(bs_resp.2.is_none());
3921
3922         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3923
3924         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3925         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3926         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3927         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3928         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3929         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();
3930         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3931         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3932         // No commitment_signed so get_event_msg's assert(len == 1) passes
3933         check_added_monitors!(nodes[1], 1);
3934
3935         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3936         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3937         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3938         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3939         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3940         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3941         assert!(bs_second_commitment_signed.update_fee.is_none());
3942         check_added_monitors!(nodes[1], 1);
3943
3944         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3945         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3946         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3947         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3948         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3949         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3950         assert!(as_commitment_signed.update_fee.is_none());
3951         check_added_monitors!(nodes[0], 1);
3952
3953         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3954         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3955         // No commitment_signed so get_event_msg's assert(len == 1) passes
3956         check_added_monitors!(nodes[0], 1);
3957
3958         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3959         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3960         // No commitment_signed so get_event_msg's assert(len == 1) passes
3961         check_added_monitors!(nodes[1], 1);
3962
3963         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3964         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3965         check_added_monitors!(nodes[1], 1);
3966
3967         expect_pending_htlcs_forwardable!(nodes[1]);
3968
3969         let events_5 = nodes[1].node.get_and_clear_pending_events();
3970         assert_eq!(events_5.len(), 1);
3971         match events_5[0] {
3972                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3973                         assert_eq!(payment_hash_2, *payment_hash);
3974                 },
3975                 _ => panic!("Unexpected event"),
3976         }
3977
3978         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3979         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3980         check_added_monitors!(nodes[0], 1);
3981
3982         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3983 }
3984
3985 #[test]
3986 fn test_simple_monitor_permanent_update_fail() {
3987         // Test that we handle a simple permanent monitor update failure
3988         let mut nodes = create_network(2);
3989         create_announced_chan_between_nodes(&nodes, 0, 1);
3990
3991         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3992         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3993
3994         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
3995         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
3996         check_added_monitors!(nodes[0], 1);
3997
3998         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3999         assert_eq!(events_1.len(), 2);
4000         match events_1[0] {
4001                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4002                 _ => panic!("Unexpected event"),
4003         };
4004         match events_1[1] {
4005                 MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
4006                 _ => panic!("Unexpected event"),
4007         };
4008
4009         // TODO: Once we hit the chain with the failure transaction we should check that we get a
4010         // PaymentFailed event
4011
4012         assert_eq!(nodes[0].node.list_channels().len(), 0);
4013 }
4014
4015 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
4016         // Test that we can recover from a simple temporary monitor update failure optionally with
4017         // a disconnect in between
4018         let mut nodes = create_network(2);
4019         create_announced_chan_between_nodes(&nodes, 0, 1);
4020
4021         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4022         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
4023
4024         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4025         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
4026         check_added_monitors!(nodes[0], 1);
4027
4028         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4029         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4030         assert_eq!(nodes[0].node.list_channels().len(), 1);
4031
4032         if disconnect {
4033                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4034                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4035                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4036         }
4037
4038         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4039         nodes[0].node.test_restore_channel_monitor();
4040         check_added_monitors!(nodes[0], 1);
4041
4042         let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
4043         assert_eq!(events_2.len(), 1);
4044         let payment_event = SendEvent::from_event(events_2.pop().unwrap());
4045         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4046         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4047         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4048
4049         expect_pending_htlcs_forwardable!(nodes[1]);
4050
4051         let events_3 = nodes[1].node.get_and_clear_pending_events();
4052         assert_eq!(events_3.len(), 1);
4053         match events_3[0] {
4054                 Event::PaymentReceived { ref payment_hash, amt } => {
4055                         assert_eq!(payment_hash_1, *payment_hash);
4056                         assert_eq!(amt, 1000000);
4057                 },
4058                 _ => panic!("Unexpected event"),
4059         }
4060
4061         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
4062
4063         // Now set it to failed again...
4064         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4065         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4066         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
4067         check_added_monitors!(nodes[0], 1);
4068
4069         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4070         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4071         assert_eq!(nodes[0].node.list_channels().len(), 1);
4072
4073         if disconnect {
4074                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4075                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4076                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4077         }
4078
4079         // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
4080         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
4081         nodes[0].node.test_restore_channel_monitor();
4082         check_added_monitors!(nodes[0], 1);
4083         check_closed_broadcast!(nodes[0]);
4084
4085         // TODO: Once we hit the chain with the failure transaction we should check that we get a
4086         // PaymentFailed event
4087
4088         assert_eq!(nodes[0].node.list_channels().len(), 0);
4089 }
4090
4091 #[test]
4092 fn test_simple_monitor_temporary_update_fail() {
4093         do_test_simple_monitor_temporary_update_fail(false);
4094         do_test_simple_monitor_temporary_update_fail(true);
4095 }
4096
4097 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
4098         let disconnect_flags = 8 | 16;
4099
4100         // Test that we can recover from a temporary monitor update failure with some in-flight
4101         // HTLCs going on at the same time potentially with some disconnection thrown in.
4102         // * First we route a payment, then get a temporary monitor update failure when trying to
4103         //   route a second payment. We then claim the first payment.
4104         // * If disconnect_count is set, we will disconnect at this point (which is likely as
4105         //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
4106         //   the ChannelMonitor on a watchtower).
4107         // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
4108         //   immediately, otherwise we wait sconnect and deliver them via the reconnect
4109         //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
4110         //   disconnect_count & !disconnect_flags is 0).
4111         // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
4112         //   through message sending, potentially disconnect/reconnecting multiple times based on
4113         //   disconnect_count, to get the update_fulfill_htlc through.
4114         // * We then walk through more message exchanges to get the original update_add_htlc
4115         //   through, swapping message ordering based on disconnect_count & 8 and optionally
4116         //   disconnect/reconnecting based on disconnect_count.
4117         let mut nodes = create_network(2);
4118         create_announced_chan_between_nodes(&nodes, 0, 1);
4119
4120         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4121
4122         // Now try to send a second payment which will fail to send
4123         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4124         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4125
4126         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4127         if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
4128         check_added_monitors!(nodes[0], 1);
4129
4130         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4131         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4132         assert_eq!(nodes[0].node.list_channels().len(), 1);
4133
4134         // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
4135         // but nodes[0] won't respond since it is frozen.
4136         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4137         check_added_monitors!(nodes[1], 1);
4138         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4139         assert_eq!(events_2.len(), 1);
4140         let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
4141                 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 } } => {
4142                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4143                         assert!(update_add_htlcs.is_empty());
4144                         assert_eq!(update_fulfill_htlcs.len(), 1);
4145                         assert!(update_fail_htlcs.is_empty());
4146                         assert!(update_fail_malformed_htlcs.is_empty());
4147                         assert!(update_fee.is_none());
4148
4149                         if (disconnect_count & 16) == 0 {
4150                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
4151                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
4152                                 assert_eq!(events_3.len(), 1);
4153                                 match events_3[0] {
4154                                         Event::PaymentSent { ref payment_preimage } => {
4155                                                 assert_eq!(*payment_preimage, payment_preimage_1);
4156                                         },
4157                                         _ => panic!("Unexpected event"),
4158                                 }
4159
4160                                 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) {
4161                                         assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4162                                 } else { panic!(); }
4163                         }
4164
4165                         (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
4166                 },
4167                 _ => panic!("Unexpected event"),
4168         };
4169
4170         if disconnect_count & !disconnect_flags > 0 {
4171                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4172                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4173         }
4174
4175         // Now fix monitor updating...
4176         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4177         nodes[0].node.test_restore_channel_monitor();
4178         check_added_monitors!(nodes[0], 1);
4179
4180         macro_rules! disconnect_reconnect_peers { () => { {
4181                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4182                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4183
4184                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4185                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4186                 assert_eq!(reestablish_1.len(), 1);
4187                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4188                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4189                 assert_eq!(reestablish_2.len(), 1);
4190
4191                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4192                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4193                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4194                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4195
4196                 assert!(as_resp.0.is_none());
4197                 assert!(bs_resp.0.is_none());
4198
4199                 (reestablish_1, reestablish_2, as_resp, bs_resp)
4200         } } }
4201
4202         let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
4203                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4204                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4205
4206                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4207                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4208                 assert_eq!(reestablish_1.len(), 1);
4209                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4210                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4211                 assert_eq!(reestablish_2.len(), 1);
4212
4213                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4214                 check_added_monitors!(nodes[0], 0);
4215                 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4216                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4217                 check_added_monitors!(nodes[1], 0);
4218                 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4219
4220                 assert!(as_resp.0.is_none());
4221                 assert!(bs_resp.0.is_none());
4222
4223                 assert!(bs_resp.1.is_none());
4224                 if (disconnect_count & 16) == 0 {
4225                         assert!(bs_resp.2.is_none());
4226
4227                         assert!(as_resp.1.is_some());
4228                         assert!(as_resp.2.is_some());
4229                         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4230                 } else {
4231                         assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
4232                         assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4233                         assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4234                         assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
4235                         assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
4236                         assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
4237
4238                         assert!(as_resp.1.is_none());
4239
4240                         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();
4241                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4242                         assert_eq!(events_3.len(), 1);
4243                         match events_3[0] {
4244                                 Event::PaymentSent { ref payment_preimage } => {
4245                                         assert_eq!(*payment_preimage, payment_preimage_1);
4246                                 },
4247                                 _ => panic!("Unexpected event"),
4248                         }
4249
4250                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
4251                         let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4252                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4253                         check_added_monitors!(nodes[0], 1);
4254
4255                         as_resp.1 = Some(as_resp_raa);
4256                         bs_resp.2 = None;
4257                 }
4258
4259                 if disconnect_count & !disconnect_flags > 1 {
4260                         let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
4261
4262                         if (disconnect_count & 16) == 0 {
4263                                 assert!(reestablish_1 == second_reestablish_1);
4264                                 assert!(reestablish_2 == second_reestablish_2);
4265                         }
4266                         assert!(as_resp == second_as_resp);
4267                         assert!(bs_resp == second_bs_resp);
4268                 }
4269
4270                 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
4271         } else {
4272                 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
4273                 assert_eq!(events_4.len(), 2);
4274                 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
4275                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
4276                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4277                                 msg.clone()
4278                         },
4279                         _ => panic!("Unexpected event"),
4280                 })
4281         };
4282
4283         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
4284
4285         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4286         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4287         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4288         // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
4289         check_added_monitors!(nodes[1], 1);
4290
4291         if disconnect_count & !disconnect_flags > 2 {
4292                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4293
4294                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4295                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4296
4297                 assert!(as_resp.2.is_none());
4298                 assert!(bs_resp.2.is_none());
4299         }
4300
4301         let as_commitment_update;
4302         let bs_second_commitment_update;
4303
4304         macro_rules! handle_bs_raa { () => {
4305                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4306                 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4307                 assert!(as_commitment_update.update_add_htlcs.is_empty());
4308                 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
4309                 assert!(as_commitment_update.update_fail_htlcs.is_empty());
4310                 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
4311                 assert!(as_commitment_update.update_fee.is_none());
4312                 check_added_monitors!(nodes[0], 1);
4313         } }
4314
4315         macro_rules! handle_initial_raa { () => {
4316                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
4317                 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4318                 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
4319                 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
4320                 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
4321                 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
4322                 assert!(bs_second_commitment_update.update_fee.is_none());
4323                 check_added_monitors!(nodes[1], 1);
4324         } }
4325
4326         if (disconnect_count & 8) == 0 {
4327                 handle_bs_raa!();
4328
4329                 if disconnect_count & !disconnect_flags > 3 {
4330                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4331
4332                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
4333                         assert!(bs_resp.1.is_none());
4334
4335                         assert!(as_resp.2.unwrap() == as_commitment_update);
4336                         assert!(bs_resp.2.is_none());
4337
4338                         assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4339                 }
4340
4341                 handle_initial_raa!();
4342
4343                 if disconnect_count & !disconnect_flags > 4 {
4344                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4345
4346                         assert!(as_resp.1.is_none());
4347                         assert!(bs_resp.1.is_none());
4348
4349                         assert!(as_resp.2.unwrap() == as_commitment_update);
4350                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4351                 }
4352         } else {
4353                 handle_initial_raa!();
4354
4355                 if disconnect_count & !disconnect_flags > 3 {
4356                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4357
4358                         assert!(as_resp.1.is_none());
4359                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
4360
4361                         assert!(as_resp.2.is_none());
4362                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4363
4364                         assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
4365                 }
4366
4367                 handle_bs_raa!();
4368
4369                 if disconnect_count & !disconnect_flags > 4 {
4370                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
4371
4372                         assert!(as_resp.1.is_none());
4373                         assert!(bs_resp.1.is_none());
4374
4375                         assert!(as_resp.2.unwrap() == as_commitment_update);
4376                         assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
4377                 }
4378         }
4379
4380         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
4381         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4382         // No commitment_signed so get_event_msg's assert(len == 1) passes
4383         check_added_monitors!(nodes[0], 1);
4384
4385         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
4386         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4387         // No commitment_signed so get_event_msg's assert(len == 1) passes
4388         check_added_monitors!(nodes[1], 1);
4389
4390         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
4391         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4392         check_added_monitors!(nodes[1], 1);
4393
4394         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
4395         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4396         check_added_monitors!(nodes[0], 1);
4397
4398         expect_pending_htlcs_forwardable!(nodes[1]);
4399
4400         let events_5 = nodes[1].node.get_and_clear_pending_events();
4401         assert_eq!(events_5.len(), 1);
4402         match events_5[0] {
4403                 Event::PaymentReceived { ref payment_hash, amt } => {
4404                         assert_eq!(payment_hash_2, *payment_hash);
4405                         assert_eq!(amt, 1000000);
4406                 },
4407                 _ => panic!("Unexpected event"),
4408         }
4409
4410         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4411 }
4412
4413 #[test]
4414 fn test_monitor_temporary_update_fail_a() {
4415         do_test_monitor_temporary_update_fail(0);
4416         do_test_monitor_temporary_update_fail(1);
4417         do_test_monitor_temporary_update_fail(2);
4418         do_test_monitor_temporary_update_fail(3);
4419         do_test_monitor_temporary_update_fail(4);
4420         do_test_monitor_temporary_update_fail(5);
4421 }
4422
4423 #[test]
4424 fn test_monitor_temporary_update_fail_b() {
4425         do_test_monitor_temporary_update_fail(2 | 8);
4426         do_test_monitor_temporary_update_fail(3 | 8);
4427         do_test_monitor_temporary_update_fail(4 | 8);
4428         do_test_monitor_temporary_update_fail(5 | 8);
4429 }
4430
4431 #[test]
4432 fn test_monitor_temporary_update_fail_c() {
4433         do_test_monitor_temporary_update_fail(1 | 16);
4434         do_test_monitor_temporary_update_fail(2 | 16);
4435         do_test_monitor_temporary_update_fail(3 | 16);
4436         do_test_monitor_temporary_update_fail(2 | 8 | 16);
4437         do_test_monitor_temporary_update_fail(3 | 8 | 16);
4438 }
4439
4440 #[test]
4441 fn test_monitor_update_fail_cs() {
4442         // Tests handling of a monitor update failure when processing an incoming commitment_signed
4443         let mut nodes = create_network(2);
4444         create_announced_chan_between_nodes(&nodes, 0, 1);
4445
4446         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4447         let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4448         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4449         check_added_monitors!(nodes[0], 1);
4450
4451         let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4452         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4453
4454         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4455         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() {
4456                 assert_eq!(err, "Failed to update ChannelMonitor");
4457         } else { panic!(); }
4458         check_added_monitors!(nodes[1], 1);
4459         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4460
4461         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4462         nodes[1].node.test_restore_channel_monitor();
4463         check_added_monitors!(nodes[1], 1);
4464         let responses = nodes[1].node.get_and_clear_pending_msg_events();
4465         assert_eq!(responses.len(), 2);
4466
4467         match responses[0] {
4468                 MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
4469                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4470                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg).unwrap();
4471                         check_added_monitors!(nodes[0], 1);
4472                 },
4473                 _ => panic!("Unexpected event"),
4474         }
4475         match responses[1] {
4476                 MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
4477                         assert!(updates.update_add_htlcs.is_empty());
4478                         assert!(updates.update_fulfill_htlcs.is_empty());
4479                         assert!(updates.update_fail_htlcs.is_empty());
4480                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4481                         assert!(updates.update_fee.is_none());
4482                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4483
4484                         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4485                         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() {
4486                                 assert_eq!(err, "Failed to update ChannelMonitor");
4487                         } else { panic!(); }
4488                         check_added_monitors!(nodes[0], 1);
4489                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4490                 },
4491                 _ => panic!("Unexpected event"),
4492         }
4493
4494         *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
4495         nodes[0].node.test_restore_channel_monitor();
4496         check_added_monitors!(nodes[0], 1);
4497
4498         let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4499         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa).unwrap();
4500         check_added_monitors!(nodes[1], 1);
4501
4502         expect_pending_htlcs_forwardable!(nodes[1]);
4503
4504         let events = nodes[1].node.get_and_clear_pending_events();
4505         assert_eq!(events.len(), 1);
4506         match events[0] {
4507                 Event::PaymentReceived { payment_hash, amt } => {
4508                         assert_eq!(payment_hash, our_payment_hash);
4509                         assert_eq!(amt, 1000000);
4510                 },
4511                 _ => panic!("Unexpected event"),
4512         };
4513
4514         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
4515 }
4516
4517 fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
4518         // Tests handling of a monitor update failure when processing an incoming RAA
4519         let mut nodes = create_network(3);
4520         create_announced_chan_between_nodes(&nodes, 0, 1);
4521         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4522
4523         // Rebalance a bit so that we can send backwards from 2 to 1.
4524         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
4525
4526         // Route a first payment that we'll fail backwards
4527         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4528
4529         // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
4530         assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, 0));
4531         expect_pending_htlcs_forwardable!(nodes[2]);
4532         check_added_monitors!(nodes[2], 1);
4533
4534         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4535         assert!(updates.update_add_htlcs.is_empty());
4536         assert!(updates.update_fulfill_htlcs.is_empty());
4537         assert_eq!(updates.update_fail_htlcs.len(), 1);
4538         assert!(updates.update_fail_malformed_htlcs.is_empty());
4539         assert!(updates.update_fee.is_none());
4540         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4541
4542         let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
4543         check_added_monitors!(nodes[0], 0);
4544
4545         // While the second channel is AwaitingRAA, forward a second payment to get it into the
4546         // holding cell.
4547         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
4548         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4549         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
4550         check_added_monitors!(nodes[0], 1);
4551
4552         let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4553         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4554         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
4555
4556         expect_pending_htlcs_forwardable!(nodes[1]);
4557         check_added_monitors!(nodes[1], 0);
4558         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4559
4560         // Now fail monitor updating.
4561         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4562         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() {
4563                 assert_eq!(err, "Failed to update ChannelMonitor");
4564         } else { panic!(); }
4565         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4567         check_added_monitors!(nodes[1], 1);
4568
4569         // Attempt to forward a third payment but fail due to the second channel being unavailable
4570         // for forwarding.
4571
4572         let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
4573         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4574         nodes[0].node.send_payment(route, payment_hash_3).unwrap();
4575         check_added_monitors!(nodes[0], 1);
4576
4577         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(()); // We succeed in updating the monitor for the first channel
4578         send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4579         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4580         commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
4581         check_added_monitors!(nodes[1], 0);
4582
4583         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4584         assert_eq!(events_2.len(), 1);
4585         match events_2.remove(0) {
4586                 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4587                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
4588                         assert!(updates.update_fulfill_htlcs.is_empty());
4589                         assert_eq!(updates.update_fail_htlcs.len(), 1);
4590                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4591                         assert!(updates.update_add_htlcs.is_empty());
4592                         assert!(updates.update_fee.is_none());
4593
4594                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4595                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
4596
4597                         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4598                         assert_eq!(msg_events.len(), 1);
4599                         match msg_events[0] {
4600                                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
4601                                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
4602                                         assert_eq!(msg.contents.flags & 2, 2); // temp disabled
4603                                 },
4604                                 _ => panic!("Unexpected event"),
4605                         }
4606
4607                         let events = nodes[0].node.get_and_clear_pending_events();
4608                         assert_eq!(events.len(), 1);
4609                         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events[0] {
4610                                 assert_eq!(payment_hash, payment_hash_3);
4611                                 assert!(!rejected_by_dest);
4612                         } else { panic!("Unexpected event!"); }
4613                 },
4614                 _ => panic!("Unexpected event type!"),
4615         };
4616
4617         let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
4618                 // Try to route another payment backwards from 2 to make sure 1 holds off on responding
4619                 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
4620                 let route = nodes[2].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4621                 nodes[2].node.send_payment(route, payment_hash_4).unwrap();
4622                 check_added_monitors!(nodes[2], 1);
4623
4624                 send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
4625                 nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4626                 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) {
4627                         assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
4628                 } else { panic!(); }
4629                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4630                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4631                 (Some(payment_preimage_4), Some(payment_hash_4))
4632         } else { (None, None) };
4633
4634         // Restore monitor updating, ensuring we immediately get a fail-back update and a
4635         // update_add update.
4636         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4637         nodes[1].node.test_restore_channel_monitor();
4638         check_added_monitors!(nodes[1], 1);
4639         expect_pending_htlcs_forwardable!(nodes[1]);
4640         check_added_monitors!(nodes[1], 1);
4641
4642         let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
4643         if test_ignore_second_cs {
4644                 assert_eq!(events_3.len(), 3);
4645         } else {
4646                 assert_eq!(events_3.len(), 2);
4647         }
4648
4649         // Note that the ordering of the events for different nodes is non-prescriptive, though the
4650         // ordering of the two events that both go to nodes[2] have to stay in the same order.
4651         let messages_a = match events_3.pop().unwrap() {
4652                 MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
4653                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
4654                         assert!(updates.update_fulfill_htlcs.is_empty());
4655                         assert_eq!(updates.update_fail_htlcs.len(), 1);
4656                         assert!(updates.update_fail_malformed_htlcs.is_empty());
4657                         assert!(updates.update_add_htlcs.is_empty());
4658                         assert!(updates.update_fee.is_none());
4659                         (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
4660                 },
4661                 _ => panic!("Unexpected event type!"),
4662         };
4663         let raa = if test_ignore_second_cs {
4664                 match events_3.remove(1) {
4665                         MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
4666                                 assert_eq!(node_id, nodes[2].node.get_our_node_id());
4667                                 Some(msg.clone())
4668                         },
4669                         _ => panic!("Unexpected event"),
4670                 }
4671         } else { None };
4672         let send_event_b = SendEvent::from_event(events_3.remove(0));
4673         assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
4674
4675         // Now deliver the new messages...
4676
4677         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0).unwrap();
4678         commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
4679         let events_4 = nodes[0].node.get_and_clear_pending_events();
4680         assert_eq!(events_4.len(), 1);
4681         if let Event::PaymentFailed { payment_hash, rejected_by_dest, .. } = events_4[0] {
4682                 assert_eq!(payment_hash, payment_hash_1);
4683                 assert!(rejected_by_dest);
4684         } else { panic!("Unexpected event!"); }
4685
4686         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]).unwrap();
4687         if test_ignore_second_cs {
4688                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg).unwrap();
4689                 check_added_monitors!(nodes[2], 1);
4690                 let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4691                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap()).unwrap();
4692                 check_added_monitors!(nodes[2], 1);
4693                 let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4694                 assert!(bs_cs.update_add_htlcs.is_empty());
4695                 assert!(bs_cs.update_fail_htlcs.is_empty());
4696                 assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
4697                 assert!(bs_cs.update_fulfill_htlcs.is_empty());
4698                 assert!(bs_cs.update_fee.is_none());
4699
4700                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4701                 check_added_monitors!(nodes[1], 1);
4702                 let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4703                 assert!(as_cs.update_add_htlcs.is_empty());
4704                 assert!(as_cs.update_fail_htlcs.is_empty());
4705                 assert!(as_cs.update_fail_malformed_htlcs.is_empty());
4706                 assert!(as_cs.update_fulfill_htlcs.is_empty());
4707                 assert!(as_cs.update_fee.is_none());
4708
4709                 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
4710                 check_added_monitors!(nodes[1], 1);
4711                 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
4712
4713                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
4714                 check_added_monitors!(nodes[2], 1);
4715                 let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4716
4717                 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
4718                 check_added_monitors!(nodes[2], 1);
4719                 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
4720
4721                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa).unwrap();
4722                 check_added_monitors!(nodes[1], 1);
4723                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4724         } else {
4725                 commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
4726         }
4727
4728         expect_pending_htlcs_forwardable!(nodes[2]);
4729
4730         let events_6 = nodes[2].node.get_and_clear_pending_events();
4731         assert_eq!(events_6.len(), 1);
4732         match events_6[0] {
4733                 Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
4734                 _ => panic!("Unexpected event"),
4735         };
4736
4737         if test_ignore_second_cs {
4738                 expect_pending_htlcs_forwardable!(nodes[1]);
4739                 check_added_monitors!(nodes[1], 1);
4740
4741                 send_event = SendEvent::from_node(&nodes[1]);
4742                 assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
4743                 assert_eq!(send_event.msgs.len(), 1);
4744                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
4745                 commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
4746
4747                 expect_pending_htlcs_forwardable!(nodes[0]);
4748
4749                 let events_9 = nodes[0].node.get_and_clear_pending_events();
4750                 assert_eq!(events_9.len(), 1);
4751                 match events_9[0] {
4752                         Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
4753                         _ => panic!("Unexpected event"),
4754                 };
4755                 claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
4756         }
4757
4758         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
4759 }
4760
4761 #[test]
4762 fn test_monitor_update_fail_raa() {
4763         do_test_monitor_update_fail_raa(false);
4764         do_test_monitor_update_fail_raa(true);
4765 }
4766
4767 #[test]
4768 fn test_monitor_update_fail_reestablish() {
4769         // Simple test for message retransmission after monitor update failure on
4770         // channel_reestablish generating a monitor update (which comes from freeing holding cell
4771         // HTLCs).
4772         let mut nodes = create_network(3);
4773         create_announced_chan_between_nodes(&nodes, 0, 1);
4774         create_announced_chan_between_nodes(&nodes, 1, 2);
4775
4776         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
4777
4778         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4779         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4780
4781         assert!(nodes[2].node.claim_funds(our_payment_preimage));
4782         check_added_monitors!(nodes[2], 1);
4783         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4784         assert!(updates.update_add_htlcs.is_empty());
4785         assert!(updates.update_fail_htlcs.is_empty());
4786         assert!(updates.update_fail_malformed_htlcs.is_empty());
4787         assert!(updates.update_fee.is_none());
4788         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4789         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4790         check_added_monitors!(nodes[1], 1);
4791         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4792         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4793
4794         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
4795         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4796         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4797
4798         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4799         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4800
4801         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4802
4803         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() {
4804                 assert_eq!(err, "Failed to update ChannelMonitor");
4805         } else { panic!(); }
4806         check_added_monitors!(nodes[1], 1);
4807
4808         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4809         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4810
4811         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4812         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4813
4814         assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
4815         assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
4816
4817         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
4818
4819         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap();
4820         check_added_monitors!(nodes[1], 0);
4821         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4822
4823         *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
4824         nodes[1].node.test_restore_channel_monitor();
4825         check_added_monitors!(nodes[1], 1);
4826
4827         updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4828         assert!(updates.update_add_htlcs.is_empty());
4829         assert!(updates.update_fail_htlcs.is_empty());
4830         assert!(updates.update_fail_malformed_htlcs.is_empty());
4831         assert!(updates.update_fee.is_none());
4832         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4833         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4834         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
4835
4836         let events = nodes[0].node.get_and_clear_pending_events();
4837         assert_eq!(events.len(), 1);
4838         match events[0] {
4839                 Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
4840                 _ => panic!("Unexpected event"),
4841         }
4842 }
4843
4844 #[test]
4845 fn test_invalid_channel_announcement() {
4846         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4847         let secp_ctx = Secp256k1::new();
4848         let nodes = create_network(2);
4849
4850         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
4851
4852         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4853         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4854         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4855         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4856
4857         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 } );
4858
4859         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
4860         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
4861
4862         let as_network_key = nodes[0].node.get_our_node_id();
4863         let bs_network_key = nodes[1].node.get_our_node_id();
4864
4865         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4866
4867         let mut chan_announcement;
4868
4869         macro_rules! dummy_unsigned_msg {
4870                 () => {
4871                         msgs::UnsignedChannelAnnouncement {
4872                                 features: msgs::GlobalFeatures::new(),
4873                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4874                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4875                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4876                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4877                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4878                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4879                                 excess_data: Vec::new(),
4880                         };
4881                 }
4882         }
4883
4884         macro_rules! sign_msg {
4885                 ($unsigned_msg: expr) => {
4886                         let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
4887                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
4888                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
4889                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4890                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4891                         chan_announcement = msgs::ChannelAnnouncement {
4892                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4893                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4894                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4895                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4896                                 contents: $unsigned_msg
4897                         }
4898                 }
4899         }
4900
4901         let unsigned_msg = dummy_unsigned_msg!();
4902         sign_msg!(unsigned_msg);
4903         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
4904         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 } );
4905
4906         // Configured with Network::Testnet
4907         let mut unsigned_msg = dummy_unsigned_msg!();
4908         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4909         sign_msg!(unsigned_msg);
4910         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
4911
4912         let mut unsigned_msg = dummy_unsigned_msg!();
4913         unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
4914         sign_msg!(unsigned_msg);
4915         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
4916 }
4917
4918 struct VecWriter(Vec<u8>);
4919 impl Writer for VecWriter {
4920         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
4921                 self.0.extend_from_slice(buf);
4922                 Ok(())
4923         }
4924         fn size_hint(&mut self, size: usize) {
4925                 self.0.reserve_exact(size);
4926         }
4927 }
4928
4929 #[test]
4930 fn test_no_txn_manager_serialize_deserialize() {
4931         let mut nodes = create_network(2);
4932
4933         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
4934
4935         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4936
4937         let nodes_0_serialized = nodes[0].node.encode();
4938         let mut chan_0_monitor_serialized = VecWriter(Vec::new());
4939         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4940
4941         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())));
4942         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4943         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
4944         assert!(chan_0_monitor_read.is_empty());
4945
4946         let mut nodes_0_read = &nodes_0_serialized[..];
4947         let config = UserConfig::new();
4948         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
4949         let (_, nodes_0_deserialized) = {
4950                 let mut channel_monitors = HashMap::new();
4951                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
4952                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4953                         default_config: config,
4954                         keys_manager,
4955                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
4956                         monitor: nodes[0].chan_monitor.clone(),
4957                         chain_monitor: nodes[0].chain_monitor.clone(),
4958                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4959                         logger: Arc::new(test_utils::TestLogger::new()),
4960                         channel_monitors: &channel_monitors,
4961                 }).unwrap()
4962         };
4963         assert!(nodes_0_read.is_empty());
4964
4965         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
4966         nodes[0].node = Arc::new(nodes_0_deserialized);
4967         let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
4968         nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
4969         assert_eq!(nodes[0].node.list_channels().len(), 1);
4970         check_added_monitors!(nodes[0], 1);
4971
4972         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4973         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4974         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4975         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4976
4977         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
4978         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4979         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
4980         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4981
4982         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4983         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4984         for node in nodes.iter() {
4985                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
4986                 node.router.handle_channel_update(&as_update).unwrap();
4987                 node.router.handle_channel_update(&bs_update).unwrap();
4988         }
4989
4990         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4991 }
4992
4993 #[test]
4994 fn test_simple_manager_serialize_deserialize() {
4995         let mut nodes = create_network(2);
4996         create_announced_chan_between_nodes(&nodes, 0, 1);
4997
4998         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4999         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5000
5001         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5002
5003         let nodes_0_serialized = nodes[0].node.encode();
5004         let mut chan_0_monitor_serialized = VecWriter(Vec::new());
5005         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
5006
5007         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())));
5008         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
5009         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
5010         assert!(chan_0_monitor_read.is_empty());
5011
5012         let mut nodes_0_read = &nodes_0_serialized[..];
5013         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5014         let (_, nodes_0_deserialized) = {
5015                 let mut channel_monitors = HashMap::new();
5016                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
5017                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5018                         default_config: UserConfig::new(),
5019                         keys_manager,
5020                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5021                         monitor: nodes[0].chan_monitor.clone(),
5022                         chain_monitor: nodes[0].chain_monitor.clone(),
5023                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5024                         logger: Arc::new(test_utils::TestLogger::new()),
5025                         channel_monitors: &channel_monitors,
5026                 }).unwrap()
5027         };
5028         assert!(nodes_0_read.is_empty());
5029
5030         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
5031         nodes[0].node = Arc::new(nodes_0_deserialized);
5032         check_added_monitors!(nodes[0], 1);
5033
5034         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5035
5036         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
5037         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
5038 }
5039
5040 #[test]
5041 fn test_manager_serialize_deserialize_inconsistent_monitor() {
5042         // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
5043         let mut nodes = create_network(4);
5044         create_announced_chan_between_nodes(&nodes, 0, 1);
5045         create_announced_chan_between_nodes(&nodes, 2, 0);
5046         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
5047
5048         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
5049
5050         // Serialize the ChannelManager here, but the monitor we keep up-to-date
5051         let nodes_0_serialized = nodes[0].node.encode();
5052
5053         route_payment(&nodes[0], &[&nodes[3]], 1000000);
5054         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5055         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5056         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5057
5058         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
5059         // nodes[3])
5060         let mut node_0_monitors_serialized = Vec::new();
5061         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
5062                 let mut writer = VecWriter(Vec::new());
5063                 monitor.1.write_for_disk(&mut writer).unwrap();
5064                 node_0_monitors_serialized.push(writer.0);
5065         }
5066
5067         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())));
5068         let mut node_0_monitors = Vec::new();
5069         for serialized in node_0_monitors_serialized.iter() {
5070                 let mut read = &serialized[..];
5071                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
5072                 assert!(read.is_empty());
5073                 node_0_monitors.push(monitor);
5074         }
5075
5076         let mut nodes_0_read = &nodes_0_serialized[..];
5077         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
5078         let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
5079                 default_config: UserConfig::new(),
5080                 keys_manager,
5081                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
5082                 monitor: nodes[0].chan_monitor.clone(),
5083                 chain_monitor: nodes[0].chain_monitor.clone(),
5084                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
5085                 logger: Arc::new(test_utils::TestLogger::new()),
5086                 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
5087         }).unwrap();
5088         assert!(nodes_0_read.is_empty());
5089
5090         { // Channel close should result in a commitment tx and an HTLC tx
5091                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5092                 assert_eq!(txn.len(), 2);
5093                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
5094                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
5095         }
5096
5097         for monitor in node_0_monitors.drain(..) {
5098                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
5099                 check_added_monitors!(nodes[0], 1);
5100         }
5101         nodes[0].node = Arc::new(nodes_0_deserialized);
5102
5103         // nodes[1] and nodes[2] have no lost state with nodes[0]...
5104         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5105         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5106         //... and we can even still claim the payment!
5107         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
5108
5109         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
5110         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5111         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
5112         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) {
5113                 assert_eq!(msg.channel_id, channel_id);
5114         } else { panic!("Unexpected result"); }
5115 }
5116
5117 macro_rules! check_spendable_outputs {
5118         ($node: expr, $der_idx: expr) => {
5119                 {
5120                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
5121                         let mut txn = Vec::new();
5122                         for event in events {
5123                                 match event {
5124                                         Event::SpendableOutputs { ref outputs } => {
5125                                                 for outp in outputs {
5126                                                         match *outp {
5127                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
5128                                                                         let input = TxIn {
5129                                                                                 previous_output: outpoint.clone(),
5130                                                                                 script_sig: Script::new(),
5131                                                                                 sequence: 0,
5132                                                                                 witness: Vec::new(),
5133                                                                         };
5134                                                                         let outp = TxOut {
5135                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5136                                                                                 value: output.value,
5137                                                                         };
5138                                                                         let mut spend_tx = Transaction {
5139                                                                                 version: 2,
5140                                                                                 lock_time: 0,
5141                                                                                 input: vec![input],
5142                                                                                 output: vec![outp],
5143                                                                         };
5144                                                                         let secp_ctx = Secp256k1::new();
5145                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
5146                                                                         let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
5147                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5148                                                                         let remotesig = secp_ctx.sign(&sighash, key);
5149                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
5150                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5151                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
5152                                                                         txn.push(spend_tx);
5153                                                                 },
5154                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
5155                                                                         let input = TxIn {
5156                                                                                 previous_output: outpoint.clone(),
5157                                                                                 script_sig: Script::new(),
5158                                                                                 sequence: *to_self_delay as u32,
5159                                                                                 witness: Vec::new(),
5160                                                                         };
5161                                                                         let outp = TxOut {
5162                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5163                                                                                 value: output.value,
5164                                                                         };
5165                                                                         let mut spend_tx = Transaction {
5166                                                                                 version: 2,
5167                                                                                 lock_time: 0,
5168                                                                                 input: vec![input],
5169                                                                                 output: vec![outp],
5170                                                                         };
5171                                                                         let secp_ctx = Secp256k1::new();
5172                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
5173                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
5174                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
5175                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5176                                                                         spend_tx.input[0].witness.push(vec!(0));
5177                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
5178                                                                         txn.push(spend_tx);
5179                                                                 },
5180                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
5181                                                                         let secp_ctx = Secp256k1::new();
5182                                                                         let input = TxIn {
5183                                                                                 previous_output: outpoint.clone(),
5184                                                                                 script_sig: Script::new(),
5185                                                                                 sequence: 0,
5186                                                                                 witness: Vec::new(),
5187                                                                         };
5188                                                                         let outp = TxOut {
5189                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
5190                                                                                 value: output.value,
5191                                                                         };
5192                                                                         let mut spend_tx = Transaction {
5193                                                                                 version: 2,
5194                                                                                 lock_time: 0,
5195                                                                                 input: vec![input],
5196                                                                                 output: vec![outp.clone()],
5197                                                                         };
5198                                                                         let secret = {
5199                                                                                 match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
5200                                                                                         Ok(master_key) => {
5201                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
5202                                                                                                         Ok(key) => key,
5203                                                                                                         Err(_) => panic!("Your RNG is busted"),
5204                                                                                                 }
5205                                                                                         }
5206                                                                                         Err(_) => panic!("Your rng is busted"),
5207                                                                                 }
5208                                                                         };
5209                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
5210                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
5211                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
5212                                                                         let sig = secp_ctx.sign(&sighash, &secret.secret_key);
5213                                                                         spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
5214                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
5215                                                                         spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
5216                                                                         txn.push(spend_tx);
5217                                                                 },
5218                                                         }
5219                                                 }
5220                                         },
5221                                         _ => panic!("Unexpected event"),
5222                                 };
5223                         }
5224                         txn
5225                 }
5226         }
5227 }
5228
5229 #[test]
5230 fn test_claim_sizeable_push_msat() {
5231         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
5232         let nodes = create_network(2);
5233
5234         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5235         nodes[1].node.force_close_channel(&chan.2);
5236         check_closed_broadcast!(nodes[1]);
5237         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5238         assert_eq!(node_txn.len(), 1);
5239         check_spends!(node_txn[0], chan.3.clone());
5240         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
5241
5242         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5243         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5244         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5245         assert_eq!(spend_txn.len(), 1);
5246         check_spends!(spend_txn[0], node_txn[0].clone());
5247 }
5248
5249 #[test]
5250 fn test_claim_on_remote_sizeable_push_msat() {
5251         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5252         // to_remote output is encumbered by a P2WPKH
5253
5254         let nodes = create_network(2);
5255
5256         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
5257         nodes[0].node.force_close_channel(&chan.2);
5258         check_closed_broadcast!(nodes[0]);
5259
5260         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5261         assert_eq!(node_txn.len(), 1);
5262         check_spends!(node_txn[0], chan.3.clone());
5263         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
5264
5265         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5266         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
5267         check_closed_broadcast!(nodes[1]);
5268         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5269         assert_eq!(spend_txn.len(), 2);
5270         assert_eq!(spend_txn[0], spend_txn[1]);
5271         check_spends!(spend_txn[0], node_txn[0].clone());
5272 }
5273
5274 #[test]
5275 fn test_claim_on_remote_revoked_sizeable_push_msat() {
5276         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
5277         // to_remote output is encumbered by a P2WPKH
5278
5279         let nodes = create_network(2);
5280
5281         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
5282         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5283         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5284         assert_eq!(revoked_local_txn[0].input.len(), 1);
5285         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
5286
5287         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5288         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5289         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5290         check_closed_broadcast!(nodes[1]);
5291
5292         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5293         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5294         assert_eq!(spend_txn.len(), 4);
5295         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
5296         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
5297         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
5298         check_spends!(spend_txn[1], node_txn[0].clone());
5299 }
5300
5301 #[test]
5302 fn test_static_spendable_outputs_preimage_tx() {
5303         let nodes = create_network(2);
5304
5305         // Create some initial channels
5306         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5307
5308         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5309
5310         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5311         assert_eq!(commitment_tx[0].input.len(), 1);
5312         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5313
5314         // Settle A's commitment tx on B's chain
5315         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5316         assert!(nodes[1].node.claim_funds(payment_preimage));
5317         check_added_monitors!(nodes[1], 1);
5318         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
5319         let events = nodes[1].node.get_and_clear_pending_msg_events();
5320         match events[0] {
5321                 MessageSendEvent::UpdateHTLCs { .. } => {},
5322                 _ => panic!("Unexpected event"),
5323         }
5324         match events[1] {
5325                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5326                 _ => panic!("Unexepected event"),
5327         }
5328
5329         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
5330         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
5331         check_spends!(node_txn[0], commitment_tx[0].clone());
5332         assert_eq!(node_txn[0], node_txn[2]);
5333         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5334         check_spends!(node_txn[1], chan_1.3.clone());
5335
5336         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
5337         assert_eq!(spend_txn.len(), 2);
5338         assert_eq!(spend_txn[0], spend_txn[1]);
5339         check_spends!(spend_txn[0], node_txn[0].clone());
5340 }
5341
5342 #[test]
5343 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5344         let nodes = create_network(2);
5345
5346         // Create some initial channels
5347         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5348
5349         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5350         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5351         assert_eq!(revoked_local_txn[0].input.len(), 1);
5352         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5353
5354         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5355
5356         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5357         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5358         check_closed_broadcast!(nodes[1]);
5359
5360         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5361         assert_eq!(node_txn.len(), 3);
5362         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
5363         assert_eq!(node_txn[0].input.len(), 2);
5364         check_spends!(node_txn[0], revoked_local_txn[0].clone());
5365
5366         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5367         assert_eq!(spend_txn.len(), 2);
5368         assert_eq!(spend_txn[0], spend_txn[1]);
5369         check_spends!(spend_txn[0], node_txn[0].clone());
5370 }
5371
5372 #[test]
5373 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5374         let nodes = create_network(2);
5375
5376         // Create some initial channels
5377         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5378
5379         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5380         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5381         assert_eq!(revoked_local_txn[0].input.len(), 1);
5382         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5383
5384         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5385
5386         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5387         // A will generate HTLC-Timeout from revoked commitment tx
5388         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5389         check_closed_broadcast!(nodes[0]);
5390
5391         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5392         assert_eq!(revoked_htlc_txn.len(), 3);
5393         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5394         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5395         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5396         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5397         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
5398
5399         // B will generate justice tx from A's revoked commitment/HTLC tx
5400         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5401         check_closed_broadcast!(nodes[1]);
5402
5403         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5404         assert_eq!(node_txn.len(), 4);
5405         assert_eq!(node_txn[3].input.len(), 1);
5406         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5407
5408         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5409         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5410         assert_eq!(spend_txn.len(), 3);
5411         assert_eq!(spend_txn[0], spend_txn[1]);
5412         check_spends!(spend_txn[0], node_txn[0].clone());
5413         check_spends!(spend_txn[2], node_txn[3].clone());
5414 }
5415
5416 #[test]
5417 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5418         let nodes = create_network(2);
5419
5420         // Create some initial channels
5421         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5422
5423         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5424         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5425         assert_eq!(revoked_local_txn[0].input.len(), 1);
5426         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5427
5428         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5429
5430         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5431         // B will generate HTLC-Success from revoked commitment tx
5432         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5433         check_closed_broadcast!(nodes[1]);
5434         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5435
5436         assert_eq!(revoked_htlc_txn.len(), 3);
5437         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
5438         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5439         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5440         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
5441
5442         // A will generate justice tx from B's revoked commitment/HTLC tx
5443         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5444         check_closed_broadcast!(nodes[0]);
5445
5446         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5447         assert_eq!(node_txn.len(), 4);
5448         assert_eq!(node_txn[3].input.len(), 1);
5449         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
5450
5451         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5452         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5453         assert_eq!(spend_txn.len(), 5);
5454         assert_eq!(spend_txn[0], spend_txn[2]);
5455         assert_eq!(spend_txn[1], spend_txn[3]);
5456         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
5457         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
5458         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
5459 }
5460
5461 #[test]
5462 fn test_onchain_to_onchain_claim() {
5463         // Test that in case of channel closure, we detect the state of output thanks to
5464         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5465         // First, have C claim an HTLC against its own latest commitment transaction.
5466         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5467         // channel.
5468         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5469         // gets broadcast.
5470
5471         let nodes = create_network(3);
5472
5473         // Create some initial channels
5474         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5475         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5476
5477         // Rebalance the network a bit by relaying one payment through all the channels ...
5478         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5479         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5480
5481         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5482         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5483         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5484         check_spends!(commitment_tx[0], chan_2.3.clone());
5485         nodes[2].node.claim_funds(payment_preimage);
5486         check_added_monitors!(nodes[2], 1);
5487         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5488         assert!(updates.update_add_htlcs.is_empty());
5489         assert!(updates.update_fail_htlcs.is_empty());
5490         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5491         assert!(updates.update_fail_malformed_htlcs.is_empty());
5492
5493         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5494         check_closed_broadcast!(nodes[2]);
5495
5496         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5497         assert_eq!(c_txn.len(), 3);
5498         assert_eq!(c_txn[0], c_txn[2]);
5499         assert_eq!(commitment_tx[0], c_txn[1]);
5500         check_spends!(c_txn[1], chan_2.3.clone());
5501         check_spends!(c_txn[2], c_txn[1].clone());
5502         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5503         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5504         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5505         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5506
5507         // 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
5508         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5509         {
5510                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5511                 assert_eq!(b_txn.len(), 4);
5512                 assert_eq!(b_txn[0], b_txn[3]);
5513                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5514                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5515                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5516                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5517                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5518                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5519                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5520                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5521                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5522                 b_txn.clear();
5523         }
5524         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5525         check_added_monitors!(nodes[1], 1);
5526         match msg_events[0] {
5527                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5528                 _ => panic!("Unexpected event"),
5529         }
5530         match msg_events[1] {
5531                 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, .. } } => {
5532                         assert!(update_add_htlcs.is_empty());
5533                         assert!(update_fail_htlcs.is_empty());
5534                         assert_eq!(update_fulfill_htlcs.len(), 1);
5535                         assert!(update_fail_malformed_htlcs.is_empty());
5536                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5537                 },
5538                 _ => panic!("Unexpected event"),
5539         };
5540         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5541         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5542         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5543         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5544         assert_eq!(b_txn.len(), 3);
5545         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
5546         assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
5547         check_spends!(b_txn[0], commitment_tx[0].clone());
5548         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5549         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5550         assert_eq!(b_txn[2].lock_time, 0); // Success tx
5551
5552         check_closed_broadcast!(nodes[1]);
5553 }
5554
5555 #[test]
5556 fn test_duplicate_payment_hash_one_failure_one_success() {
5557         // Topology : A --> B --> C
5558         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5559         let mut nodes = create_network(3);
5560
5561         create_announced_chan_between_nodes(&nodes, 0, 1);
5562         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5563
5564         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5565         *nodes[0].network_payment_count.borrow_mut() -= 1;
5566         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5567
5568         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
5569         assert_eq!(commitment_txn[0].input.len(), 1);
5570         check_spends!(commitment_txn[0], chan_2.3.clone());
5571
5572         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5573         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5574         check_closed_broadcast!(nodes[1]);
5575
5576         let htlc_timeout_tx;
5577         { // Extract one of the two HTLC-Timeout transaction
5578                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5579                 assert_eq!(node_txn.len(), 7);
5580                 assert_eq!(node_txn[0], node_txn[5]);
5581                 assert_eq!(node_txn[1], node_txn[6]);
5582                 check_spends!(node_txn[0], commitment_txn[0].clone());
5583                 assert_eq!(node_txn[0].input.len(), 1);
5584                 check_spends!(node_txn[1], commitment_txn[0].clone());
5585                 assert_eq!(node_txn[1].input.len(), 1);
5586                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5587                 check_spends!(node_txn[2], chan_2.3.clone());
5588                 check_spends!(node_txn[3], node_txn[2].clone());
5589                 check_spends!(node_txn[4], node_txn[2].clone());
5590                 htlc_timeout_tx = node_txn[1].clone();
5591         }
5592
5593         nodes[2].node.claim_funds(our_payment_preimage);
5594         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5595         check_added_monitors!(nodes[2], 2);
5596         let events = nodes[2].node.get_and_clear_pending_msg_events();
5597         match events[0] {
5598                 MessageSendEvent::UpdateHTLCs { .. } => {},
5599                 _ => panic!("Unexpected event"),
5600         }
5601         match events[1] {
5602                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5603                 _ => panic!("Unexepected event"),
5604         }
5605         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5606         assert_eq!(htlc_success_txn.len(), 5);
5607         check_spends!(htlc_success_txn[2], chan_2.3.clone());
5608         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5609         assert_eq!(htlc_success_txn[0].input.len(), 1);
5610         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5611         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5612         assert_eq!(htlc_success_txn[1].input.len(), 1);
5613         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5614         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5615         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
5616         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
5617
5618         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5619         expect_pending_htlcs_forwardable!(nodes[1]);
5620         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5621         assert!(htlc_updates.update_add_htlcs.is_empty());
5622         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5623         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5624         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5625         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5626         check_added_monitors!(nodes[1], 1);
5627
5628         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
5629         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5630         {
5631                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5632                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5633                 assert_eq!(events.len(), 1);
5634                 match events[0] {
5635                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5636                         },
5637                         _ => { panic!("Unexpected event"); }
5638                 }
5639         }
5640         let events = nodes[0].node.get_and_clear_pending_events();
5641         match events[0] {
5642                 Event::PaymentFailed { ref payment_hash, .. } => {
5643                         assert_eq!(*payment_hash, duplicate_payment_hash);
5644                 }
5645                 _ => panic!("Unexpected event"),
5646         }
5647
5648         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5649         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5650         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5651         assert!(updates.update_add_htlcs.is_empty());
5652         assert!(updates.update_fail_htlcs.is_empty());
5653         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5654         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5655         assert!(updates.update_fail_malformed_htlcs.is_empty());
5656         check_added_monitors!(nodes[1], 1);
5657
5658         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
5659         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5660
5661         let events = nodes[0].node.get_and_clear_pending_events();
5662         match events[0] {
5663                 Event::PaymentSent { ref payment_preimage } => {
5664                         assert_eq!(*payment_preimage, our_payment_preimage);
5665                 }
5666                 _ => panic!("Unexpected event"),
5667         }
5668 }
5669
5670 #[test]
5671 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5672         let nodes = create_network(2);
5673
5674         // Create some initial channels
5675         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5676
5677         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5678         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5679         assert_eq!(local_txn[0].input.len(), 1);
5680         check_spends!(local_txn[0], chan_1.3.clone());
5681
5682         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5683         nodes[1].node.claim_funds(payment_preimage);
5684         check_added_monitors!(nodes[1], 1);
5685         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5686         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5687         let events = nodes[1].node.get_and_clear_pending_msg_events();
5688         match events[0] {
5689                 MessageSendEvent::UpdateHTLCs { .. } => {},
5690                 _ => panic!("Unexpected event"),
5691         }
5692         match events[1] {
5693                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5694                 _ => panic!("Unexepected event"),
5695         }
5696         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5697         assert_eq!(node_txn[0].input.len(), 1);
5698         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5699         check_spends!(node_txn[0], local_txn[0].clone());
5700
5701         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5702         let spend_txn = check_spendable_outputs!(nodes[1], 1);
5703         assert_eq!(spend_txn.len(), 2);
5704         check_spends!(spend_txn[0], node_txn[0].clone());
5705         check_spends!(spend_txn[1], node_txn[2].clone());
5706 }
5707
5708 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5709         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5710         // unrevoked commitment transaction.
5711         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5712         // a remote RAA before they could be failed backwards (and combinations thereof).
5713         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5714         // use the same payment hashes.
5715         // Thus, we use a six-node network:
5716         //
5717         // A \         / E
5718         //    - C - D -
5719         // B /         \ F
5720         // And test where C fails back to A/B when D announces its latest commitment transaction
5721         let nodes = create_network(6);
5722
5723         create_announced_chan_between_nodes(&nodes, 0, 2);
5724         create_announced_chan_between_nodes(&nodes, 1, 2);
5725         let chan = create_announced_chan_between_nodes(&nodes, 2, 3);
5726         create_announced_chan_between_nodes(&nodes, 3, 4);
5727         create_announced_chan_between_nodes(&nodes, 3, 5);
5728
5729         // Rebalance and check output sanity...
5730         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5731         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5732         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 2);
5733
5734         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5735         // 0th HTLC:
5736         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
5737         // 1st HTLC:
5738         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
5739         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();
5740         // 2nd HTLC:
5741         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
5742         // 3rd HTLC:
5743         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
5744         // 4th HTLC:
5745         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5746         // 5th HTLC:
5747         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5748         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5749         // 6th HTLC:
5750         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5751         // 7th HTLC:
5752         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5753
5754         // 8th HTLC:
5755         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5756         // 9th HTLC:
5757         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();
5758         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
5759
5760         // 10th HTLC:
5761         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
5762         // 11th HTLC:
5763         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5764         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5765
5766         // Double-check that six of the new HTLC were added
5767         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5768         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5769         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.len(), 1);
5770         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 8);
5771
5772         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5773         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5774         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, ds_dust_limit*1000));
5775         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, 1000000));
5776         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, 1000000));
5777         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, ds_dust_limit*1000));
5778         check_added_monitors!(nodes[4], 0);
5779         expect_pending_htlcs_forwardable!(nodes[4]);
5780         check_added_monitors!(nodes[4], 1);
5781
5782         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5783         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]).unwrap();
5784         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]).unwrap();
5785         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]).unwrap();
5786         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]).unwrap();
5787         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5788
5789         // Fail 3rd below-dust and 7th above-dust HTLCs
5790         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, ds_dust_limit*1000));
5791         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, 1000000));
5792         check_added_monitors!(nodes[5], 0);
5793         expect_pending_htlcs_forwardable!(nodes[5]);
5794         check_added_monitors!(nodes[5], 1);
5795
5796         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5797         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]).unwrap();
5798         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]).unwrap();
5799         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5800
5801         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5802
5803         expect_pending_htlcs_forwardable!(nodes[3]);
5804         check_added_monitors!(nodes[3], 1);
5805         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5806         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]).unwrap();
5807         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]).unwrap();
5808         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]).unwrap();
5809         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]).unwrap();
5810         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]).unwrap();
5811         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]).unwrap();
5812         if deliver_last_raa {
5813                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5814         } else {
5815                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5816         }
5817
5818         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5819         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5820         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5821         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5822         //
5823         // We now broadcast the latest commitment transaction, which *should* result in failures for
5824         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5825         // the non-broadcast above-dust HTLCs.
5826         //
5827         // Alternatively, we may broadcast the previous commitment transaction, which should only
5828         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5829         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5830
5831         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5832         if announce_latest {
5833                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_last_commitment_tx[0]], &[1; 1]);
5834         } else {
5835                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_prev_commitment_tx[0]], &[1; 1]);
5836         }
5837         check_closed_broadcast!(nodes[2]);
5838         expect_pending_htlcs_forwardable!(nodes[2]);
5839         check_added_monitors!(nodes[2], 2);
5840
5841         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5842         assert_eq!(cs_msgs.len(), 2);
5843         let mut a_done = false;
5844         for msg in cs_msgs {
5845                 match msg {
5846                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5847                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5848                                 // should be failed-backwards here.
5849                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5850                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5851                                         for htlc in &updates.update_fail_htlcs {
5852                                                 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 });
5853                                         }
5854                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5855                                         assert!(!a_done);
5856                                         a_done = true;
5857                                         &nodes[0]
5858                                 } else {
5859                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5860                                         for htlc in &updates.update_fail_htlcs {
5861                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5862                                         }
5863                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5864                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5865                                         &nodes[1]
5866                                 };
5867                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
5868                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
5869                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]).unwrap();
5870                                 if announce_latest {
5871                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]).unwrap();
5872                                         if *node_id == nodes[0].node.get_our_node_id() {
5873                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]).unwrap();
5874                                         }
5875                                 }
5876                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5877                         },
5878                         _ => panic!("Unexpected event"),
5879                 }
5880         }
5881
5882         let as_events = nodes[0].node.get_and_clear_pending_events();
5883         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5884         let mut as_failds = HashSet::new();
5885         for event in as_events.iter() {
5886                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5887                         assert!(as_failds.insert(*payment_hash));
5888                         if *payment_hash != payment_hash_2 {
5889                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5890                         } else {
5891                                 assert!(!rejected_by_dest);
5892                         }
5893                 } else { panic!("Unexpected event"); }
5894         }
5895         assert!(as_failds.contains(&payment_hash_1));
5896         assert!(as_failds.contains(&payment_hash_2));
5897         if announce_latest {
5898                 assert!(as_failds.contains(&payment_hash_3));
5899                 assert!(as_failds.contains(&payment_hash_5));
5900         }
5901         assert!(as_failds.contains(&payment_hash_6));
5902
5903         let bs_events = nodes[1].node.get_and_clear_pending_events();
5904         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5905         let mut bs_failds = HashSet::new();
5906         for event in bs_events.iter() {
5907                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5908                         assert!(bs_failds.insert(*payment_hash));
5909                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5910                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5911                         } else {
5912                                 assert!(!rejected_by_dest);
5913                         }
5914                 } else { panic!("Unexpected event"); }
5915         }
5916         assert!(bs_failds.contains(&payment_hash_1));
5917         assert!(bs_failds.contains(&payment_hash_2));
5918         if announce_latest {
5919                 assert!(bs_failds.contains(&payment_hash_4));
5920         }
5921         assert!(bs_failds.contains(&payment_hash_5));
5922
5923         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5924         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5925         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5926         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5927         // PaymentFailureNetworkUpdates.
5928         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5929         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5930         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5931         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5932         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5933                 match event {
5934                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5935                         _ => panic!("Unexpected event"),
5936                 }
5937         }
5938 }
5939
5940 #[test]
5941 fn test_fail_backwards_latest_remote_announce_a() {
5942         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5943 }
5944
5945 #[test]
5946 fn test_fail_backwards_latest_remote_announce_b() {
5947         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5948 }
5949
5950 #[test]
5951 fn test_fail_backwards_previous_remote_announce() {
5952         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5953         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5954         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5955 }
5956
5957 #[test]
5958 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5959         let nodes = create_network(2);
5960
5961         // Create some initial channels
5962         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5963
5964         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5965         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5966         assert_eq!(local_txn[0].input.len(), 1);
5967         check_spends!(local_txn[0], chan_1.3.clone());
5968
5969         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5970         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5971         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5972         check_closed_broadcast!(nodes[0]);
5973
5974         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5975         assert_eq!(node_txn[0].input.len(), 1);
5976         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5977         check_spends!(node_txn[0], local_txn[0].clone());
5978
5979         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5980         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5981         assert_eq!(spend_txn.len(), 8);
5982         assert_eq!(spend_txn[0], spend_txn[2]);
5983         assert_eq!(spend_txn[0], spend_txn[4]);
5984         assert_eq!(spend_txn[0], spend_txn[6]);
5985         assert_eq!(spend_txn[1], spend_txn[3]);
5986         assert_eq!(spend_txn[1], spend_txn[5]);
5987         assert_eq!(spend_txn[1], spend_txn[7]);
5988         check_spends!(spend_txn[0], local_txn[0].clone());
5989         check_spends!(spend_txn[1], node_txn[0].clone());
5990 }
5991
5992 #[test]
5993 fn test_static_output_closing_tx() {
5994         let nodes = create_network(2);
5995
5996         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5997
5998         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5999         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
6000
6001         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6002         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
6003         let spend_txn = check_spendable_outputs!(nodes[0], 2);
6004         assert_eq!(spend_txn.len(), 1);
6005         check_spends!(spend_txn[0], closing_tx.clone());
6006
6007         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
6008         let spend_txn = check_spendable_outputs!(nodes[1], 2);
6009         assert_eq!(spend_txn.len(), 1);
6010         check_spends!(spend_txn[0], closing_tx);
6011 }
6012
6013 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>)
6014         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
6015                                 F2: FnMut(),
6016 {
6017         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);
6018 }
6019
6020 // test_case
6021 // 0: node1 fail backward
6022 // 1: final node fail backward
6023 // 2: payment completed but the user reject the payment
6024 // 3: final node fail backward (but tamper onion payloads from node0)
6025 // 100: trigger error in the intermediate node and tamper returnning fail_htlc
6026 // 200: trigger error in the final node and tamper returnning fail_htlc
6027 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>)
6028         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
6029                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
6030                                 F3: FnMut(),
6031 {
6032         use ln::msgs::HTLCFailChannelUpdate;
6033
6034         // reset block height
6035         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6036         for ix in 0..nodes.len() {
6037                 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
6038         }
6039
6040         macro_rules! expect_event {
6041                 ($node: expr, $event_type: path) => {{
6042                         let events = $node.node.get_and_clear_pending_events();
6043                         assert_eq!(events.len(), 1);
6044                         match events[0] {
6045                                 $event_type { .. } => {},
6046                                 _ => panic!("Unexpected event"),
6047                         }
6048                 }}
6049         }
6050
6051         macro_rules! expect_htlc_forward {
6052                 ($node: expr) => {{
6053                         expect_event!($node, Event::PendingHTLCsForwardable);
6054                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
6055                         $node.node.process_pending_htlc_forwards();
6056                 }}
6057         }
6058
6059         // 0 ~~> 2 send payment
6060         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
6061         check_added_monitors!(nodes[0], 1);
6062         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6063         // temper update_add (0 => 1)
6064         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
6065         if test_case == 0 || test_case == 3 || test_case == 100 {
6066                 callback_msg(&mut update_add_0);
6067                 callback_node();
6068         }
6069         // 0 => 1 update_add & CS
6070         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
6071         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
6072
6073         let update_1_0 = match test_case {
6074                 0|100 => { // intermediate node failure; fail backward to 0
6075                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6076                         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));
6077                         update_1_0
6078                 },
6079                 1|2|3|200 => { // final node failure; forwarding to 2
6080                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6081                         // forwarding on 1
6082                         if test_case != 200 {
6083                                 callback_node();
6084                         }
6085                         expect_htlc_forward!(&nodes[1]);
6086
6087                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
6088                         check_added_monitors!(&nodes[1], 1);
6089                         assert_eq!(update_1.update_add_htlcs.len(), 1);
6090                         // tamper update_add (1 => 2)
6091                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
6092                         if test_case != 3 && test_case != 200 {
6093                                 callback_msg(&mut update_add_1);
6094                         }
6095
6096                         // 1 => 2
6097                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
6098                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
6099
6100                         if test_case == 2 || test_case == 200 {
6101                                 expect_htlc_forward!(&nodes[2]);
6102                                 expect_event!(&nodes[2], Event::PaymentReceived);
6103                                 callback_node();
6104                                 expect_pending_htlcs_forwardable!(nodes[2]);
6105                         }
6106
6107                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6108                         if test_case == 2 || test_case == 200 {
6109                                 check_added_monitors!(&nodes[2], 1);
6110                         }
6111                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6112
6113                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6114                         if test_case == 200 {
6115                                 callback_fail(&mut fail_msg);
6116                         }
6117
6118                         // 2 => 1
6119                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
6120                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6121
6122                         // backward fail on 1
6123                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6124                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6125                         update_1_0
6126                 },
6127                 _ => unreachable!(),
6128         };
6129
6130         // 1 => 0 commitment_signed_dance
6131         if update_1_0.update_fail_htlcs.len() > 0 {
6132                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6133                 if test_case == 100 {
6134                         callback_fail(&mut fail_msg);
6135                 }
6136                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
6137         } else {
6138                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
6139         };
6140
6141         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6142
6143         let events = nodes[0].node.get_and_clear_pending_events();
6144         assert_eq!(events.len(), 1);
6145         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6146                 assert_eq!(*rejected_by_dest, !expected_retryable);
6147                 assert_eq!(*error_code, expected_error_code);
6148         } else {
6149                 panic!("Uexpected event");
6150         }
6151
6152         let events = nodes[0].node.get_and_clear_pending_msg_events();
6153         if expected_channel_update.is_some() {
6154                 assert_eq!(events.len(), 1);
6155                 match events[0] {
6156                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6157                                 match update {
6158                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6159                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6160                                                         panic!("channel_update not found!");
6161                                                 }
6162                                         },
6163                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6164                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6165                                                         assert!(*short_channel_id == *expected_short_channel_id);
6166                                                         assert!(*is_permanent == *expected_is_permanent);
6167                                                 } else {
6168                                                         panic!("Unexpected message event");
6169                                                 }
6170                                         },
6171                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6172                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6173                                                         assert!(*node_id == *expected_node_id);
6174                                                         assert!(*is_permanent == *expected_is_permanent);
6175                                                 } else {
6176                                                         panic!("Unexpected message event");
6177                                                 }
6178                                         },
6179                                 }
6180                         },
6181                         _ => panic!("Unexpected message event"),
6182                 }
6183         } else {
6184                 assert_eq!(events.len(), 0);
6185         }
6186 }
6187
6188 impl msgs::ChannelUpdate {
6189         fn dummy() -> msgs::ChannelUpdate {
6190                 use secp256k1::ffi::Signature as FFISignature;
6191                 use secp256k1::Signature;
6192                 msgs::ChannelUpdate {
6193                         signature: Signature::from(FFISignature::new()),
6194                         contents: msgs::UnsignedChannelUpdate {
6195                                 chain_hash: Sha256dHash::from_data(&vec![0u8][..]),
6196                                 short_channel_id: 0,
6197                                 timestamp: 0,
6198                                 flags: 0,
6199                                 cltv_expiry_delta: 0,
6200                                 htlc_minimum_msat: 0,
6201                                 fee_base_msat: 0,
6202                                 fee_proportional_millionths: 0,
6203                                 excess_data: vec![],
6204                         }
6205                 }
6206         }
6207 }
6208
6209 #[test]
6210 fn test_onion_failure() {
6211         use ln::msgs::ChannelUpdate;
6212         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6213         use secp256k1;
6214
6215         const BADONION: u16 = 0x8000;
6216         const PERM: u16 = 0x4000;
6217         const NODE: u16 = 0x2000;
6218         const UPDATE: u16 = 0x1000;
6219
6220         let mut nodes = create_network(3);
6221         for node in nodes.iter() {
6222                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&Secp256k1::without_caps(), &[3; 32]).unwrap());
6223         }
6224         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
6225         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6226         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
6227         // positve case
6228         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
6229
6230         // intermediate node failure
6231         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6232                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6233                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6234                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6235                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
6236                 onion_payloads[0].realm = 3;
6237                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6238         }, ||{}, 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
6239
6240         // final node failure
6241         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6242                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6243                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6244                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6245                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
6246                 onion_payloads[1].realm = 3;
6247                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6248         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6249
6250         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6251         // receiving simulated fail messages
6252         // intermediate node failure
6253         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6254                 // trigger error
6255                 msg.amount_msat -= 1;
6256         }, |msg| {
6257                 // and tamper returing error message
6258                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6259                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6260                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6261         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
6262
6263         // final node failure
6264         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6265                 // and tamper returing error message
6266                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6267                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6268                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6269         }, ||{
6270                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6271         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
6272
6273         // intermediate node failure
6274         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6275                 msg.amount_msat -= 1;
6276         }, |msg| {
6277                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6278                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6279                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6280         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6281
6282         // final node failure
6283         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6284                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6285                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6286                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6287         }, ||{
6288                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6289         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6290
6291         // intermediate node failure
6292         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6293                 msg.amount_msat -= 1;
6294         }, |msg| {
6295                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6296                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6297                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6298         }, ||{
6299                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6300         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
6301
6302         // final node failure
6303         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6304                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6305                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6306                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6307         }, ||{
6308                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6309         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
6310
6311         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6312                 Some(BADONION|PERM|4), None);
6313
6314         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6315                 Some(BADONION|PERM|5), None);
6316
6317         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6318                 Some(BADONION|PERM|6), None);
6319
6320         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6321                 msg.amount_msat -= 1;
6322         }, |msg| {
6323                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6324                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6325                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6326         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6327
6328         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 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|8, &[0;0]);
6334                 // short_channel_id from the processing node
6335         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6336
6337         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6338                 msg.amount_msat -= 1;
6339         }, |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[0].shared_secret[..], PERM|9, &[0;0]);
6343                 // short_channel_id from the processing node
6344         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6345
6346         let mut bogus_route = route.clone();
6347         bogus_route.hops[1].short_channel_id -= 1;
6348         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6349           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
6350
6351         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6352         let mut bogus_route = route.clone();
6353         let route_len = bogus_route.hops.len();
6354         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
6355         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6356
6357         //TODO: with new config API, we will be able to generate both valid and
6358         //invalid channel_update cases.
6359         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6360                 msg.amount_msat -= 1;
6361         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6362
6363         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6364                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6365                 msg.cltv_expiry -= 1;
6366         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6367
6368         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6369                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6370                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6371                 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6372         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6373
6374         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6375                 nodes[2].node.fail_htlc_backwards(&payment_hash, 0);
6376         }, false, Some(PERM|15), None);
6377
6378         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6379                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
6380                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6381                 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
6382         }, || {}, true, Some(17), None);
6383
6384         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6385                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6386                         for f in pending_forwards.iter_mut() {
6387                                 match f {
6388                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6389                                                 forward_info.outgoing_cltv_value += 1,
6390                                         _ => {},
6391                                 }
6392                         }
6393                 }
6394         }, true, Some(18), None);
6395
6396         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6397                 // violate amt_to_forward > msg.amount_msat
6398                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
6399                         for f in pending_forwards.iter_mut() {
6400                                 match f {
6401                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6402                                                 forward_info.amt_to_forward -= 1,
6403                                         _ => {},
6404                                 }
6405                         }
6406                 }
6407         }, true, Some(19), None);
6408
6409         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6410                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6411                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6412                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6413         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6414         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6415
6416         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6417                 let session_priv = SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[3; 32]).unwrap();
6418                 let mut route = route.clone();
6419                 let height = 1;
6420                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
6421                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
6422                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
6423                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
6424                 msg.cltv_expiry = htlc_cltv;
6425                 msg.onion_routing_packet = onion_packet;
6426         }, ||{}, true, Some(21), None);
6427 }