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