_ 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         let mut height = 99;
2678         while !headers.is_empty() {
2679                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2680                 height -= 1;
2681         }
2682         check_closed_broadcast!(nodes[0]);
2683         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2684         assert_eq!(channel_state.by_id.len(), 0);
2685         assert_eq!(channel_state.short_to_id.len(), 0);
2686 }
2687
2688 #[test]
2689 fn test_simple_peer_disconnect() {
2690         // Test that we can reconnect when there are no lost messages
2691         let nodes = create_network(3);
2692         create_announced_chan_between_nodes(&nodes, 0, 1);
2693         create_announced_chan_between_nodes(&nodes, 1, 2);
2694
2695         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2696         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2697         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2698
2699         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2700         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2701         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2702         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
2703
2704         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2705         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2706         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2707
2708         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2709         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2710         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2711         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2712
2713         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2714         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2715
2716         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
2717         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2718
2719         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2720         {
2721                 let events = nodes[0].node.get_and_clear_pending_events();
2722                 assert_eq!(events.len(), 2);
2723                 match events[0] {
2724                         Event::PaymentSent { payment_preimage } => {
2725                                 assert_eq!(payment_preimage, payment_preimage_3);
2726                         },
2727                         _ => panic!("Unexpected event"),
2728                 }
2729                 match events[1] {
2730                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2731                                 assert_eq!(payment_hash, payment_hash_5);
2732                                 assert!(rejected_by_dest);
2733                         },
2734                         _ => panic!("Unexpected event"),
2735                 }
2736         }
2737
2738         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
2739         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2740 }
2741
2742 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2743         // Test that we can reconnect when in-flight HTLC updates get dropped
2744         let mut nodes = create_network(2);
2745         if messages_delivered == 0 {
2746                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
2747                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2748         } else {
2749                 create_announced_chan_between_nodes(&nodes, 0, 1);
2750         }
2751
2752         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();
2753         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2754
2755         let payment_event = {
2756                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2757                 check_added_monitors!(nodes[0], 1);
2758
2759                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2760                 assert_eq!(events.len(), 1);
2761                 SendEvent::from_event(events.remove(0))
2762         };
2763         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2764
2765         if messages_delivered < 2 {
2766                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2767         } else {
2768                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2769                 if messages_delivered >= 3 {
2770                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2771                         check_added_monitors!(nodes[1], 1);
2772                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2773
2774                         if messages_delivered >= 4 {
2775                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2776                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2777                                 check_added_monitors!(nodes[0], 1);
2778
2779                                 if messages_delivered >= 5 {
2780                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
2781                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2782                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
2783                                         check_added_monitors!(nodes[0], 1);
2784
2785                                         if messages_delivered >= 6 {
2786                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2787                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2788                                                 check_added_monitors!(nodes[1], 1);
2789                                         }
2790                                 }
2791                         }
2792                 }
2793         }
2794
2795         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2796         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2797         if messages_delivered < 3 {
2798                 // Even if the funding_locked messages get exchanged, as long as nothing further was
2799                 // received on either side, both sides will need to resend them.
2800                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2801         } else if messages_delivered == 3 {
2802                 // nodes[0] still wants its RAA + commitment_signed
2803                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2804         } else if messages_delivered == 4 {
2805                 // nodes[0] still wants its commitment_signed
2806                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2807         } else if messages_delivered == 5 {
2808                 // nodes[1] still wants its final RAA
2809                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2810         } else if messages_delivered == 6 {
2811                 // Everything was delivered...
2812                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2813         }
2814
2815         let events_1 = nodes[1].node.get_and_clear_pending_events();
2816         assert_eq!(events_1.len(), 1);
2817         match events_1[0] {
2818                 Event::PendingHTLCsForwardable { .. } => { },
2819                 _ => panic!("Unexpected event"),
2820         };
2821
2822         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2823         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2824         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2825
2826         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
2827         nodes[1].node.process_pending_htlc_forwards();
2828
2829         let events_2 = nodes[1].node.get_and_clear_pending_events();
2830         assert_eq!(events_2.len(), 1);
2831         match events_2[0] {
2832                 Event::PaymentReceived { ref payment_hash, amt } => {
2833                         assert_eq!(payment_hash_1, *payment_hash);
2834                         assert_eq!(amt, 1000000);
2835                 },
2836                 _ => panic!("Unexpected event"),
2837         }
2838
2839         nodes[1].node.claim_funds(payment_preimage_1);
2840         check_added_monitors!(nodes[1], 1);
2841
2842         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
2843         assert_eq!(events_3.len(), 1);
2844         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
2845                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2846                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2847                         assert!(updates.update_add_htlcs.is_empty());
2848                         assert!(updates.update_fail_htlcs.is_empty());
2849                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2850                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2851                         assert!(updates.update_fee.is_none());
2852                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2853                 },
2854                 _ => panic!("Unexpected event"),
2855         };
2856
2857         if messages_delivered >= 1 {
2858                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
2859
2860                 let events_4 = nodes[0].node.get_and_clear_pending_events();
2861                 assert_eq!(events_4.len(), 1);
2862                 match events_4[0] {
2863                         Event::PaymentSent { ref payment_preimage } => {
2864                                 assert_eq!(payment_preimage_1, *payment_preimage);
2865                         },
2866                         _ => panic!("Unexpected event"),
2867                 }
2868
2869                 if messages_delivered >= 2 {
2870                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
2871                         check_added_monitors!(nodes[0], 1);
2872                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2873
2874                         if messages_delivered >= 3 {
2875                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2876                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2877                                 check_added_monitors!(nodes[1], 1);
2878
2879                                 if messages_delivered >= 4 {
2880                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
2881                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2882                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
2883                                         check_added_monitors!(nodes[1], 1);
2884
2885                                         if messages_delivered >= 5 {
2886                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2887                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2888                                                 check_added_monitors!(nodes[0], 1);
2889                                         }
2890                                 }
2891                         }
2892                 }
2893         }
2894
2895         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2896         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2897         if messages_delivered < 2 {
2898                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
2899                 //TODO: Deduplicate PaymentSent events, then enable this if:
2900                 //if messages_delivered < 1 {
2901                         let events_4 = nodes[0].node.get_and_clear_pending_events();
2902                         assert_eq!(events_4.len(), 1);
2903                         match events_4[0] {
2904                                 Event::PaymentSent { ref payment_preimage } => {
2905                                         assert_eq!(payment_preimage_1, *payment_preimage);
2906                                 },
2907                                 _ => panic!("Unexpected event"),
2908                         }
2909                 //}
2910         } else if messages_delivered == 2 {
2911                 // nodes[0] still wants its RAA + commitment_signed
2912                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
2913         } else if messages_delivered == 3 {
2914                 // nodes[0] still wants its commitment_signed
2915                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
2916         } else if messages_delivered == 4 {
2917                 // nodes[1] still wants its final RAA
2918                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
2919         } else if messages_delivered == 5 {
2920                 // Everything was delivered...
2921                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2922         }
2923
2924         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2925         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2926         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2927
2928         // Channel should still work fine...
2929         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
2930         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
2931 }
2932
2933 #[test]
2934 fn test_drop_messages_peer_disconnect_a() {
2935         do_test_drop_messages_peer_disconnect(0);
2936         do_test_drop_messages_peer_disconnect(1);
2937         do_test_drop_messages_peer_disconnect(2);
2938         do_test_drop_messages_peer_disconnect(3);
2939 }
2940
2941 #[test]
2942 fn test_drop_messages_peer_disconnect_b() {
2943         do_test_drop_messages_peer_disconnect(4);
2944         do_test_drop_messages_peer_disconnect(5);
2945         do_test_drop_messages_peer_disconnect(6);
2946 }
2947
2948 #[test]
2949 fn test_funding_peer_disconnect() {
2950         // Test that we can lock in our funding tx while disconnected
2951         let nodes = create_network(2);
2952         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
2953
2954         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2955         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2956
2957         confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
2958         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
2959         assert_eq!(events_1.len(), 1);
2960         match events_1[0] {
2961                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2962                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
2963                 },
2964                 _ => panic!("Unexpected event"),
2965         }
2966
2967         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2968
2969         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2970         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2971
2972         confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
2973         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2974         assert_eq!(events_2.len(), 2);
2975         match events_2[0] {
2976                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
2977                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2978                 },
2979                 _ => panic!("Unexpected event"),
2980         }
2981         match events_2[1] {
2982                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
2983                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2984                 },
2985                 _ => panic!("Unexpected event"),
2986         }
2987
2988         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2989
2990         // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
2991         // rebroadcasting announcement_signatures upon reconnect.
2992
2993         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();
2994         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
2995         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
2996 }
2997
2998 #[test]
2999 fn test_drop_messages_peer_disconnect_dual_htlc() {
3000         // Test that we can handle reconnecting when both sides of a channel have pending
3001         // commitment_updates when we disconnect.
3002         let mut nodes = create_network(2);
3003         create_announced_chan_between_nodes(&nodes, 0, 1);
3004
3005         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3006
3007         // Now try to send a second payment which will fail to send
3008         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3009         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3010
3011         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3012         check_added_monitors!(nodes[0], 1);
3013
3014         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3015         assert_eq!(events_1.len(), 1);
3016         match events_1[0] {
3017                 MessageSendEvent::UpdateHTLCs { .. } => {},
3018                 _ => panic!("Unexpected event"),
3019         }
3020
3021         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3022         check_added_monitors!(nodes[1], 1);
3023
3024         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3025         assert_eq!(events_2.len(), 1);
3026         match events_2[0] {
3027                 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 } } => {
3028                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3029                         assert!(update_add_htlcs.is_empty());
3030                         assert_eq!(update_fulfill_htlcs.len(), 1);
3031                         assert!(update_fail_htlcs.is_empty());
3032                         assert!(update_fail_malformed_htlcs.is_empty());
3033                         assert!(update_fee.is_none());
3034
3035                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3036                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3037                         assert_eq!(events_3.len(), 1);
3038                         match events_3[0] {
3039                                 Event::PaymentSent { ref payment_preimage } => {
3040                                         assert_eq!(*payment_preimage, payment_preimage_1);
3041                                 },
3042                                 _ => panic!("Unexpected event"),
3043                         }
3044
3045                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3046                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3047                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3048                         check_added_monitors!(nodes[0], 1);
3049                 },
3050                 _ => panic!("Unexpected event"),
3051         }
3052
3053         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3054         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3055
3056         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3057         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3058         assert_eq!(reestablish_1.len(), 1);
3059         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3060         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3061         assert_eq!(reestablish_2.len(), 1);
3062
3063         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3064         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3065         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3066         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3067
3068         assert!(as_resp.0.is_none());
3069         assert!(bs_resp.0.is_none());
3070
3071         assert!(bs_resp.1.is_none());
3072         assert!(bs_resp.2.is_none());
3073
3074         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3075
3076         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3077         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3078         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3079         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3080         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3081         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();
3082         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3083         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3084         // No commitment_signed so get_event_msg's assert(len == 1) passes
3085         check_added_monitors!(nodes[1], 1);
3086
3087         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3088         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3089         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3090         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3091         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3092         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3093         assert!(bs_second_commitment_signed.update_fee.is_none());
3094         check_added_monitors!(nodes[1], 1);
3095
3096         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3097         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3098         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3099         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3100         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3101         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3102         assert!(as_commitment_signed.update_fee.is_none());
3103         check_added_monitors!(nodes[0], 1);
3104
3105         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3106         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3107         // No commitment_signed so get_event_msg's assert(len == 1) passes
3108         check_added_monitors!(nodes[0], 1);
3109
3110         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3111         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3112         // No commitment_signed so get_event_msg's assert(len == 1) passes
3113         check_added_monitors!(nodes[1], 1);
3114
3115         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3116         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3117         check_added_monitors!(nodes[1], 1);
3118
3119         expect_pending_htlcs_forwardable!(nodes[1]);
3120
3121         let events_5 = nodes[1].node.get_and_clear_pending_events();
3122         assert_eq!(events_5.len(), 1);
3123         match events_5[0] {
3124                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3125                         assert_eq!(payment_hash_2, *payment_hash);
3126                 },
3127                 _ => panic!("Unexpected event"),
3128         }
3129
3130         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3131         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3132         check_added_monitors!(nodes[0], 1);
3133
3134         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3135 }
3136
3137 #[test]
3138 fn test_invalid_channel_announcement() {
3139         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3140         let secp_ctx = Secp256k1::new();
3141         let nodes = create_network(2);
3142
3143         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
3144
3145         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3146         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3147         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3148         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3149
3150         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 } );
3151
3152         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
3153         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
3154
3155         let as_network_key = nodes[0].node.get_our_node_id();
3156         let bs_network_key = nodes[1].node.get_our_node_id();
3157
3158         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3159
3160         let mut chan_announcement;
3161
3162         macro_rules! dummy_unsigned_msg {
3163                 () => {
3164                         msgs::UnsignedChannelAnnouncement {
3165                                 features: msgs::GlobalFeatures::new(),
3166                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3167                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3168                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3169                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3170                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3171                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3172                                 excess_data: Vec::new(),
3173                         };
3174                 }
3175         }
3176
3177         macro_rules! sign_msg {
3178                 ($unsigned_msg: expr) => {
3179                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3180                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
3181                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
3182                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3183                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3184                         chan_announcement = msgs::ChannelAnnouncement {
3185                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3186                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3187                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3188                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3189                                 contents: $unsigned_msg
3190                         }
3191                 }
3192         }
3193
3194         let unsigned_msg = dummy_unsigned_msg!();
3195         sign_msg!(unsigned_msg);
3196         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3197         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 } );
3198
3199         // Configured with Network::Testnet
3200         let mut unsigned_msg = dummy_unsigned_msg!();
3201         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3202         sign_msg!(unsigned_msg);
3203         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3204
3205         let mut unsigned_msg = dummy_unsigned_msg!();
3206         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3207         sign_msg!(unsigned_msg);
3208         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3209 }
3210
3211 #[test]
3212 fn test_no_txn_manager_serialize_deserialize() {
3213         let mut nodes = create_network(2);
3214
3215         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
3216
3217         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3218
3219         let nodes_0_serialized = nodes[0].node.encode();
3220         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3221         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3222
3223         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 })));
3224         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3225         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3226         assert!(chan_0_monitor_read.is_empty());
3227
3228         let mut nodes_0_read = &nodes_0_serialized[..];
3229         let config = UserConfig::new();
3230         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3231         let (_, nodes_0_deserialized) = {
3232                 let mut channel_monitors = HashMap::new();
3233                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3234                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3235                         default_config: config,
3236                         keys_manager,
3237                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3238                         monitor: nodes[0].chan_monitor.clone(),
3239                         chain_monitor: nodes[0].chain_monitor.clone(),
3240                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3241                         logger: Arc::new(test_utils::TestLogger::new()),
3242                         channel_monitors: &channel_monitors,
3243                 }).unwrap()
3244         };
3245         assert!(nodes_0_read.is_empty());
3246
3247         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3248         nodes[0].node = Arc::new(nodes_0_deserialized);
3249         let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3250         nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
3251         assert_eq!(nodes[0].node.list_channels().len(), 1);
3252         check_added_monitors!(nodes[0], 1);
3253
3254         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3255         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3256         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3257         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3258
3259         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3260         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3261         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3262         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3263
3264         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3265         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3266         for node in nodes.iter() {
3267                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3268                 node.router.handle_channel_update(&as_update).unwrap();
3269                 node.router.handle_channel_update(&bs_update).unwrap();
3270         }
3271
3272         send_payment(&nodes[0], &[&nodes[1]], 1000000);
3273 }
3274
3275 #[test]
3276 fn test_simple_manager_serialize_deserialize() {
3277         let mut nodes = create_network(2);
3278         create_announced_chan_between_nodes(&nodes, 0, 1);
3279
3280         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3281         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3282
3283         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3284
3285         let nodes_0_serialized = nodes[0].node.encode();
3286         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3287         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3288
3289         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 })));
3290         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3291         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3292         assert!(chan_0_monitor_read.is_empty());
3293
3294         let mut nodes_0_read = &nodes_0_serialized[..];
3295         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3296         let (_, nodes_0_deserialized) = {
3297                 let mut channel_monitors = HashMap::new();
3298                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3299                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3300                         default_config: UserConfig::new(),
3301                         keys_manager,
3302                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3303                         monitor: nodes[0].chan_monitor.clone(),
3304                         chain_monitor: nodes[0].chain_monitor.clone(),
3305                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3306                         logger: Arc::new(test_utils::TestLogger::new()),
3307                         channel_monitors: &channel_monitors,
3308                 }).unwrap()
3309         };
3310         assert!(nodes_0_read.is_empty());
3311
3312         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3313         nodes[0].node = Arc::new(nodes_0_deserialized);
3314         check_added_monitors!(nodes[0], 1);
3315
3316         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3317
3318         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3319         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
3320 }
3321
3322 #[test]
3323 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3324         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3325         let mut nodes = create_network(4);
3326         create_announced_chan_between_nodes(&nodes, 0, 1);
3327         create_announced_chan_between_nodes(&nodes, 2, 0);
3328         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
3329
3330         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3331
3332         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3333         let nodes_0_serialized = nodes[0].node.encode();
3334
3335         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3336         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3337         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3338         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3339
3340         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3341         // nodes[3])
3342         let mut node_0_monitors_serialized = Vec::new();
3343         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3344                 let mut writer = test_utils::TestVecWriter(Vec::new());
3345                 monitor.1.write_for_disk(&mut writer).unwrap();
3346                 node_0_monitors_serialized.push(writer.0);
3347         }
3348
3349         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 })));
3350         let mut node_0_monitors = Vec::new();
3351         for serialized in node_0_monitors_serialized.iter() {
3352                 let mut read = &serialized[..];
3353                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3354                 assert!(read.is_empty());
3355                 node_0_monitors.push(monitor);
3356         }
3357
3358         let mut nodes_0_read = &nodes_0_serialized[..];
3359         let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3360         let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3361                 default_config: UserConfig::new(),
3362                 keys_manager,
3363                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3364                 monitor: nodes[0].chan_monitor.clone(),
3365                 chain_monitor: nodes[0].chain_monitor.clone(),
3366                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3367                 logger: Arc::new(test_utils::TestLogger::new()),
3368                 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3369         }).unwrap();
3370         assert!(nodes_0_read.is_empty());
3371
3372         { // Channel close should result in a commitment tx and an HTLC tx
3373                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3374                 assert_eq!(txn.len(), 2);
3375                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3376                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3377         }
3378
3379         for monitor in node_0_monitors.drain(..) {
3380                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3381                 check_added_monitors!(nodes[0], 1);
3382         }
3383         nodes[0].node = Arc::new(nodes_0_deserialized);
3384
3385         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3386         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3387         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3388         //... and we can even still claim the payment!
3389         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
3390
3391         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
3392         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3393         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
3394         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) {
3395                 assert_eq!(msg.channel_id, channel_id);
3396         } else { panic!("Unexpected result"); }
3397 }
3398
3399 macro_rules! check_spendable_outputs {
3400         ($node: expr, $der_idx: expr) => {
3401                 {
3402                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3403                         let mut txn = Vec::new();
3404                         for event in events {
3405                                 match event {
3406                                         Event::SpendableOutputs { ref outputs } => {
3407                                                 for outp in outputs {
3408                                                         match *outp {
3409                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3410                                                                         let input = TxIn {
3411                                                                                 previous_output: outpoint.clone(),
3412                                                                                 script_sig: Script::new(),
3413                                                                                 sequence: 0,
3414                                                                                 witness: Vec::new(),
3415                                                                         };
3416                                                                         let outp = TxOut {
3417                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3418                                                                                 value: output.value,
3419                                                                         };
3420                                                                         let mut spend_tx = Transaction {
3421                                                                                 version: 2,
3422                                                                                 lock_time: 0,
3423                                                                                 input: vec![input],
3424                                                                                 output: vec![outp],
3425                                                                         };
3426                                                                         let secp_ctx = Secp256k1::new();
3427                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3428                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3429                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3430                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3431                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3432                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3433                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3434                                                                         txn.push(spend_tx);
3435                                                                 },
3436                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3437                                                                         let input = TxIn {
3438                                                                                 previous_output: outpoint.clone(),
3439                                                                                 script_sig: Script::new(),
3440                                                                                 sequence: *to_self_delay as u32,
3441                                                                                 witness: Vec::new(),
3442                                                                         };
3443                                                                         let outp = TxOut {
3444                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3445                                                                                 value: output.value,
3446                                                                         };
3447                                                                         let mut spend_tx = Transaction {
3448                                                                                 version: 2,
3449                                                                                 lock_time: 0,
3450                                                                                 input: vec![input],
3451                                                                                 output: vec![outp],
3452                                                                         };
3453                                                                         let secp_ctx = Secp256k1::new();
3454                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3455                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3456                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3457                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3458                                                                         spend_tx.input[0].witness.push(vec!(0));
3459                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3460                                                                         txn.push(spend_tx);
3461                                                                 },
3462                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3463                                                                         let secp_ctx = Secp256k1::new();
3464                                                                         let input = TxIn {
3465                                                                                 previous_output: outpoint.clone(),
3466                                                                                 script_sig: Script::new(),
3467                                                                                 sequence: 0,
3468                                                                                 witness: Vec::new(),
3469                                                                         };
3470                                                                         let outp = TxOut {
3471                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3472                                                                                 value: output.value,
3473                                                                         };
3474                                                                         let mut spend_tx = Transaction {
3475                                                                                 version: 2,
3476                                                                                 lock_time: 0,
3477                                                                                 input: vec![input],
3478                                                                                 output: vec![outp.clone()],
3479                                                                         };
3480                                                                         let secret = {
3481                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3482                                                                                         Ok(master_key) => {
3483                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3484                                                                                                         Ok(key) => key,
3485                                                                                                         Err(_) => panic!("Your RNG is busted"),
3486                                                                                                 }
3487                                                                                         }
3488                                                                                         Err(_) => panic!("Your rng is busted"),
3489                                                                                 }
3490                                                                         };
3491                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3492                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3493                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3494                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3495                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3496                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3497                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3498                                                                         txn.push(spend_tx);
3499                                                                 },
3500                                                         }
3501                                                 }
3502                                         },
3503                                         _ => panic!("Unexpected event"),
3504                                 };
3505                         }
3506                         txn
3507                 }
3508         }
3509 }
3510
3511 #[test]
3512 fn test_claim_sizeable_push_msat() {
3513         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3514         let nodes = create_network(2);
3515
3516         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3517         nodes[1].node.force_close_channel(&chan.2);
3518         check_closed_broadcast!(nodes[1]);
3519         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3520         assert_eq!(node_txn.len(), 1);
3521         check_spends!(node_txn[0], chan.3.clone());
3522         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
3523
3524         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3525         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3526         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3527         assert_eq!(spend_txn.len(), 1);
3528         check_spends!(spend_txn[0], node_txn[0].clone());
3529 }
3530
3531 #[test]
3532 fn test_claim_on_remote_sizeable_push_msat() {
3533         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3534         // to_remote output is encumbered by a P2WPKH
3535
3536         let nodes = create_network(2);
3537
3538         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
3539         nodes[0].node.force_close_channel(&chan.2);
3540         check_closed_broadcast!(nodes[0]);
3541
3542         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3543         assert_eq!(node_txn.len(), 1);
3544         check_spends!(node_txn[0], chan.3.clone());
3545         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
3546
3547         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3548         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3549         check_closed_broadcast!(nodes[1]);
3550         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3551         assert_eq!(spend_txn.len(), 2);
3552         assert_eq!(spend_txn[0], spend_txn[1]);
3553         check_spends!(spend_txn[0], node_txn[0].clone());
3554 }
3555
3556 #[test]
3557 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3558         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3559         // to_remote output is encumbered by a P2WPKH
3560
3561         let nodes = create_network(2);
3562
3563         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
3564         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3565         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
3566         assert_eq!(revoked_local_txn[0].input.len(), 1);
3567         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3568
3569         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3570         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3571         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3572         check_closed_broadcast!(nodes[1]);
3573
3574         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3575         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3576         assert_eq!(spend_txn.len(), 4);
3577         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3578         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3579         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3580         check_spends!(spend_txn[1], node_txn[0].clone());
3581 }
3582
3583 #[test]
3584 fn test_static_spendable_outputs_preimage_tx() {
3585         let nodes = create_network(2);
3586
3587         // Create some initial channels
3588         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3589
3590         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3591
3592         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3593         assert_eq!(commitment_tx[0].input.len(), 1);
3594         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3595
3596         // Settle A's commitment tx on B's chain
3597         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3598         assert!(nodes[1].node.claim_funds(payment_preimage));
3599         check_added_monitors!(nodes[1], 1);
3600         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3601         let events = nodes[1].node.get_and_clear_pending_msg_events();
3602         match events[0] {
3603                 MessageSendEvent::UpdateHTLCs { .. } => {},
3604                 _ => panic!("Unexpected event"),
3605         }
3606         match events[1] {
3607                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3608                 _ => panic!("Unexepected event"),
3609         }
3610
3611         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3612         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
3613         check_spends!(node_txn[0], commitment_tx[0].clone());
3614         assert_eq!(node_txn[0], node_txn[2]);
3615         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3616         check_spends!(node_txn[1], chan_1.3.clone());
3617
3618         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3619         assert_eq!(spend_txn.len(), 2);
3620         assert_eq!(spend_txn[0], spend_txn[1]);
3621         check_spends!(spend_txn[0], node_txn[0].clone());
3622 }
3623
3624 #[test]
3625 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3626         let nodes = create_network(2);
3627
3628         // Create some initial channels
3629         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3630
3631         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3632         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3633         assert_eq!(revoked_local_txn[0].input.len(), 1);
3634         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3635
3636         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3637
3638         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3639         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3640         check_closed_broadcast!(nodes[1]);
3641
3642         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3643         assert_eq!(node_txn.len(), 3);
3644         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3645         assert_eq!(node_txn[0].input.len(), 2);
3646         check_spends!(node_txn[0], revoked_local_txn[0].clone());
3647
3648         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3649         assert_eq!(spend_txn.len(), 2);
3650         assert_eq!(spend_txn[0], spend_txn[1]);
3651         check_spends!(spend_txn[0], node_txn[0].clone());
3652 }
3653
3654 #[test]
3655 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3656         let nodes = create_network(2);
3657
3658         // Create some initial channels
3659         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3660
3661         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3662         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3663         assert_eq!(revoked_local_txn[0].input.len(), 1);
3664         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3665
3666         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3667
3668         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3669         // A will generate HTLC-Timeout from revoked commitment tx
3670         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3671         check_closed_broadcast!(nodes[0]);
3672
3673         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3674         assert_eq!(revoked_htlc_txn.len(), 3);
3675         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3676         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3677         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3678         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3679         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3680
3681         // B will generate justice tx from A's revoked commitment/HTLC tx
3682         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3683         check_closed_broadcast!(nodes[1]);
3684
3685         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3686         assert_eq!(node_txn.len(), 4);
3687         assert_eq!(node_txn[3].input.len(), 1);
3688         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3689
3690         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3691         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3692         assert_eq!(spend_txn.len(), 3);
3693         assert_eq!(spend_txn[0], spend_txn[1]);
3694         check_spends!(spend_txn[0], node_txn[0].clone());
3695         check_spends!(spend_txn[2], node_txn[3].clone());
3696 }
3697
3698 #[test]
3699 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3700         let nodes = create_network(2);
3701
3702         // Create some initial channels
3703         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3704
3705         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3706         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3707         assert_eq!(revoked_local_txn[0].input.len(), 1);
3708         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3709
3710         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
3711
3712         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3713         // B will generate HTLC-Success from revoked commitment tx
3714         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3715         check_closed_broadcast!(nodes[1]);
3716         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3717
3718         assert_eq!(revoked_htlc_txn.len(), 3);
3719         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3720         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3721         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3722         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3723
3724         // A will generate justice tx from B's revoked commitment/HTLC tx
3725         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3726         check_closed_broadcast!(nodes[0]);
3727
3728         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3729         assert_eq!(node_txn.len(), 4);
3730         assert_eq!(node_txn[3].input.len(), 1);
3731         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3732
3733         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3734         let spend_txn = check_spendable_outputs!(nodes[0], 1);
3735         assert_eq!(spend_txn.len(), 5);
3736         assert_eq!(spend_txn[0], spend_txn[2]);
3737         assert_eq!(spend_txn[1], spend_txn[3]);
3738         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3739         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3740         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3741 }
3742
3743 #[test]
3744 fn test_onchain_to_onchain_claim() {
3745         // Test that in case of channel closure, we detect the state of output thanks to
3746         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3747         // First, have C claim an HTLC against its own latest commitment transaction.
3748         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3749         // channel.
3750         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3751         // gets broadcast.
3752
3753         let nodes = create_network(3);
3754
3755         // Create some initial channels
3756         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3757         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3758
3759         // Rebalance the network a bit by relaying one payment through all the channels ...
3760         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3761         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
3762
3763         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3764         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3765         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3766         check_spends!(commitment_tx[0], chan_2.3.clone());
3767         nodes[2].node.claim_funds(payment_preimage);
3768         check_added_monitors!(nodes[2], 1);
3769         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3770         assert!(updates.update_add_htlcs.is_empty());
3771         assert!(updates.update_fail_htlcs.is_empty());
3772         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3773         assert!(updates.update_fail_malformed_htlcs.is_empty());
3774
3775         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3776         check_closed_broadcast!(nodes[2]);
3777
3778         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3779         assert_eq!(c_txn.len(), 3);
3780         assert_eq!(c_txn[0], c_txn[2]);
3781         assert_eq!(commitment_tx[0], c_txn[1]);
3782         check_spends!(c_txn[1], chan_2.3.clone());
3783         check_spends!(c_txn[2], c_txn[1].clone());
3784         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
3785         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3786         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3787         assert_eq!(c_txn[0].lock_time, 0); // Success tx
3788
3789         // 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
3790         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
3791         {
3792                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3793                 assert_eq!(b_txn.len(), 4);
3794                 assert_eq!(b_txn[0], b_txn[3]);
3795                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
3796                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
3797                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3798                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3799                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3800                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
3801                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3802                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3803                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3804                 b_txn.clear();
3805         }
3806         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
3807         check_added_monitors!(nodes[1], 1);
3808         match msg_events[0] {
3809                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
3810                 _ => panic!("Unexpected event"),
3811         }
3812         match msg_events[1] {
3813                 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, .. } } => {
3814                         assert!(update_add_htlcs.is_empty());
3815                         assert!(update_fail_htlcs.is_empty());
3816                         assert_eq!(update_fulfill_htlcs.len(), 1);
3817                         assert!(update_fail_malformed_htlcs.is_empty());
3818                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3819                 },
3820                 _ => panic!("Unexpected event"),
3821         };
3822         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
3823         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3824         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3825         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3826         assert_eq!(b_txn.len(), 3);
3827         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
3828         assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
3829         check_spends!(b_txn[0], commitment_tx[0].clone());
3830         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3831         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3832         assert_eq!(b_txn[2].lock_time, 0); // Success tx
3833
3834         check_closed_broadcast!(nodes[1]);
3835 }
3836
3837 #[test]
3838 fn test_duplicate_payment_hash_one_failure_one_success() {
3839         // Topology : A --> B --> C
3840         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
3841         let mut nodes = create_network(3);
3842
3843         create_announced_chan_between_nodes(&nodes, 0, 1);
3844         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3845
3846         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
3847         *nodes[0].network_payment_count.borrow_mut() -= 1;
3848         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
3849
3850         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3851         assert_eq!(commitment_txn[0].input.len(), 1);
3852         check_spends!(commitment_txn[0], chan_2.3.clone());
3853
3854         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3855         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3856         check_closed_broadcast!(nodes[1]);
3857
3858         let htlc_timeout_tx;
3859         { // Extract one of the two HTLC-Timeout transaction
3860                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3861                 assert_eq!(node_txn.len(), 7);
3862                 assert_eq!(node_txn[0], node_txn[5]);
3863                 assert_eq!(node_txn[1], node_txn[6]);
3864                 check_spends!(node_txn[0], commitment_txn[0].clone());
3865                 assert_eq!(node_txn[0].input.len(), 1);
3866                 check_spends!(node_txn[1], commitment_txn[0].clone());
3867                 assert_eq!(node_txn[1].input.len(), 1);
3868                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
3869                 check_spends!(node_txn[2], chan_2.3.clone());
3870                 check_spends!(node_txn[3], node_txn[2].clone());
3871                 check_spends!(node_txn[4], node_txn[2].clone());
3872                 htlc_timeout_tx = node_txn[1].clone();
3873         }
3874
3875         nodes[2].node.claim_funds(our_payment_preimage);
3876         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
3877         check_added_monitors!(nodes[2], 2);
3878         let events = nodes[2].node.get_and_clear_pending_msg_events();
3879         match events[0] {
3880                 MessageSendEvent::UpdateHTLCs { .. } => {},
3881                 _ => panic!("Unexpected event"),
3882         }
3883         match events[1] {
3884                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3885                 _ => panic!("Unexepected event"),
3886         }
3887         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
3888         assert_eq!(htlc_success_txn.len(), 5);
3889         check_spends!(htlc_success_txn[2], chan_2.3.clone());
3890         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
3891         assert_eq!(htlc_success_txn[0].input.len(), 1);
3892         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3893         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
3894         assert_eq!(htlc_success_txn[1].input.len(), 1);
3895         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3896         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
3897         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
3898         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
3899
3900         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
3901         expect_pending_htlcs_forwardable!(nodes[1]);
3902         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3903         assert!(htlc_updates.update_add_htlcs.is_empty());
3904         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
3905         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
3906         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
3907         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
3908         check_added_monitors!(nodes[1], 1);
3909
3910         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
3911         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3912         {
3913                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
3914                 let events = nodes[0].node.get_and_clear_pending_msg_events();
3915                 assert_eq!(events.len(), 1);
3916                 match events[0] {
3917                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
3918                         },
3919                         _ => { panic!("Unexpected event"); }
3920                 }
3921         }
3922         let events = nodes[0].node.get_and_clear_pending_events();
3923         match events[0] {
3924                 Event::PaymentFailed { ref payment_hash, .. } => {
3925                         assert_eq!(*payment_hash, duplicate_payment_hash);
3926                 }
3927                 _ => panic!("Unexpected event"),
3928         }
3929
3930         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
3931         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
3932         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3933         assert!(updates.update_add_htlcs.is_empty());
3934         assert!(updates.update_fail_htlcs.is_empty());
3935         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3936         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
3937         assert!(updates.update_fail_malformed_htlcs.is_empty());
3938         check_added_monitors!(nodes[1], 1);
3939
3940         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
3941         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
3942
3943         let events = nodes[0].node.get_and_clear_pending_events();
3944         match events[0] {
3945                 Event::PaymentSent { ref payment_preimage } => {
3946                         assert_eq!(*payment_preimage, our_payment_preimage);
3947                 }
3948                 _ => panic!("Unexpected event"),
3949         }
3950 }
3951
3952 #[test]
3953 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
3954         let nodes = create_network(2);
3955
3956         // Create some initial channels
3957         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3958
3959         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
3960         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3961         assert_eq!(local_txn[0].input.len(), 1);
3962         check_spends!(local_txn[0], chan_1.3.clone());
3963
3964         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
3965         nodes[1].node.claim_funds(payment_preimage);
3966         check_added_monitors!(nodes[1], 1);
3967         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3968         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
3969         let events = nodes[1].node.get_and_clear_pending_msg_events();
3970         match events[0] {
3971                 MessageSendEvent::UpdateHTLCs { .. } => {},
3972                 _ => panic!("Unexpected event"),
3973         }
3974         match events[1] {
3975                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3976                 _ => panic!("Unexepected event"),
3977         }
3978         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3979         assert_eq!(node_txn[0].input.len(), 1);
3980         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3981         check_spends!(node_txn[0], local_txn[0].clone());
3982
3983         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
3984         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3985         assert_eq!(spend_txn.len(), 2);
3986         check_spends!(spend_txn[0], node_txn[0].clone());
3987         check_spends!(spend_txn[1], node_txn[2].clone());
3988 }
3989
3990 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
3991         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
3992         // unrevoked commitment transaction.
3993         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
3994         // a remote RAA before they could be failed backwards (and combinations thereof).
3995         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
3996         // use the same payment hashes.
3997         // Thus, we use a six-node network:
3998         //
3999         // A \         / E
4000         //    - C - D -
4001         // B /         \ F
4002         // And test where C fails back to A/B when D announces its latest commitment transaction
4003         let nodes = create_network(6);
4004
4005         create_announced_chan_between_nodes(&nodes, 0, 2);
4006         create_announced_chan_between_nodes(&nodes, 1, 2);
4007         let chan = create_announced_chan_between_nodes(&nodes, 2, 3);
4008         create_announced_chan_between_nodes(&nodes, 3, 4);
4009         create_announced_chan_between_nodes(&nodes, 3, 5);
4010
4011         // Rebalance and check output sanity...
4012         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4013         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4014         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 2);
4015
4016         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4017         // 0th HTLC:
4018         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
4019         // 1st HTLC:
4020         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
4021         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();
4022         // 2nd HTLC:
4023         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
4024         // 3rd HTLC:
4025         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
4026         // 4th HTLC:
4027         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4028         // 5th HTLC:
4029         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4030         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4031         // 6th HTLC:
4032         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4033         // 7th HTLC:
4034         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4035
4036         // 8th HTLC:
4037         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4038         // 9th HTLC:
4039         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();
4040         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
4041
4042         // 10th HTLC:
4043         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
4044         // 11th HTLC:
4045         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4046         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4047
4048         // Double-check that six of the new HTLC were added
4049         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4050         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4051         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.len(), 1);
4052         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 8);
4053
4054         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4055         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4056         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4057         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4058         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4059         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4060         check_added_monitors!(nodes[4], 0);
4061         expect_pending_htlcs_forwardable!(nodes[4]);
4062         check_added_monitors!(nodes[4], 1);
4063
4064         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4065         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]).unwrap();
4066         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]).unwrap();
4067         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]).unwrap();
4068         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]).unwrap();
4069         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4070
4071         // Fail 3rd below-dust and 7th above-dust HTLCs
4072         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4073         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4074         check_added_monitors!(nodes[5], 0);
4075         expect_pending_htlcs_forwardable!(nodes[5]);
4076         check_added_monitors!(nodes[5], 1);
4077
4078         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4079         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]).unwrap();
4080         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]).unwrap();
4081         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4082
4083         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4084
4085         expect_pending_htlcs_forwardable!(nodes[3]);
4086         check_added_monitors!(nodes[3], 1);
4087         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4088         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]).unwrap();
4089         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]).unwrap();
4090         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]).unwrap();
4091         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]).unwrap();
4092         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]).unwrap();
4093         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]).unwrap();
4094         if deliver_last_raa {
4095                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4096         } else {
4097                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4098         }
4099
4100         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4101         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4102         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4103         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4104         //
4105         // We now broadcast the latest commitment transaction, which *should* result in failures for
4106         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4107         // the non-broadcast above-dust HTLCs.
4108         //
4109         // Alternatively, we may broadcast the previous commitment transaction, which should only
4110         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4111         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4112
4113         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4114         if announce_latest {
4115                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_last_commitment_tx[0]], &[1; 1]);
4116         } else {
4117                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&ds_prev_commitment_tx[0]], &[1; 1]);
4118         }
4119         connect_blocks(&nodes[2].chain_monitor, HTLC_FAIL_ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4120         check_closed_broadcast!(nodes[2]);
4121         expect_pending_htlcs_forwardable!(nodes[2]);
4122         check_added_monitors!(nodes[2], 2);
4123
4124         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4125         assert_eq!(cs_msgs.len(), 2);
4126         let mut a_done = false;
4127         for msg in cs_msgs {
4128                 match msg {
4129                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4130                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4131                                 // should be failed-backwards here.
4132                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4133                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4134                                         for htlc in &updates.update_fail_htlcs {
4135                                                 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 });
4136                                         }
4137                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4138                                         assert!(!a_done);
4139                                         a_done = true;
4140                                         &nodes[0]
4141                                 } else {
4142                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4143                                         for htlc in &updates.update_fail_htlcs {
4144                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4145                                         }
4146                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4147                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4148                                         &nodes[1]
4149                                 };
4150                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4151                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
4152                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]).unwrap();
4153                                 if announce_latest {
4154                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]).unwrap();
4155                                         if *node_id == nodes[0].node.get_our_node_id() {
4156                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]).unwrap();
4157                                         }
4158                                 }
4159                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4160                         },
4161                         _ => panic!("Unexpected event"),
4162                 }
4163         }
4164
4165         let as_events = nodes[0].node.get_and_clear_pending_events();
4166         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4167         let mut as_failds = HashSet::new();
4168         for event in as_events.iter() {
4169                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4170                         assert!(as_failds.insert(*payment_hash));
4171                         if *payment_hash != payment_hash_2 {
4172                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4173                         } else {
4174                                 assert!(!rejected_by_dest);
4175                         }
4176                 } else { panic!("Unexpected event"); }
4177         }
4178         assert!(as_failds.contains(&payment_hash_1));
4179         assert!(as_failds.contains(&payment_hash_2));
4180         if announce_latest {
4181                 assert!(as_failds.contains(&payment_hash_3));
4182                 assert!(as_failds.contains(&payment_hash_5));
4183         }
4184         assert!(as_failds.contains(&payment_hash_6));
4185
4186         let bs_events = nodes[1].node.get_and_clear_pending_events();
4187         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4188         let mut bs_failds = HashSet::new();
4189         for event in bs_events.iter() {
4190                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4191                         assert!(bs_failds.insert(*payment_hash));
4192                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4193                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4194                         } else {
4195                                 assert!(!rejected_by_dest);
4196                         }
4197                 } else { panic!("Unexpected event"); }
4198         }
4199         assert!(bs_failds.contains(&payment_hash_1));
4200         assert!(bs_failds.contains(&payment_hash_2));
4201         if announce_latest {
4202                 assert!(bs_failds.contains(&payment_hash_4));
4203         }
4204         assert!(bs_failds.contains(&payment_hash_5));
4205
4206         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4207         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4208         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4209         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4210         // PaymentFailureNetworkUpdates.
4211         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4212         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4213         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4214         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4215         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4216                 match event {
4217                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4218                         _ => panic!("Unexpected event"),
4219                 }
4220         }
4221 }
4222
4223 #[test]
4224 fn test_fail_backwards_latest_remote_announce_a() {
4225         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4226 }
4227
4228 #[test]
4229 fn test_fail_backwards_latest_remote_announce_b() {
4230         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4231 }
4232
4233 #[test]
4234 fn test_fail_backwards_previous_remote_announce() {
4235         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4236         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4237         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4238 }
4239
4240 #[test]
4241 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4242         let nodes = create_network(2);
4243
4244         // Create some initial channels
4245         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4246
4247         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4248         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4249         assert_eq!(local_txn[0].input.len(), 1);
4250         check_spends!(local_txn[0], chan_1.3.clone());
4251
4252         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4253         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4254         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4255         check_closed_broadcast!(nodes[0]);
4256
4257         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4258         assert_eq!(node_txn[0].input.len(), 1);
4259         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4260         check_spends!(node_txn[0], local_txn[0].clone());
4261
4262         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4263         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4264         assert_eq!(spend_txn.len(), 8);
4265         assert_eq!(spend_txn[0], spend_txn[2]);
4266         assert_eq!(spend_txn[0], spend_txn[4]);
4267         assert_eq!(spend_txn[0], spend_txn[6]);
4268         assert_eq!(spend_txn[1], spend_txn[3]);
4269         assert_eq!(spend_txn[1], spend_txn[5]);
4270         assert_eq!(spend_txn[1], spend_txn[7]);
4271         check_spends!(spend_txn[0], local_txn[0].clone());
4272         check_spends!(spend_txn[1], node_txn[0].clone());
4273 }
4274
4275 #[test]
4276 fn test_static_output_closing_tx() {
4277         let nodes = create_network(2);
4278
4279         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4280
4281         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4282         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4283
4284         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4285         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4286         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4287         assert_eq!(spend_txn.len(), 1);
4288         check_spends!(spend_txn[0], closing_tx.clone());
4289
4290         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4291         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4292         assert_eq!(spend_txn.len(), 1);
4293         check_spends!(spend_txn[0], closing_tx);
4294 }
4295
4296 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4297         let nodes = create_network(2);
4298         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4299
4300         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4301
4302         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4303         // present in B's local commitment transaction, but none of A's commitment transactions.
4304         assert!(nodes[1].node.claim_funds(our_payment_preimage));
4305         check_added_monitors!(nodes[1], 1);
4306
4307         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4308         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]).unwrap();
4309         let events = nodes[0].node.get_and_clear_pending_events();
4310         assert_eq!(events.len(), 1);
4311         match events[0] {
4312                 Event::PaymentSent { payment_preimage } => {
4313                         assert_eq!(payment_preimage, our_payment_preimage);
4314                 },
4315                 _ => panic!("Unexpected event"),
4316         }
4317
4318         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4319         check_added_monitors!(nodes[0], 1);
4320         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4321         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4322         check_added_monitors!(nodes[1], 1);
4323
4324         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4325         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4326                 nodes[1].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4327                 header.prev_blockhash = header.bitcoin_hash();
4328         }
4329         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4330         check_closed_broadcast!(nodes[1]);
4331 }
4332
4333 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4334         let mut nodes = create_network(2);
4335         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4336
4337         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();
4338         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4339         nodes[0].node.send_payment(route, payment_hash).unwrap();
4340         check_added_monitors!(nodes[0], 1);
4341
4342         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4343
4344         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4345         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4346         // to "time out" the HTLC.
4347
4348         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4349         for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4350                 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4351                 header.prev_blockhash = header.bitcoin_hash();
4352         }
4353         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4354         check_closed_broadcast!(nodes[0]);
4355 }
4356
4357 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4358         let nodes = create_network(3);
4359         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4360
4361         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4362         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4363         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4364         // actually revoked.
4365         let htlc_value = if use_dust { 50000 } else { 3000000 };
4366         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4367         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4368         expect_pending_htlcs_forwardable!(nodes[1]);
4369         check_added_monitors!(nodes[1], 1);
4370
4371         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4372         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]).unwrap();
4373         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4374         check_added_monitors!(nodes[0], 1);
4375         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4377         check_added_monitors!(nodes[1], 1);
4378         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1).unwrap();
4379         check_added_monitors!(nodes[1], 1);
4380         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4381
4382         if check_revoke_no_close {
4383                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4384                 check_added_monitors!(nodes[0], 1);
4385         }
4386
4387         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4388         for i in 1..TEST_FINAL_CLTV + HTLC_FAIL_TIMEOUT_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4389                 nodes[0].chain_monitor.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4390                 header.prev_blockhash = header.bitcoin_hash();
4391         }
4392         if !check_revoke_no_close {
4393                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4394                 check_closed_broadcast!(nodes[0]);
4395         } else {
4396                 let events = nodes[0].node.get_and_clear_pending_events();
4397                 assert_eq!(events.len(), 1);
4398                 match events[0] {
4399                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4400                                 assert_eq!(payment_hash, our_payment_hash);
4401                                 assert!(rejected_by_dest);
4402                         },
4403                         _ => panic!("Unexpected event"),
4404                 }
4405         }
4406 }
4407
4408 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4409 // There are only a few cases to test here:
4410 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4411 //    broadcastable commitment transactions result in channel closure,
4412 //  * its included in an unrevoked-but-previous remote commitment transaction,
4413 //  * its included in the latest remote or local commitment transactions.
4414 // We test each of the three possible commitment transactions individually and use both dust and
4415 // non-dust HTLCs.
4416 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4417 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4418 // tested for at least one of the cases in other tests.
4419 #[test]
4420 fn htlc_claim_single_commitment_only_a() {
4421         do_htlc_claim_local_commitment_only(true);
4422         do_htlc_claim_local_commitment_only(false);
4423
4424         do_htlc_claim_current_remote_commitment_only(true);
4425         do_htlc_claim_current_remote_commitment_only(false);
4426 }
4427
4428 #[test]
4429 fn htlc_claim_single_commitment_only_b() {
4430         do_htlc_claim_previous_remote_commitment_only(true, false);
4431         do_htlc_claim_previous_remote_commitment_only(false, false);
4432         do_htlc_claim_previous_remote_commitment_only(true, true);
4433         do_htlc_claim_previous_remote_commitment_only(false, true);
4434 }
4435
4436 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>)
4437         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4438                                 F2: FnMut(),
4439 {
4440         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);
4441 }
4442
4443 // test_case
4444 // 0: node1 fails backward
4445 // 1: final node fails backward
4446 // 2: payment completed but the user rejects the payment
4447 // 3: final node fails backward (but tamper onion payloads from node0)
4448 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4449 // 200: trigger error in the final node and tamper returning fail_htlc
4450 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>)
4451         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4452                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4453                                 F3: FnMut(),
4454 {
4455         use ln::msgs::HTLCFailChannelUpdate;
4456
4457         // reset block height
4458         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4459         for ix in 0..nodes.len() {
4460                 nodes[ix].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
4461         }
4462
4463         macro_rules! expect_event {
4464                 ($node: expr, $event_type: path) => {{
4465                         let events = $node.node.get_and_clear_pending_events();
4466                         assert_eq!(events.len(), 1);
4467                         match events[0] {
4468                                 $event_type { .. } => {},
4469                                 _ => panic!("Unexpected event"),
4470                         }
4471                 }}
4472         }
4473
4474         macro_rules! expect_htlc_forward {
4475                 ($node: expr) => {{
4476                         expect_event!($node, Event::PendingHTLCsForwardable);
4477                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4478                         $node.node.process_pending_htlc_forwards();
4479                 }}
4480         }
4481
4482         // 0 ~~> 2 send payment
4483         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4484         check_added_monitors!(nodes[0], 1);
4485         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4486         // temper update_add (0 => 1)
4487         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4488         if test_case == 0 || test_case == 3 || test_case == 100 {
4489                 callback_msg(&mut update_add_0);
4490                 callback_node();
4491         }
4492         // 0 => 1 update_add & CS
4493         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
4494         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4495
4496         let update_1_0 = match test_case {
4497                 0|100 => { // intermediate node failure; fail backward to 0
4498                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4499                         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));
4500                         update_1_0
4501                 },
4502                 1|2|3|200 => { // final node failure; forwarding to 2
4503                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4504                         // forwarding on 1
4505                         if test_case != 200 {
4506                                 callback_node();
4507                         }
4508                         expect_htlc_forward!(&nodes[1]);
4509
4510                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4511                         check_added_monitors!(&nodes[1], 1);
4512                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4513                         // tamper update_add (1 => 2)
4514                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4515                         if test_case != 3 && test_case != 200 {
4516                                 callback_msg(&mut update_add_1);
4517                         }
4518
4519                         // 1 => 2
4520                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
4521                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4522
4523                         if test_case == 2 || test_case == 200 {
4524                                 expect_htlc_forward!(&nodes[2]);
4525                                 expect_event!(&nodes[2], Event::PaymentReceived);
4526                                 callback_node();
4527                                 expect_pending_htlcs_forwardable!(nodes[2]);
4528                         }
4529
4530                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4531                         if test_case == 2 || test_case == 200 {
4532                                 check_added_monitors!(&nodes[2], 1);
4533                         }
4534                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4535
4536                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4537                         if test_case == 200 {
4538                                 callback_fail(&mut fail_msg);
4539                         }
4540
4541                         // 2 => 1
4542                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
4543                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4544
4545                         // backward fail on 1
4546                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4547                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4548                         update_1_0
4549                 },
4550                 _ => unreachable!(),
4551         };
4552
4553         // 1 => 0 commitment_signed_dance
4554         if update_1_0.update_fail_htlcs.len() > 0 {
4555                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4556                 if test_case == 100 {
4557                         callback_fail(&mut fail_msg);
4558                 }
4559                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
4560         } else {
4561                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
4562         };
4563
4564         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4565
4566         let events = nodes[0].node.get_and_clear_pending_events();
4567         assert_eq!(events.len(), 1);
4568         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4569                 assert_eq!(*rejected_by_dest, !expected_retryable);
4570                 assert_eq!(*error_code, expected_error_code);
4571         } else {
4572                 panic!("Uexpected event");
4573         }
4574
4575         let events = nodes[0].node.get_and_clear_pending_msg_events();
4576         if expected_channel_update.is_some() {
4577                 assert_eq!(events.len(), 1);
4578                 match events[0] {
4579                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4580                                 match update {
4581                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4582                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4583                                                         panic!("channel_update not found!");
4584                                                 }
4585                                         },
4586                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4587                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4588                                                         assert!(*short_channel_id == *expected_short_channel_id);
4589                                                         assert!(*is_permanent == *expected_is_permanent);
4590                                                 } else {
4591                                                         panic!("Unexpected message event");
4592                                                 }
4593                                         },
4594                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4595                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4596                                                         assert!(*node_id == *expected_node_id);
4597                                                         assert!(*is_permanent == *expected_is_permanent);
4598                                                 } else {
4599                                                         panic!("Unexpected message event");
4600                                                 }
4601                                         },
4602                                 }
4603                         },
4604                         _ => panic!("Unexpected message event"),
4605                 }
4606         } else {
4607                 assert_eq!(events.len(), 0);
4608         }
4609 }
4610
4611 impl msgs::ChannelUpdate {
4612         fn dummy() -> msgs::ChannelUpdate {
4613                 use secp256k1::ffi::Signature as FFISignature;
4614                 use secp256k1::Signature;
4615                 msgs::ChannelUpdate {
4616                         signature: Signature::from(FFISignature::new()),
4617                         contents: msgs::UnsignedChannelUpdate {
4618                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4619                                 short_channel_id: 0,
4620                                 timestamp: 0,
4621                                 flags: 0,
4622                                 cltv_expiry_delta: 0,
4623                                 htlc_minimum_msat: 0,
4624                                 fee_base_msat: 0,
4625                                 fee_proportional_millionths: 0,
4626                                 excess_data: vec![],
4627                         }
4628                 }
4629         }
4630 }
4631
4632 #[test]
4633 fn test_onion_failure() {
4634         use ln::msgs::ChannelUpdate;
4635         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4636         use secp256k1;
4637
4638         const BADONION: u16 = 0x8000;
4639         const PERM: u16 = 0x4000;
4640         const NODE: u16 = 0x2000;
4641         const UPDATE: u16 = 0x1000;
4642
4643         let mut nodes = create_network(3);
4644         for node in nodes.iter() {
4645                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4646         }
4647         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
4648         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4649         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4650         // positve case
4651         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
4652
4653         // intermediate node failure
4654         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4655                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4656                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4657                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4658                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4659                 onion_payloads[0].realm = 3;
4660                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4661         }, ||{}, 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
4662
4663         // final node failure
4664         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4665                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4666                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4667                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4668                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4669                 onion_payloads[1].realm = 3;
4670                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4671         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4672
4673         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4674         // receiving simulated fail messages
4675         // intermediate node failure
4676         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4677                 // trigger error
4678                 msg.amount_msat -= 1;
4679         }, |msg| {
4680                 // and tamper returning error message
4681                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4682                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4683                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4684         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4685
4686         // final node failure
4687         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4688                 // and tamper returning error message
4689                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4690                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4691                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4692         }, ||{
4693                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4694         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4695
4696         // intermediate node failure
4697         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4698                 msg.amount_msat -= 1;
4699         }, |msg| {
4700                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4701                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4702                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4703         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4704
4705         // final node failure
4706         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4707                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4708                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4709                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4710         }, ||{
4711                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4712         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4713
4714         // intermediate node failure
4715         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4716                 msg.amount_msat -= 1;
4717         }, |msg| {
4718                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4719                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4720                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4721         }, ||{
4722                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4723         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4724
4725         // final node failure
4726         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4727                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4728                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4729                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4730         }, ||{
4731                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4732         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4733
4734         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4735                 Some(BADONION|PERM|4), None);
4736
4737         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4738                 Some(BADONION|PERM|5), None);
4739
4740         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4741                 Some(BADONION|PERM|6), None);
4742
4743         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4744                 msg.amount_msat -= 1;
4745         }, |msg| {
4746                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4747                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4748                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4749         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4750
4751         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4752                 msg.amount_msat -= 1;
4753         }, |msg| {
4754                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4755                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4756                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4757                 // short_channel_id from the processing node
4758         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4759
4760         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4761                 msg.amount_msat -= 1;
4762         }, |msg| {
4763                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4764                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4765                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4766                 // short_channel_id from the processing node
4767         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4768
4769         let mut bogus_route = route.clone();
4770         bogus_route.hops[1].short_channel_id -= 1;
4771         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4772           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4773
4774         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4775         let mut bogus_route = route.clone();
4776         let route_len = bogus_route.hops.len();
4777         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
4778         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4779
4780         //TODO: with new config API, we will be able to generate both valid and
4781         //invalid channel_update cases.
4782         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
4783                 msg.amount_msat -= 1;
4784         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4785
4786         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
4787                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
4788                 msg.cltv_expiry -= 1;
4789         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4790
4791         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
4792                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4793                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4794                 nodes[1].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4795         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4796
4797         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
4798                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4799         }, false, Some(PERM|15), None);
4800
4801         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
4802                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - HTLC_FAIL_TIMEOUT_BLOCKS + 1;
4803                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4804                 nodes[2].chain_monitor.block_connected_checked(&header, height, &Vec::new()[..], &[0; 0]);
4805         }, || {}, true, Some(17), None);
4806
4807         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
4808                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4809                         for f in pending_forwards.iter_mut() {
4810                                 match f {
4811                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4812                                                 forward_info.outgoing_cltv_value += 1,
4813                                         _ => {},
4814                                 }
4815                         }
4816                 }
4817         }, true, Some(18), None);
4818
4819         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
4820                 // violate amt_to_forward > msg.amount_msat
4821                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4822                         for f in pending_forwards.iter_mut() {
4823                                 match f {
4824                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4825                                                 forward_info.amt_to_forward -= 1,
4826                                         _ => {},
4827                                 }
4828                         }
4829                 }
4830         }, true, Some(19), None);
4831
4832         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
4833                 // disconnect event to the channel between nodes[1] ~ nodes[2]
4834                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
4835                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4836         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4837         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4838
4839         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
4840                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4841                 let mut route = route.clone();
4842                 let height = 1;
4843                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
4844                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4845                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
4846                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4847                 msg.cltv_expiry = htlc_cltv;
4848                 msg.onion_routing_packet = onion_packet;
4849         }, ||{}, true, Some(21), None);
4850 }
4851
4852 #[test]
4853 #[should_panic]
4854 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
4855         let nodes = create_network(2);
4856         //Force duplicate channel ids
4857         for node in nodes.iter() {
4858                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
4859         }
4860
4861         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
4862         let channel_value_satoshis=10000;
4863         let push_msat=10001;
4864         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
4865         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4866         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &node0_to_1_send_open_channel).unwrap();
4867
4868         //Create a second channel with a channel_id collision
4869         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4870 }
4871
4872 #[test]
4873 fn bolt2_open_channel_sending_node_checks_part2() {
4874         let nodes = create_network(2);
4875
4876         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
4877         let channel_value_satoshis=2^24;
4878         let push_msat=10001;
4879         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4880
4881         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
4882         let channel_value_satoshis=10000;
4883         // Test when push_msat is equal to 1000 * funding_satoshis.
4884         let push_msat=1000*channel_value_satoshis+1;
4885         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
4886
4887         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
4888         let channel_value_satoshis=10000;
4889         let push_msat=10001;
4890         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
4891         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
4892         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
4893
4894         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
4895         // 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
4896         assert!(node0_to_1_send_open_channel.channel_flags<=1);
4897
4898         // 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.
4899         assert!(BREAKDOWN_TIMEOUT>0);
4900         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
4901
4902         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
4903         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
4904         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
4905
4906         // 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.
4907         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
4908         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
4909         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
4910         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
4911         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
4912 }
4913
4914 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
4915 // 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.
4916 //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.
4917
4918 #[test]
4919 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
4920         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
4921         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
4922         let mut nodes = create_network(2);
4923         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
4924         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4925         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4926
4927         route.hops[0].fee_msat = 0;
4928
4929         let err = nodes[0].node.send_payment(route, our_payment_hash);
4930
4931         if let Err(APIError::ChannelUnavailable{err}) = err {
4932                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
4933         } else {
4934                 assert!(false);
4935         }
4936 }
4937
4938 #[test]
4939 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
4940         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
4941         //It is enforced when constructing a route.
4942         let mut nodes = create_network(2);
4943         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0);
4944         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
4945         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4946
4947         let err = nodes[0].node.send_payment(route, our_payment_hash);
4948
4949         if let Err(APIError::RouteError{err}) = err {
4950                 assert_eq!(err, "Channel CLTV overflowed?!");
4951         } else {
4952                 assert!(false);
4953         }
4954 }
4955
4956 #[test]
4957 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
4958         //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.
4959         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
4960         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
4961         let mut nodes = create_network(2);
4962         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0);
4963         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
4964
4965         for i in 0..max_accepted_htlcs {
4966                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4967                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4968                 let payment_event = {
4969                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4970                         check_added_monitors!(nodes[0], 1);
4971
4972                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4973                         assert_eq!(events.len(), 1);
4974                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
4975                                 assert_eq!(htlcs[0].htlc_id, i);
4976                         } else {
4977                                 assert!(false);
4978                         }
4979                         SendEvent::from_event(events.remove(0))
4980                 };
4981                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4982                 check_added_monitors!(nodes[1], 0);
4983                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4984
4985                 expect_pending_htlcs_forwardable!(nodes[1]);
4986                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
4987         }
4988         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4989         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4990         let err = nodes[0].node.send_payment(route, our_payment_hash);
4991
4992         if let Err(APIError::ChannelUnavailable{err}) = err {
4993                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
4994         } else {
4995                 assert!(false);
4996         }
4997 }
4998
4999 #[test]
5000 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5001         //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.
5002         let mut nodes = create_network(2);
5003         let channel_value = 100000;
5004         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0);
5005         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5006
5007         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
5008
5009         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5010         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5011         let err = nodes[0].node.send_payment(route, our_payment_hash);
5012
5013         if let Err(APIError::ChannelUnavailable{err}) = err {
5014                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight");
5015         } else {
5016                 assert!(false);
5017         }
5018
5019         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
5020 }
5021
5022 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5023 #[test]
5024 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5025         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5026         let mut nodes = create_network(2);
5027         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5028         let htlc_minimum_msat: u64;
5029         {
5030                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5031                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5032                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5033         }
5034         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5035         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5036         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5037         check_added_monitors!(nodes[0], 1);
5038         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5039         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5040         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5041         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5042                 assert_eq!(err, "Remote side tried to send less than our minimum HTLC value");
5043         } else {
5044                 assert!(false);
5045         }
5046         assert!(nodes[1].node.list_channels().is_empty());
5047         check_closed_broadcast!(nodes[1]);
5048 }
5049
5050 #[test]
5051 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5052         //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
5053         let mut nodes = create_network(2);
5054         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5055
5056         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5057
5058         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5059         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5060         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5061         check_added_monitors!(nodes[0], 1);
5062         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5063
5064         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5065         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5066
5067         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5068                 assert_eq!(err, "Remote HTLC add would put them over their reserve value");
5069         } else {
5070                 assert!(false);
5071         }
5072
5073         assert!(nodes[1].node.list_channels().is_empty());
5074         check_closed_broadcast!(nodes[1]);
5075 }
5076
5077 #[test]
5078 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5079         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5080         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5081         let mut nodes = create_network(2);
5082         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5083         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5084         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5085
5086         let session_priv = SecretKey::from_slice(&{
5087                 let mut session_key = [0; 32];
5088                 rng::fill_bytes(&mut session_key);
5089                 session_key
5090         }).expect("RNG is bad!");
5091
5092         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5093         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5094         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5095         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5096
5097         let mut msg = msgs::UpdateAddHTLC {
5098                 channel_id: chan.2,
5099                 htlc_id: 0,
5100                 amount_msat: 1000,
5101                 payment_hash: our_payment_hash,
5102                 cltv_expiry: htlc_cltv,
5103                 onion_routing_packet: onion_packet.clone(),
5104         };
5105
5106         for i in 0..super::channel::OUR_MAX_HTLCS {
5107                 msg.htlc_id = i as u64;
5108                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).unwrap();
5109         }
5110         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5111         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5112
5113         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5114                 assert_eq!(err, "Remote tried to push more than our max accepted HTLCs");
5115         } else {
5116                 assert!(false);
5117         }
5118
5119         assert!(nodes[1].node.list_channels().is_empty());
5120         check_closed_broadcast!(nodes[1]);
5121 }
5122
5123 #[test]
5124 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5125         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5126         let mut nodes = create_network(2);
5127         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5128         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5129         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5130         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5131         check_added_monitors!(nodes[0], 1);
5132         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5133         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5134         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5135
5136         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5137                 assert_eq!(err,"Remote HTLC add would put them over their max HTLC value in flight");
5138         } else {
5139                 assert!(false);
5140         }
5141
5142         assert!(nodes[1].node.list_channels().is_empty());
5143         check_closed_broadcast!(nodes[1]);
5144 }
5145
5146 #[test]
5147 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5148         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5149         let mut nodes = create_network(2);
5150         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000);
5151         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5152         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5153         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5154         check_added_monitors!(nodes[0], 1);
5155         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5156         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5157         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5158
5159         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5160                 assert_eq!(err,"Remote provided CLTV expiry in seconds instead of block height");
5161         } else {
5162                 assert!(false);
5163         }
5164
5165         assert!(nodes[1].node.list_channels().is_empty());
5166         check_closed_broadcast!(nodes[1]);
5167 }
5168
5169 #[test]
5170 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5171         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5172         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5173         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5174         let mut nodes = create_network(2);
5175         create_announced_chan_between_nodes(&nodes, 0, 1);
5176         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5177         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5178         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5179         check_added_monitors!(nodes[0], 1);
5180         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5181         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5182
5183         //Disconnect and Reconnect
5184         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5185         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5186         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5187         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5188         assert_eq!(reestablish_1.len(), 1);
5189         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5190         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5191         assert_eq!(reestablish_2.len(), 1);
5192         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5193         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5194         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5195         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5196
5197         //Resend HTLC
5198         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5199         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5200         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
5201         check_added_monitors!(nodes[1], 1);
5202         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5203
5204         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5205         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5206                 assert_eq!(err, "Remote skipped HTLC ID");
5207         } else {
5208                 assert!(false);
5209         }
5210
5211         assert!(nodes[1].node.list_channels().is_empty());
5212         check_closed_broadcast!(nodes[1]);
5213 }
5214
5215 #[test]
5216 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5217         //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.
5218
5219         let mut nodes = create_network(2);
5220         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5221
5222         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5223         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5224         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5225         check_added_monitors!(nodes[0], 1);
5226         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5227         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5228
5229         let update_msg = msgs::UpdateFulfillHTLC{
5230                 channel_id: chan.2,
5231                 htlc_id: 0,
5232                 payment_preimage: our_payment_preimage,
5233         };
5234
5235         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5236
5237         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5238                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5239         } else {
5240                 assert!(false);
5241         }
5242
5243         assert!(nodes[0].node.list_channels().is_empty());
5244         check_closed_broadcast!(nodes[0]);
5245 }
5246
5247 #[test]
5248 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5249         //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.
5250
5251         let mut nodes = create_network(2);
5252         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5253
5254         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5255         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5256         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5257         check_added_monitors!(nodes[0], 1);
5258         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5259         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5260
5261         let update_msg = msgs::UpdateFailHTLC{
5262                 channel_id: chan.2,
5263                 htlc_id: 0,
5264                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5265         };
5266
5267         let err = nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5268
5269         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5270                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5271         } else {
5272                 assert!(false);
5273         }
5274
5275         assert!(nodes[0].node.list_channels().is_empty());
5276         check_closed_broadcast!(nodes[0]);
5277 }
5278
5279 #[test]
5280 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5281         //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.
5282
5283         let mut nodes = create_network(2);
5284         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
5285
5286         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5287         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5288         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5289         check_added_monitors!(nodes[0], 1);
5290         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5291         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5292
5293         let update_msg = msgs::UpdateFailMalformedHTLC{
5294                 channel_id: chan.2,
5295                 htlc_id: 0,
5296                 sha256_of_onion: [1; 32],
5297                 failure_code: 0x8000,
5298         };
5299
5300         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5301
5302         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5303                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5304         } else {
5305                 assert!(false);
5306         }
5307
5308         assert!(nodes[0].node.list_channels().is_empty());
5309         check_closed_broadcast!(nodes[0]);
5310 }
5311
5312 #[test]
5313 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5314         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5315
5316         let nodes = create_network(2);
5317         create_announced_chan_between_nodes(&nodes, 0, 1);
5318
5319         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5320
5321         nodes[1].node.claim_funds(our_payment_preimage);
5322         check_added_monitors!(nodes[1], 1);
5323
5324         let events = nodes[1].node.get_and_clear_pending_msg_events();
5325         assert_eq!(events.len(), 1);
5326         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5327                 match events[0] {
5328                         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, .. } } => {
5329                                 assert!(update_add_htlcs.is_empty());
5330                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5331                                 assert!(update_fail_htlcs.is_empty());
5332                                 assert!(update_fail_malformed_htlcs.is_empty());
5333                                 assert!(update_fee.is_none());
5334                                 update_fulfill_htlcs[0].clone()
5335                         },
5336                         _ => panic!("Unexpected event"),
5337                 }
5338         };
5339
5340         update_fulfill_msg.htlc_id = 1;
5341
5342         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5343         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5344                 assert_eq!(err, "Remote tried to fulfill/fail an HTLC we couldn't find");
5345         } else {
5346                 assert!(false);
5347         }
5348
5349         assert!(nodes[0].node.list_channels().is_empty());
5350         check_closed_broadcast!(nodes[0]);
5351 }
5352
5353 #[test]
5354 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5355         //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.
5356
5357         let nodes = create_network(2);
5358         create_announced_chan_between_nodes(&nodes, 0, 1);
5359
5360         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5361
5362         nodes[1].node.claim_funds(our_payment_preimage);
5363         check_added_monitors!(nodes[1], 1);
5364
5365         let events = nodes[1].node.get_and_clear_pending_msg_events();
5366         assert_eq!(events.len(), 1);
5367         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5368                 match events[0] {
5369                         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, .. } } => {
5370                                 assert!(update_add_htlcs.is_empty());
5371                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5372                                 assert!(update_fail_htlcs.is_empty());
5373                                 assert!(update_fail_malformed_htlcs.is_empty());
5374                                 assert!(update_fee.is_none());
5375                                 update_fulfill_htlcs[0].clone()
5376                         },
5377                         _ => panic!("Unexpected event"),
5378                 }
5379         };
5380
5381         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5382
5383         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5384         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5385                 assert_eq!(err, "Remote tried to fulfill HTLC with an incorrect preimage");
5386         } else {
5387                 assert!(false);
5388         }
5389
5390         assert!(nodes[0].node.list_channels().is_empty());
5391         check_closed_broadcast!(nodes[0]);
5392 }
5393
5394
5395 #[test]
5396 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5397         //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.
5398
5399         let mut nodes = create_network(2);
5400         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5401         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5402         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5403         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5404         check_added_monitors!(nodes[0], 1);
5405
5406         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5407         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5408
5409         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5410         check_added_monitors!(nodes[1], 0);
5411         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5412
5413         let events = nodes[1].node.get_and_clear_pending_msg_events();
5414
5415         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5416                 match events[0] {
5417                         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, .. } } => {
5418                                 assert!(update_add_htlcs.is_empty());
5419                                 assert!(update_fulfill_htlcs.is_empty());
5420                                 assert!(update_fail_htlcs.is_empty());
5421                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5422                                 assert!(update_fee.is_none());
5423                                 update_fail_malformed_htlcs[0].clone()
5424                         },
5425                         _ => panic!("Unexpected event"),
5426                 }
5427         };
5428         update_msg.failure_code &= !0x8000;
5429         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5430         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::SendErrorMessage {..})}) = err {
5431                 assert_eq!(err, "Got update_fail_malformed_htlc with BADONION not set");
5432         } else {
5433                 assert!(false);
5434         }
5435
5436         assert!(nodes[0].node.list_channels().is_empty());
5437         check_closed_broadcast!(nodes[0]);
5438 }
5439
5440 #[test]
5441 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5442         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5443         //    * 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.
5444
5445         let mut nodes = create_network(3);
5446         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
5447         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000);
5448
5449         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5450         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5451
5452         //First hop
5453         let mut payment_event = {
5454                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5455                 check_added_monitors!(nodes[0], 1);
5456                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5457                 assert_eq!(events.len(), 1);
5458                 SendEvent::from_event(events.remove(0))
5459         };
5460         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5461         check_added_monitors!(nodes[1], 0);
5462         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5463         expect_pending_htlcs_forwardable!(nodes[1]);
5464         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5465         assert_eq!(events_2.len(), 1);
5466         check_added_monitors!(nodes[1], 1);
5467         payment_event = SendEvent::from_event(events_2.remove(0));
5468         assert_eq!(payment_event.msgs.len(), 1);
5469
5470         //Second Hop
5471         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5472         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5473         check_added_monitors!(nodes[2], 0);
5474         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5475
5476         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5477         assert_eq!(events_3.len(), 1);
5478         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5479                 match events_3[0] {
5480                         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 } } => {
5481                                 assert!(update_add_htlcs.is_empty());
5482                                 assert!(update_fulfill_htlcs.is_empty());
5483                                 assert!(update_fail_htlcs.is_empty());
5484                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5485                                 assert!(update_fee.is_none());
5486                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5487                         },
5488                         _ => panic!("Unexpected event"),
5489                 }
5490         };
5491
5492         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0).unwrap();
5493
5494         check_added_monitors!(nodes[1], 0);
5495         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5496         expect_pending_htlcs_forwardable!(nodes[1]);
5497         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5498         assert_eq!(events_4.len(), 1);
5499
5500         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5501         match events_4[0] {
5502                 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, .. } } => {
5503                         assert!(update_add_htlcs.is_empty());
5504                         assert!(update_fulfill_htlcs.is_empty());
5505                         assert_eq!(update_fail_htlcs.len(), 1);
5506                         assert!(update_fail_malformed_htlcs.is_empty());
5507                         assert!(update_fee.is_none());
5508                 },
5509                 _ => panic!("Unexpected event"),
5510         };
5511
5512         check_added_monitors!(nodes[1], 1);
5513 }