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

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