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