_ Git - rust-lightning/blob - lightning/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::keysinterface::{KeysInterface, SpendableOutputDescriptor};
   7 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
   9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  11 use ln::channel::{Channel, ChannelError};
  12 use ln::onion_utils;
  13 use ln::router::{Route, RouteHop};
  14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  17 use util::enforcing_trait_impls::EnforcingChannelKeys;
  18 use util::test_utils;
  19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  20 use util::errors::APIError;
  21 use util::ser::{Writeable, Writer, ReadableArgs};
  22 use util::config::UserConfig;
  23 use util::logger::Logger;
  24
  25 use bitcoin::util::hash::BitcoinHash;
  26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::util::bip143;
  28 use bitcoin::util::address::Address;
  29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  30 use bitcoin::blockdata::block::{Block, BlockHeader};
  31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  32 use bitcoin::blockdata::script::{Builder, Script};
  33 use bitcoin::blockdata::opcodes;
  34 use bitcoin::blockdata::constants::genesis_block;
  35 use bitcoin::network::constants::Network;
  36
  37 use bitcoin_hashes::sha256::Hash as Sha256;
  38 use bitcoin_hashes::Hash;
  39
  40 use secp256k1::{Secp256k1, Message};
  41 use secp256k1::key::{PublicKey,SecretKey};
  42
  43 use std::collections::{BTreeSet, HashMap, HashSet};
  44 use std::default::Default;
  45 use std::sync::{Arc, Mutex};
  46 use std::sync::atomic::Ordering;
  47 use std::{mem, io};
  48
  49 use rand::{thread_rng, Rng};
  50
  51 use ln::functional_test_utils::*;
  52
  53 #[test]
  54 fn test_insane_channel_opens() {
  55         // Stand up a network of 2 nodes
  56         let node_cfgs = create_node_cfgs(2);
  57         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  58         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  59
  60         // Instantiate channel parameters where we push the maximum msats given our
  61         // funding satoshis
  62         let channel_value_sat = 31337; // same as funding satoshis
  63         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  64         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  65
  66         // Have node0 initiate a channel to node1 with aforementioned parameters
  67         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
  68
  69         // Extract the channel open message from node0 to node1
  70         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  71
  72         // Test helper that asserts we get the correct error string given a mutator
  73         // that supposedly makes the channel open message insane
  74         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  75                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  76                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  77                 assert_eq!(msg_events.len(), 1);
  78                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  79                         match action {
  80                                 &ErrorAction::SendErrorMessage { .. } => {
  81                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  82                                 },
  83                                 _ => panic!("unexpected event!"),
  84                         }
  85                 } else { assert!(false); }
  86         };
  87
  88         use ln::channel::MAX_FUNDING_SATOSHIS;
  89         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  90
  91         // Test all mutations that would make the channel open message insane
  92         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  93
  94         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  95
  96         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  97
  98         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
  99
 100         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 101
 102         insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 103
 104         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 105
 106         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 107
 108         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 109 }
 110
 111 #[test]
 112 fn test_async_inbound_update_fee() {
 113         let node_cfgs = create_node_cfgs(2);
 114         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 115         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 116         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 117         let channel_id = chan.2;
 118
 119         // balancing
 120         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 121
 122         // A                                        B
 123         // update_fee                            ->
 124         // send (1) commitment_signed            -.
 125         //                                       <- update_add_htlc/commitment_signed
 126         // send (2) RAA (awaiting remote revoke) -.
 127         // (1) commitment_signed is delivered    ->
 128         //                                       .- send (3) RAA (awaiting remote revoke)
 129         // (2) RAA is delivered                  ->
 130         //                                       .- send (4) commitment_signed
 131         //                                       <- (3) RAA is delivered
 132         // send (5) commitment_signed            -.
 133         //                                       <- (4) commitment_signed is delivered
 134         // send (6) RAA                          -.
 135         // (5) commitment_signed is delivered    ->
 136         //                                       <- RAA
 137         // (6) RAA is delivered                  ->
 138
 139         // First nodes[0] generates an update_fee
 140         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 141         check_added_monitors!(nodes[0], 1);
 142
 143         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 144         assert_eq!(events_0.len(), 1);
 145         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 146                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 147                         (update_fee.as_ref(), commitment_signed)
 148                 },
 149                 _ => panic!("Unexpected event"),
 150         };
 151
 152         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 153
 154         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 155         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 156         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, None).unwrap();
 157         check_added_monitors!(nodes[1], 1);
 158
 159         let payment_event = {
 160                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 161                 assert_eq!(events_1.len(), 1);
 162                 SendEvent::from_event(events_1.remove(0))
 163         };
 164         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 165         assert_eq!(payment_event.msgs.len(), 1);
 166
 167         // ...now when the messages get delivered everyone should be happy
 168         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 169         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 170         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 171         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 172         check_added_monitors!(nodes[0], 1);
 173
 174         // deliver(1), generate (3):
 175         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 176         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 177         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 178         check_added_monitors!(nodes[1], 1);
 179
 180         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 181         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 182         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 183         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 184         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 185         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 186         assert!(bs_update.update_fee.is_none()); // (4)
 187         check_added_monitors!(nodes[1], 1);
 188
 189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 190         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 191         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 192         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 193         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 194         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 195         assert!(as_update.update_fee.is_none()); // (5)
 196         check_added_monitors!(nodes[0], 1);
 197
 198         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 199         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 200         // only (6) so get_event_msg's assert(len == 1) passes
 201         check_added_monitors!(nodes[0], 1);
 202
 203         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 204         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 205         check_added_monitors!(nodes[1], 1);
 206
 207         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 208         check_added_monitors!(nodes[0], 1);
 209
 210         let events_2 = nodes[0].node.get_and_clear_pending_events();
 211         assert_eq!(events_2.len(), 1);
 212         match events_2[0] {
 213                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 214                 _ => panic!("Unexpected event"),
 215         }
 216
 217         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 218         check_added_monitors!(nodes[1], 1);
 219 }
 220
 221 #[test]
 222 fn test_update_fee_unordered_raa() {
 223         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 224         // crash in an earlier version of the update_fee patch)
 225         let node_cfgs = create_node_cfgs(2);
 226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 228         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 229         let channel_id = chan.2;
 230
 231         // balancing
 232         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 233
 234         // First nodes[0] generates an update_fee
 235         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 236         check_added_monitors!(nodes[0], 1);
 237
 238         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 239         assert_eq!(events_0.len(), 1);
 240         let update_msg = match events_0[0] { // (1)
 241                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 242                         update_fee.as_ref()
 243                 },
 244                 _ => panic!("Unexpected event"),
 245         };
 246
 247         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 248
 249         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 250         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 251         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, None).unwrap();
 252         check_added_monitors!(nodes[1], 1);
 253
 254         let payment_event = {
 255                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 256                 assert_eq!(events_1.len(), 1);
 257                 SendEvent::from_event(events_1.remove(0))
 258         };
 259         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 260         assert_eq!(payment_event.msgs.len(), 1);
 261
 262         // ...now when the messages get delivered everyone should be happy
 263         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 264         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 265         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 266         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 267         check_added_monitors!(nodes[0], 1);
 268
 269         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 270         check_added_monitors!(nodes[1], 1);
 271
 272         // We can't continue, sadly, because our (1) now has a bogus signature
 273 }
 274
 275 #[test]
 276 fn test_multi_flight_update_fee() {
 277         let node_cfgs = create_node_cfgs(2);
 278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 279         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 280         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 281         let channel_id = chan.2;
 282
 283         // A                                        B
 284         // update_fee/commitment_signed          ->
 285         //                                       .- send (1) RAA and (2) commitment_signed
 286         // update_fee (never committed)          ->
 287         // (3) update_fee                        ->
 288         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 289         // don't track which updates correspond to which revoke_and_ack responses so we're in
 290         // AwaitingRAA mode and will not generate the update_fee yet.
 291         //                                       <- (1) RAA delivered
 292         // (3) is generated and send (4) CS      -.
 293         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 294         // know the per_commitment_point to use for it.
 295         //                                       <- (2) commitment_signed delivered
 296         // revoke_and_ack                        ->
 297         //                                          B should send no response here
 298         // (4) commitment_signed delivered       ->
 299         //                                       <- RAA/commitment_signed delivered
 300         // revoke_and_ack                        ->
 301
 302         // First nodes[0] generates an update_fee
 303         let initial_feerate = get_feerate!(nodes[0], channel_id);
 304         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 305         check_added_monitors!(nodes[0], 1);
 306
 307         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 308         assert_eq!(events_0.len(), 1);
 309         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 310                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 311                         (update_fee.as_ref().unwrap(), commitment_signed)
 312                 },
 313                 _ => panic!("Unexpected event"),
 314         };
 315
 316         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 317         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 318         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 319         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 320         check_added_monitors!(nodes[1], 1);
 321
 322         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 323         // transaction:
 324         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 325         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 326         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 327
 328         // Create the (3) update_fee message that nodes[0] will generate before it does...
 329         let mut update_msg_2 = msgs::UpdateFee {
 330                 channel_id: update_msg_1.channel_id.clone(),
 331                 feerate_per_kw: (initial_feerate + 30) as u32,
 332         };
 333
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 335
 336         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 337         // Deliver (3)
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 339
 340         // Deliver (1), generating (3) and (4)
 341         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 342         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 343         check_added_monitors!(nodes[0], 1);
 344         assert!(as_second_update.update_add_htlcs.is_empty());
 345         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 346         assert!(as_second_update.update_fail_htlcs.is_empty());
 347         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 348         // Check that the update_fee newly generated matches what we delivered:
 349         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 350         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 351
 352         // Deliver (2) commitment_signed
 353         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 354         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 355         check_added_monitors!(nodes[0], 1);
 356         // No commitment_signed so get_event_msg's assert(len == 1) passes
 357
 358         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 359         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 360         check_added_monitors!(nodes[1], 1);
 361
 362         // Delever (4)
 363         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 364         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 365         check_added_monitors!(nodes[1], 1);
 366
 367         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 368         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 369         check_added_monitors!(nodes[0], 1);
 370
 371         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 372         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374         check_added_monitors!(nodes[0], 1);
 375
 376         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 377         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 378         check_added_monitors!(nodes[1], 1);
 379 }
 380
 381 #[test]
 382 fn test_update_fee_vanilla() {
 383         let node_cfgs = create_node_cfgs(2);
 384         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 385         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 386         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 387         let channel_id = chan.2;
 388
 389         let feerate = get_feerate!(nodes[0], channel_id);
 390         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 391         check_added_monitors!(nodes[0], 1);
 392
 393         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 394         assert_eq!(events_0.len(), 1);
 395         let (update_msg, commitment_signed) = match events_0[0] {
 396                         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 } } => {
 397                         (update_fee.as_ref(), commitment_signed)
 398                 },
 399                 _ => panic!("Unexpected event"),
 400         };
 401         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 402
 403         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 404         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 405         check_added_monitors!(nodes[1], 1);
 406
 407         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 408         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 409         check_added_monitors!(nodes[0], 1);
 410
 411         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 412         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 413         // No commitment_signed so get_event_msg's assert(len == 1) passes
 414         check_added_monitors!(nodes[0], 1);
 415
 416         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 417         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 418         check_added_monitors!(nodes[1], 1);
 419 }
 420
 421 #[test]
 422 fn test_update_fee_that_funder_cannot_afford() {
 423         let node_cfgs = create_node_cfgs(2);
 424         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 425         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 426         let channel_value = 1888;
 427         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 428         let channel_id = chan.2;
 429
 430         let feerate = 260;
 431         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 432         check_added_monitors!(nodes[0], 1);
 433         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 434
 435         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 436
 437         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 438
 439         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 440         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 441         {
 442                 let mut chan_lock = nodes[1].node.channel_state.lock().unwrap();
 443                 let chan = chan_lock.by_id.get_mut(&channel_id).unwrap();
 444
 445                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 446                 let num_htlcs = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.len() - 2;
 447                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 448                 let mut actual_fee = chan.channel_monitor().get_latest_local_commitment_txn()[0].output.iter().fold(0, |acc, output| acc + output.value);
 449                 actual_fee = channel_value - actual_fee;
 450                 assert_eq!(total_fee, actual_fee);
 451         } //drop the mutex
 452
 453         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 454         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 455         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 456         check_added_monitors!(nodes[0], 1);
 457
 458         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 459
 460         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 461
 462         //While producing the commitment_signed response after handling a received update_fee request the
 463         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 464         //Should produce and error.
 465         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 466         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 467
 468         //clear the message we could not handle
 469         nodes[1].node.get_and_clear_pending_msg_events();
 470 }
 471
 472 #[test]
 473 fn test_update_fee_with_fundee_update_add_htlc() {
 474         let node_cfgs = create_node_cfgs(2);
 475         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 476         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 477         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 478         let channel_id = chan.2;
 479
 480         // balancing
 481         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 482
 483         let feerate = get_feerate!(nodes[0], channel_id);
 484         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 485         check_added_monitors!(nodes[0], 1);
 486
 487         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 488         assert_eq!(events_0.len(), 1);
 489         let (update_msg, commitment_signed) = match events_0[0] {
 490                         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 } } => {
 491                         (update_fee.as_ref(), commitment_signed)
 492                 },
 493                 _ => panic!("Unexpected event"),
 494         };
 495         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 496         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 497         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 498         check_added_monitors!(nodes[1], 1);
 499
 500         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 501
 502         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 503
 504         // nothing happens since node[1] is in AwaitingRemoteRevoke
 505         nodes[1].node.send_payment(route, our_payment_hash, None).unwrap();
 506         {
 507                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 508                 assert_eq!(added_monitors.len(), 0);
 509                 added_monitors.clear();
 510         }
 511         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 512         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 513         // node[1] has nothing to do
 514
 515         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 516         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 517         check_added_monitors!(nodes[0], 1);
 518
 519         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 520         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 521         // No commitment_signed so get_event_msg's assert(len == 1) passes
 522         check_added_monitors!(nodes[0], 1);
 523         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 524         check_added_monitors!(nodes[1], 1);
 525         // AwaitingRemoteRevoke ends here
 526
 527         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 528         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 529         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 530         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 531         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 532         assert_eq!(commitment_update.update_fee.is_none(), true);
 533
 534         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 535         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 536         check_added_monitors!(nodes[0], 1);
 537         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 538
 539         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 540         check_added_monitors!(nodes[1], 1);
 541         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 542
 543         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 544         check_added_monitors!(nodes[1], 1);
 545         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 546         // No commitment_signed so get_event_msg's assert(len == 1) passes
 547
 548         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 549         check_added_monitors!(nodes[0], 1);
 550         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 551
 552         expect_pending_htlcs_forwardable!(nodes[0]);
 553
 554         let events = nodes[0].node.get_and_clear_pending_events();
 555         assert_eq!(events.len(), 1);
 556         match events[0] {
 557                 Event::PaymentReceived { .. } => { },
 558                 _ => panic!("Unexpected event"),
 559         };
 560
 561         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 562
 563         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 564         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 565         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 566 }
 567
 568 #[test]
 569 fn test_update_fee() {
 570         let node_cfgs = create_node_cfgs(2);
 571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 572         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 573         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 574         let channel_id = chan.2;
 575
 576         // A                                        B
 577         // (1) update_fee/commitment_signed      ->
 578         //                                       <- (2) revoke_and_ack
 579         //                                       .- send (3) commitment_signed
 580         // (4) update_fee/commitment_signed      ->
 581         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 582         //                                       <- (3) commitment_signed delivered
 583         // send (6) revoke_and_ack               -.
 584         //                                       <- (5) deliver revoke_and_ack
 585         // (6) deliver revoke_and_ack            ->
 586         //                                       .- send (7) commitment_signed in response to (4)
 587         //                                       <- (7) deliver commitment_signed
 588         // revoke_and_ack                        ->
 589
 590         // Create and deliver (1)...
 591         let feerate = get_feerate!(nodes[0], channel_id);
 592         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 593         check_added_monitors!(nodes[0], 1);
 594
 595         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 596         assert_eq!(events_0.len(), 1);
 597         let (update_msg, commitment_signed) = match events_0[0] {
 598                         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 } } => {
 599                         (update_fee.as_ref(), commitment_signed)
 600                 },
 601                 _ => panic!("Unexpected event"),
 602         };
 603         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 604
 605         // Generate (2) and (3):
 606         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 607         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 608         check_added_monitors!(nodes[1], 1);
 609
 610         // Deliver (2):
 611         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 612         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 613         check_added_monitors!(nodes[0], 1);
 614
 615         // Create and deliver (4)...
 616         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 617         check_added_monitors!(nodes[0], 1);
 618         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 619         assert_eq!(events_0.len(), 1);
 620         let (update_msg, commitment_signed) = match events_0[0] {
 621                         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 } } => {
 622                         (update_fee.as_ref(), commitment_signed)
 623                 },
 624                 _ => panic!("Unexpected event"),
 625         };
 626
 627         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 628         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 629         check_added_monitors!(nodes[1], 1);
 630         // ... creating (5)
 631         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 632         // No commitment_signed so get_event_msg's assert(len == 1) passes
 633
 634         // Handle (3), creating (6):
 635         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 636         check_added_monitors!(nodes[0], 1);
 637         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 638         // No commitment_signed so get_event_msg's assert(len == 1) passes
 639
 640         // Deliver (5):
 641         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 642         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 643         check_added_monitors!(nodes[0], 1);
 644
 645         // Deliver (6), creating (7):
 646         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 647         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         assert!(commitment_update.update_add_htlcs.is_empty());
 649         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 650         assert!(commitment_update.update_fail_htlcs.is_empty());
 651         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 652         assert!(commitment_update.update_fee.is_none());
 653         check_added_monitors!(nodes[1], 1);
 654
 655         // Deliver (7)
 656         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 657         check_added_monitors!(nodes[0], 1);
 658         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 659         // No commitment_signed so get_event_msg's assert(len == 1) passes
 660
 661         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 662         check_added_monitors!(nodes[1], 1);
 663         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 664
 665         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 666         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 667         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 668 }
 669
 670 #[test]
 671 fn pre_funding_lock_shutdown_test() {
 672         // Test sending a shutdown prior to funding_locked after funding generation
 673         let node_cfgs = create_node_cfgs(2);
 674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 675         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 676         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 677         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 678         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 679         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 680
 681         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 682         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 683         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 684         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 685         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 686
 687         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 688         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 689         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 690         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 691         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 692         assert!(node_0_none.is_none());
 693
 694         assert!(nodes[0].node.list_channels().is_empty());
 695         assert!(nodes[1].node.list_channels().is_empty());
 696 }
 697
 698 #[test]
 699 fn updates_shutdown_wait() {
 700         // Test sending a shutdown with outstanding updates pending
 701         let node_cfgs = create_node_cfgs(3);
 702         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 703         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 704         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 705         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 706         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 707         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 708
 709         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 710
 711         nodes[0].node.close_channel(&chan_1.2).unwrap();
 712         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 713         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 714         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 715         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 716
 717         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 718         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 719
 720         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 721         unwrap_send_err!(nodes[0].node.send_payment(route_1, payment_hash, None), true, APIError::ChannelUnavailable {..}, {});
 722         unwrap_send_err!(nodes[1].node.send_payment(route_2, payment_hash, None), true, APIError::ChannelUnavailable {..}, {});
 723
 724         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 725         check_added_monitors!(nodes[2], 1);
 726         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 727         assert!(updates.update_add_htlcs.is_empty());
 728         assert!(updates.update_fail_htlcs.is_empty());
 729         assert!(updates.update_fail_malformed_htlcs.is_empty());
 730         assert!(updates.update_fee.is_none());
 731         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 732         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 733         check_added_monitors!(nodes[1], 1);
 734         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 735         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 736
 737         assert!(updates_2.update_add_htlcs.is_empty());
 738         assert!(updates_2.update_fail_htlcs.is_empty());
 739         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 740         assert!(updates_2.update_fee.is_none());
 741         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 742         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 743         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 744
 745         let events = nodes[0].node.get_and_clear_pending_events();
 746         assert_eq!(events.len(), 1);
 747         match events[0] {
 748                 Event::PaymentSent { ref payment_preimage } => {
 749                         assert_eq!(our_payment_preimage, *payment_preimage);
 750                 },
 751                 _ => panic!("Unexpected event"),
 752         }
 753
 754         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 755         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 756         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 757         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 758         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 759         assert!(node_0_none.is_none());
 760
 761         assert!(nodes[0].node.list_channels().is_empty());
 762
 763         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 764         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 765         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 766         assert!(nodes[1].node.list_channels().is_empty());
 767         assert!(nodes[2].node.list_channels().is_empty());
 768 }
 769
 770 #[test]
 771 fn htlc_fail_async_shutdown() {
 772         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 773         let node_cfgs = create_node_cfgs(3);
 774         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 775         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 776         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 777         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 778
 779         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 780         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 781         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
 782         check_added_monitors!(nodes[0], 1);
 783         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 784         assert_eq!(updates.update_add_htlcs.len(), 1);
 785         assert!(updates.update_fulfill_htlcs.is_empty());
 786         assert!(updates.update_fail_htlcs.is_empty());
 787         assert!(updates.update_fail_malformed_htlcs.is_empty());
 788         assert!(updates.update_fee.is_none());
 789
 790         nodes[1].node.close_channel(&chan_1.2).unwrap();
 791         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 792         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 793         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 794
 795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 796         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 797         check_added_monitors!(nodes[1], 1);
 798         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 799         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 800
 801         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 802         assert!(updates_2.update_add_htlcs.is_empty());
 803         assert!(updates_2.update_fulfill_htlcs.is_empty());
 804         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 805         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 806         assert!(updates_2.update_fee.is_none());
 807
 808         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 809         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 810
 811         let events = nodes[0].node.get_and_clear_pending_events();
 812         assert_eq!(events.len(), 1);
 813         match events[0] {
 814                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 815                         assert_eq!(our_payment_hash, *payment_hash);
 816                         assert!(!rejected_by_dest);
 817                 },
 818                 _ => panic!("Unexpected event"),
 819         }
 820
 821         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 822         assert_eq!(msg_events.len(), 2);
 823         let node_0_closing_signed = match msg_events[0] {
 824                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 825                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 826                         (*msg).clone()
 827                 },
 828                 _ => panic!("Unexpected event"),
 829         };
 830         match msg_events[1] {
 831                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 832                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 833                 },
 834                 _ => panic!("Unexpected event"),
 835         }
 836
 837         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 838         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 839         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 840         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 841         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 842         assert!(node_0_none.is_none());
 843
 844         assert!(nodes[0].node.list_channels().is_empty());
 845
 846         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 847         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 848         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 849         assert!(nodes[1].node.list_channels().is_empty());
 850         assert!(nodes[2].node.list_channels().is_empty());
 851 }
 852
 853 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 854         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 855         // messages delivered prior to disconnect
 856         let node_cfgs = create_node_cfgs(3);
 857         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 858         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 859         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 860         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 861
 862         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 863
 864         nodes[1].node.close_channel(&chan_1.2).unwrap();
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         if recv_count > 0 {
 867                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 868                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 869                 if recv_count > 1 {
 870                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 871                 }
 872         }
 873
 874         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 875         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 876
 877         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 878         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 879         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 880         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 881
 882         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
 883         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 884         assert!(node_1_shutdown == node_1_2nd_shutdown);
 885
 886         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
 887         let node_0_2nd_shutdown = if recv_count > 0 {
 888                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 889                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 890                 node_0_2nd_shutdown
 891         } else {
 892                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 893                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 894                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 895         };
 896         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 897
 898         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 899         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 900
 901         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 902         check_added_monitors!(nodes[2], 1);
 903         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 904         assert!(updates.update_add_htlcs.is_empty());
 905         assert!(updates.update_fail_htlcs.is_empty());
 906         assert!(updates.update_fail_malformed_htlcs.is_empty());
 907         assert!(updates.update_fee.is_none());
 908         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 909         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 910         check_added_monitors!(nodes[1], 1);
 911         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 912         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 913
 914         assert!(updates_2.update_add_htlcs.is_empty());
 915         assert!(updates_2.update_fail_htlcs.is_empty());
 916         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 917         assert!(updates_2.update_fee.is_none());
 918         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 919         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 920         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 921
 922         let events = nodes[0].node.get_and_clear_pending_events();
 923         assert_eq!(events.len(), 1);
 924         match events[0] {
 925                 Event::PaymentSent { ref payment_preimage } => {
 926                         assert_eq!(our_payment_preimage, *payment_preimage);
 927                 },
 928                 _ => panic!("Unexpected event"),
 929         }
 930
 931         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 932         if recv_count > 0 {
 933                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 934                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 935                 assert!(node_1_closing_signed.is_some());
 936         }
 937
 938         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 939         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 940
 941         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 942         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 943         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
 944         if recv_count == 0 {
 945                 // If all closing_signeds weren't delivered we can just resume where we left off...
 946                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 947
 948                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 949                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 950                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 951
 952                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 953                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 954                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 955
 956                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 957                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 958
 959                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 960                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 961                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
 962
 963                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
 964                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 965                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 966                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 967                 assert!(node_0_none.is_none());
 968         } else {
 969                 // If one node, however, received + responded with an identical closing_signed we end
 970                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 971                 // There isn't really anything better we can do simply, but in the future we might
 972                 // explore storing a set of recently-closed channels that got disconnected during
 973                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 974                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 975                 // transaction.
 976                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 977
 978                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 979                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
 980                 assert_eq!(msg_events.len(), 1);
 981                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
 982                         match action {
 983                                 &ErrorAction::SendErrorMessage { ref msg } => {
 984                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
 985                                         assert_eq!(msg.channel_id, chan_1.2);
 986                                 },
 987                                 _ => panic!("Unexpected event!"),
 988                         }
 989                 } else { panic!("Needed SendErrorMessage close"); }
 990
 991                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 992                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
 993                 // closing_signed so we do it ourselves
 994                 check_closed_broadcast!(nodes[0], false);
 995         }
 996
 997         assert!(nodes[0].node.list_channels().is_empty());
 998
 999         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1000         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1001         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1002         assert!(nodes[1].node.list_channels().is_empty());
1003         assert!(nodes[2].node.list_channels().is_empty());
1004 }
1005
1006 #[test]
1007 fn test_shutdown_rebroadcast() {
1008         do_test_shutdown_rebroadcast(0);
1009         do_test_shutdown_rebroadcast(1);
1010         do_test_shutdown_rebroadcast(2);
1011 }
1012
1013 #[test]
1014 fn fake_network_test() {
1015         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1016         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1017         let node_cfgs = create_node_cfgs(4);
1018         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1019         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1020
1021         // Create some initial channels
1022         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1023         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1024         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1025
1026         // Rebalance the network a bit by relaying one payment through all the channels...
1027         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1028         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1029         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1030         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1031
1032         // Send some more payments
1033         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1034         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1035         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1036
1037         // Test failure packets
1038         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1039         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1040
1041         // Add a new channel that skips 3
1042         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1043
1044         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1045         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1046         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1047         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1048         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1049         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1050         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1051
1052         // Do some rebalance loop payments, simultaneously
1053         let mut hops = Vec::with_capacity(3);
1054         hops.push(RouteHop {
1055                 pubkey: nodes[2].node.get_our_node_id(),
1056                 node_features: NodeFeatures::empty(),
1057                 short_channel_id: chan_2.0.contents.short_channel_id,
1058                 channel_features: ChannelFeatures::empty(),
1059                 fee_msat: 0,
1060                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1061         });
1062         hops.push(RouteHop {
1063                 pubkey: nodes[3].node.get_our_node_id(),
1064                 node_features: NodeFeatures::empty(),
1065                 short_channel_id: chan_3.0.contents.short_channel_id,
1066                 channel_features: ChannelFeatures::empty(),
1067                 fee_msat: 0,
1068                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1069         });
1070         hops.push(RouteHop {
1071                 pubkey: nodes[1].node.get_our_node_id(),
1072                 node_features: NodeFeatures::empty(),
1073                 short_channel_id: chan_4.0.contents.short_channel_id,
1074                 channel_features: ChannelFeatures::empty(),
1075                 fee_msat: 1000000,
1076                 cltv_expiry_delta: TEST_FINAL_CLTV,
1077         });
1078         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;
1079         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;
1080         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1081
1082         let mut hops = Vec::with_capacity(3);
1083         hops.push(RouteHop {
1084                 pubkey: nodes[3].node.get_our_node_id(),
1085                 node_features: NodeFeatures::empty(),
1086                 short_channel_id: chan_4.0.contents.short_channel_id,
1087                 channel_features: ChannelFeatures::empty(),
1088                 fee_msat: 0,
1089                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1090         });
1091         hops.push(RouteHop {
1092                 pubkey: nodes[2].node.get_our_node_id(),
1093                 node_features: NodeFeatures::empty(),
1094                 short_channel_id: chan_3.0.contents.short_channel_id,
1095                 channel_features: ChannelFeatures::empty(),
1096                 fee_msat: 0,
1097                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1098         });
1099         hops.push(RouteHop {
1100                 pubkey: nodes[1].node.get_our_node_id(),
1101                 node_features: NodeFeatures::empty(),
1102                 short_channel_id: chan_2.0.contents.short_channel_id,
1103                 channel_features: ChannelFeatures::empty(),
1104                 fee_msat: 1000000,
1105                 cltv_expiry_delta: TEST_FINAL_CLTV,
1106         });
1107         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;
1108         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;
1109         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1110
1111         // Claim the rebalances...
1112         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1113         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1114
1115         // Add a duplicate new channel from 2 to 4
1116         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1117
1118         // Send some payments across both channels
1119         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1120         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1121         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1122
1123
1124         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1125         let events = nodes[0].node.get_and_clear_pending_msg_events();
1126         assert_eq!(events.len(), 0);
1127         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1128
1129         //TODO: Test that routes work again here as we've been notified that the channel is full
1130
1131         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1132         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1133         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1134
1135         // Close down the channels...
1136         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1137         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1138         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1139         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1140         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1141 }
1142
1143 #[test]
1144 fn holding_cell_htlc_counting() {
1145         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1146         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1147         // commitment dance rounds.
1148         let node_cfgs = create_node_cfgs(3);
1149         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1150         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1151         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1152         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1153
1154         let mut payments = Vec::new();
1155         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1156                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1157                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1158                 nodes[1].node.send_payment(route, payment_hash, None).unwrap();
1159                 payments.push((payment_preimage, payment_hash));
1160         }
1161         check_added_monitors!(nodes[1], 1);
1162
1163         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1164         assert_eq!(events.len(), 1);
1165         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1166         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1167
1168         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1169         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1170         // another HTLC.
1171         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1172         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1173         unwrap_send_err!(nodes[1].node.send_payment(route, payment_hash_1, None), true, APIError::ChannelUnavailable { err },
1174                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1175         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1176         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1177
1178         // This should also be true if we try to forward a payment.
1179         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1180         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1181         nodes[0].node.send_payment(route, payment_hash_2, None).unwrap();
1182         check_added_monitors!(nodes[0], 1);
1183
1184         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1185         assert_eq!(events.len(), 1);
1186         let payment_event = SendEvent::from_event(events.pop().unwrap());
1187         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1188
1189         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1190         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1191         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1192         // fails), the second will process the resulting failure and fail the HTLC backward.
1193         expect_pending_htlcs_forwardable!(nodes[1]);
1194         expect_pending_htlcs_forwardable!(nodes[1]);
1195         check_added_monitors!(nodes[1], 1);
1196
1197         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1198         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1199         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1200
1201         let events = nodes[0].node.get_and_clear_pending_msg_events();
1202         assert_eq!(events.len(), 1);
1203         match events[0] {
1204                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1205                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1206                 },
1207                 _ => panic!("Unexpected event"),
1208         }
1209
1210         let events = nodes[0].node.get_and_clear_pending_events();
1211         assert_eq!(events.len(), 1);
1212         match events[0] {
1213                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1214                         assert_eq!(payment_hash, payment_hash_2);
1215                         assert!(!rejected_by_dest);
1216                 },
1217                 _ => panic!("Unexpected event"),
1218         }
1219
1220         // Now forward all the pending HTLCs and claim them back
1221         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1222         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1223         check_added_monitors!(nodes[2], 1);
1224
1225         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1226         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1227         check_added_monitors!(nodes[1], 1);
1228         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1229
1230         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1231         check_added_monitors!(nodes[1], 1);
1232         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1233
1234         for ref update in as_updates.update_add_htlcs.iter() {
1235                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1236         }
1237         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1238         check_added_monitors!(nodes[2], 1);
1239         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1240         check_added_monitors!(nodes[2], 1);
1241         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1242
1243         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1244         check_added_monitors!(nodes[1], 1);
1245         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1246         check_added_monitors!(nodes[1], 1);
1247         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1248
1249         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1250         check_added_monitors!(nodes[2], 1);
1251
1252         expect_pending_htlcs_forwardable!(nodes[2]);
1253
1254         let events = nodes[2].node.get_and_clear_pending_events();
1255         assert_eq!(events.len(), payments.len());
1256         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1257                 match event {
1258                         &Event::PaymentReceived { ref payment_hash, .. } => {
1259                                 assert_eq!(*payment_hash, *hash);
1260                         },
1261                         _ => panic!("Unexpected event"),
1262                 };
1263         }
1264
1265         for (preimage, _) in payments.drain(..) {
1266                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1267         }
1268
1269         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1270 }
1271
1272 #[test]
1273 fn duplicate_htlc_test() {
1274         // Test that we accept duplicate payment_hash HTLCs across the network and that
1275         // claiming/failing them are all separate and don't affect each other
1276         let node_cfgs = create_node_cfgs(6);
1277         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1278         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1279
1280         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1281         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1282         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1283         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1284         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1285         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1286
1287         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1288
1289         *nodes[0].network_payment_count.borrow_mut() -= 1;
1290         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1291
1292         *nodes[0].network_payment_count.borrow_mut() -= 1;
1293         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1294
1295         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1296         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1297         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1298 }
1299
1300 #[test]
1301 fn test_duplicate_htlc_different_direction_onchain() {
1302         // Test that ChannelMonitor doesn't generate 2 preimage txn
1303         // when we have 2 HTLCs with same preimage that go across a node
1304         // in opposite directions.
1305         let node_cfgs = create_node_cfgs(2);
1306         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1307         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1308
1309         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1310
1311         // balancing
1312         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1313
1314         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1315
1316         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1317         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1318
1319         // Provide preimage to node 0 by claiming payment
1320         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1321         check_added_monitors!(nodes[0], 1);
1322
1323         // Broadcast node 1 commitment txn
1324         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
1325
1326         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1327         let mut has_both_htlcs = 0; // check htlcs match ones committed
1328         for outp in remote_txn[0].output.iter() {
1329                 if outp.value == 800_000 / 1000 {
1330                         has_both_htlcs += 1;
1331                 } else if outp.value == 900_000 / 1000 {
1332                         has_both_htlcs += 1;
1333                 }
1334         }
1335         assert_eq!(has_both_htlcs, 2);
1336
1337         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1338         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1339
1340         // Check we only broadcast 1 timeout tx
1341         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1342         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1343         assert_eq!(claim_txn.len(), 7);
1344         check_spends!(claim_txn[2], chan_1.3);
1345         check_spends!(claim_txn[3], claim_txn[2]);
1346         assert_eq!(claim_txn[0], claim_txn[5]);
1347         assert_eq!(claim_txn[1], claim_txn[6]);
1348         assert_eq!(htlc_pair.0.input.len(), 1);
1349         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1350         check_spends!(htlc_pair.0, remote_txn[0].clone());
1351         assert_eq!(htlc_pair.1.input.len(), 1);
1352         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1353         check_spends!(htlc_pair.1, remote_txn[0].clone());
1354
1355         let events = nodes[0].node.get_and_clear_pending_msg_events();
1356         assert_eq!(events.len(), 2);
1357         for e in events {
1358                 match e {
1359                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1360                         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, .. } } => {
1361                                 assert!(update_add_htlcs.is_empty());
1362                                 assert!(update_fail_htlcs.is_empty());
1363                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1364                                 assert!(update_fail_malformed_htlcs.is_empty());
1365                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1366                         },
1367                         _ => panic!("Unexpected event"),
1368                 }
1369         }
1370 }
1371
1372 fn do_channel_reserve_test(test_recv: bool) {
1373
1374         let node_cfgs = create_node_cfgs(3);
1375         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1376         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1377         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1378         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1379
1380         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1381         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1382
1383         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1384         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1385
1386         macro_rules! get_route_and_payment_hash {
1387                 ($recv_value: expr) => {{
1388                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1389                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1390                         (route, payment_hash, payment_preimage)
1391                 }}
1392         };
1393
1394         macro_rules! expect_forward {
1395                 ($node: expr) => {{
1396                         let mut events = $node.node.get_and_clear_pending_msg_events();
1397                         assert_eq!(events.len(), 1);
1398                         check_added_monitors!($node, 1);
1399                         let payment_event = SendEvent::from_event(events.remove(0));
1400                         payment_event
1401                 }}
1402         }
1403
1404         let feemsat = 239; // somehow we know?
1405         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1406
1407         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1408
1409         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1410         {
1411                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1412                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1413                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1414                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1415                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1416                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1417         }
1418
1419         let mut htlc_id = 0;
1420         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1421         // nodes[0]'s wealth
1422         loop {
1423                 let amt_msat = recv_value_0 + total_fee_msat;
1424                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1425                         break;
1426                 }
1427                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1428                 htlc_id += 1;
1429
1430                 let (stat01_, stat11_, stat12_, stat22_) = (
1431                         get_channel_value_stat!(nodes[0], chan_1.2),
1432                         get_channel_value_stat!(nodes[1], chan_1.2),
1433                         get_channel_value_stat!(nodes[1], chan_2.2),
1434                         get_channel_value_stat!(nodes[2], chan_2.2),
1435                 );
1436
1437                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1438                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1439                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1440                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1441                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1442         }
1443
1444         {
1445                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1446                 // attempt to get channel_reserve violation
1447                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1448                 unwrap_send_err!(nodes[0].node.send_payment(route.clone(), our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1449                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1450                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1451                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1452         }
1453
1454         // adding pending output
1455         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1456         let amt_msat_1 = recv_value_1 + total_fee_msat;
1457
1458         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1459         let payment_event_1 = {
1460                 nodes[0].node.send_payment(route_1, our_payment_hash_1, None).unwrap();
1461                 check_added_monitors!(nodes[0], 1);
1462
1463                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1464                 assert_eq!(events.len(), 1);
1465                 SendEvent::from_event(events.remove(0))
1466         };
1467         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1468
1469         // channel reserve test with htlc pending output > 0
1470         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1471         {
1472                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1473                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1474                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1475                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1476                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1477         }
1478
1479         {
1480                 // test channel_reserve test on nodes[1] side
1481                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1482
1483                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1484                 let secp_ctx = Secp256k1::new();
1485                 let session_priv = SecretKey::from_slice(&{
1486                         let mut session_key = [0; 32];
1487                         let mut rng = thread_rng();
1488                         rng.fill_bytes(&mut session_key);
1489                         session_key
1490                 }).expect("RNG is bad!");
1491
1492                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1493                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1494                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, None, cur_height).unwrap();
1495                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1496                 let msg = msgs::UpdateAddHTLC {
1497                         channel_id: chan_1.2,
1498                         htlc_id,
1499                         amount_msat: htlc_msat,
1500                         payment_hash: our_payment_hash,
1501                         cltv_expiry: htlc_cltv,
1502                         onion_routing_packet: onion_packet,
1503                 };
1504
1505                 if test_recv {
1506                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1507                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1508                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1509                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1510                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1511                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1512                         return;
1513                 }
1514         }
1515
1516         // split the rest to test holding cell
1517         let recv_value_21 = recv_value_2/2;
1518         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1519         {
1520                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1521                 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);
1522         }
1523
1524         // now see if they go through on both sides
1525         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1526         // but this will stuck in the holding cell
1527         nodes[0].node.send_payment(route_21, our_payment_hash_21, None).unwrap();
1528         check_added_monitors!(nodes[0], 0);
1529         let events = nodes[0].node.get_and_clear_pending_events();
1530         assert_eq!(events.len(), 0);
1531
1532         // test with outbound holding cell amount > 0
1533         {
1534                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1535                 unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
1536                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1537                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1538                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1539         }
1540
1541         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1542         // this will also stuck in the holding cell
1543         nodes[0].node.send_payment(route_22, our_payment_hash_22, None).unwrap();
1544         check_added_monitors!(nodes[0], 0);
1545         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1546         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1547
1548         // flush the pending htlc
1549         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1550         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1551         check_added_monitors!(nodes[1], 1);
1552
1553         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1554         check_added_monitors!(nodes[0], 1);
1555         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1556
1557         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1558         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1559         // No commitment_signed so get_event_msg's assert(len == 1) passes
1560         check_added_monitors!(nodes[0], 1);
1561
1562         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1563         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1564         check_added_monitors!(nodes[1], 1);
1565
1566         expect_pending_htlcs_forwardable!(nodes[1]);
1567
1568         let ref payment_event_11 = expect_forward!(nodes[1]);
1569         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1570         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1571
1572         expect_pending_htlcs_forwardable!(nodes[2]);
1573         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1574
1575         // flush the htlcs in the holding cell
1576         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1577         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1578         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1579         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1580         expect_pending_htlcs_forwardable!(nodes[1]);
1581
1582         let ref payment_event_3 = expect_forward!(nodes[1]);
1583         assert_eq!(payment_event_3.msgs.len(), 2);
1584         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1585         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1586
1587         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1588         expect_pending_htlcs_forwardable!(nodes[2]);
1589
1590         let events = nodes[2].node.get_and_clear_pending_events();
1591         assert_eq!(events.len(), 2);
1592         match events[0] {
1593                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1594                         assert_eq!(our_payment_hash_21, *payment_hash);
1595                         assert_eq!(*payment_secret, None);
1596                         assert_eq!(recv_value_21, amt);
1597                 },
1598                 _ => panic!("Unexpected event"),
1599         }
1600         match events[1] {
1601                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1602                         assert_eq!(our_payment_hash_22, *payment_hash);
1603                         assert_eq!(*payment_secret, None);
1604                         assert_eq!(recv_value_22, amt);
1605                 },
1606                 _ => panic!("Unexpected event"),
1607         }
1608
1609         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1610         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1611         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1612
1613         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);
1614         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1615         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1616         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1617
1618         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1619         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1620 }
1621
1622 #[test]
1623 fn channel_reserve_test() {
1624         do_channel_reserve_test(false);
1625         do_channel_reserve_test(true);
1626 }
1627
1628 #[test]
1629 fn channel_reserve_in_flight_removes() {
1630         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1631         // can send to its counterparty, but due to update ordering, the other side may not yet have
1632         // considered those HTLCs fully removed.
1633         // This tests that we don't count HTLCs which will not be included in the next remote
1634         // commitment transaction towards the reserve value (as it implies no commitment transaction
1635         // will be generated which violates the remote reserve value).
1636         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1637         // To test this we:
1638         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1639         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1640         //    you only consider the value of the first HTLC, it may not),
1641         //  * start routing a third HTLC from A to B,
1642         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1643         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1644         //  * deliver the first fulfill from B
1645         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1646         //    claim,
1647         //  * deliver A's response CS and RAA.
1648         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1649         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1650         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1651         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1652         let node_cfgs = create_node_cfgs(2);
1653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1654         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1655         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1656
1657         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1658         // Route the first two HTLCs.
1659         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1660         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1661
1662         // Start routing the third HTLC (this is just used to get everyone in the right state).
1663         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1664         let send_1 = {
1665                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1666                 nodes[0].node.send_payment(route, payment_hash_3, None).unwrap();
1667                 check_added_monitors!(nodes[0], 1);
1668                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1669                 assert_eq!(events.len(), 1);
1670                 SendEvent::from_event(events.remove(0))
1671         };
1672
1673         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1674         // initial fulfill/CS.
1675         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1676         check_added_monitors!(nodes[1], 1);
1677         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1678
1679         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1680         // remove the second HTLC when we send the HTLC back from B to A.
1681         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1682         check_added_monitors!(nodes[1], 1);
1683         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1684
1685         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1686         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1687         check_added_monitors!(nodes[0], 1);
1688         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1689         expect_payment_sent!(nodes[0], payment_preimage_1);
1690
1691         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1692         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1693         check_added_monitors!(nodes[1], 1);
1694         // B is already AwaitingRAA, so cant generate a CS here
1695         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1696
1697         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1698         check_added_monitors!(nodes[1], 1);
1699         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1700
1701         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1702         check_added_monitors!(nodes[0], 1);
1703         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1704
1705         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1706         check_added_monitors!(nodes[1], 1);
1707         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1708
1709         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1710         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1711         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1712         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1713         // on-chain as necessary).
1714         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1715         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1716         check_added_monitors!(nodes[0], 1);
1717         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1718         expect_payment_sent!(nodes[0], payment_preimage_2);
1719
1720         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1721         check_added_monitors!(nodes[1], 1);
1722         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1723
1724         expect_pending_htlcs_forwardable!(nodes[1]);
1725         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1726
1727         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1728         // resolve the second HTLC from A's point of view.
1729         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1730         check_added_monitors!(nodes[0], 1);
1731         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1732
1733         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1734         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1735         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1736         let send_2 = {
1737                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1738                 nodes[1].node.send_payment(route, payment_hash_4, None).unwrap();
1739                 check_added_monitors!(nodes[1], 1);
1740                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1741                 assert_eq!(events.len(), 1);
1742                 SendEvent::from_event(events.remove(0))
1743         };
1744
1745         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1746         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1747         check_added_monitors!(nodes[0], 1);
1748         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1749
1750         // Now just resolve all the outstanding messages/HTLCs for completeness...
1751
1752         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1753         check_added_monitors!(nodes[1], 1);
1754         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1755
1756         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1757         check_added_monitors!(nodes[1], 1);
1758
1759         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1760         check_added_monitors!(nodes[0], 1);
1761         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1762
1763         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1764         check_added_monitors!(nodes[1], 1);
1765         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1766
1767         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1768         check_added_monitors!(nodes[0], 1);
1769
1770         expect_pending_htlcs_forwardable!(nodes[0]);
1771         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1772
1773         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1774         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1775 }
1776
1777 #[test]
1778 fn channel_monitor_network_test() {
1779         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1780         // tests that ChannelMonitor is able to recover from various states.
1781         let node_cfgs = create_node_cfgs(5);
1782         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1783         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1784
1785         // Create some initial channels
1786         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1787         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1788         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1789         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1790
1791         // Rebalance the network a bit by relaying one payment through all the channels...
1792         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1793         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1794         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1795         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1796
1797         // Simple case with no pending HTLCs:
1798         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1799         {
1800                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1801                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1802                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1803                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1804         }
1805         get_announce_close_broadcast_events(&nodes, 0, 1);
1806         assert_eq!(nodes[0].node.list_channels().len(), 0);
1807         assert_eq!(nodes[1].node.list_channels().len(), 1);
1808
1809         // One pending HTLC is discarded by the force-close:
1810         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1811
1812         // Simple case of one pending HTLC to HTLC-Timeout
1813         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1814         {
1815                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1816                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1817                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1818                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1819         }
1820         get_announce_close_broadcast_events(&nodes, 1, 2);
1821         assert_eq!(nodes[1].node.list_channels().len(), 0);
1822         assert_eq!(nodes[2].node.list_channels().len(), 1);
1823
1824         macro_rules! claim_funds {
1825                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1826                         {
1827                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1828                                 check_added_monitors!($node, 1);
1829
1830                                 let events = $node.node.get_and_clear_pending_msg_events();
1831                                 assert_eq!(events.len(), 1);
1832                                 match events[0] {
1833                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1834                                                 assert!(update_add_htlcs.is_empty());
1835                                                 assert!(update_fail_htlcs.is_empty());
1836                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1837                                         },
1838                                         _ => panic!("Unexpected event"),
1839                                 };
1840                         }
1841                 }
1842         }
1843
1844         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1845         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1846         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1847         let node2_commitment_txid;
1848         {
1849                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1850                 node2_commitment_txid = node_txn[0].txid();
1851
1852                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1853                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1854
1855                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1856                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1857
1858                 check_preimage_claim(&nodes[3], &node_txn);
1859         }
1860         get_announce_close_broadcast_events(&nodes, 2, 3);
1861         assert_eq!(nodes[2].node.list_channels().len(), 0);
1862         assert_eq!(nodes[3].node.list_channels().len(), 1);
1863
1864         { // Cheat and reset nodes[4]'s height to 1
1865                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1866                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1867         }
1868
1869         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1870         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1871         // One pending HTLC to time out:
1872         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1873         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1874         // buffer space).
1875
1876         {
1877                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1878                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1879                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1880                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1881                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1882                 }
1883
1884                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
1885                 {
1886                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
1887                         node_txn.retain(|tx| {
1888                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
1889                                         false
1890                                 } else { true }
1891                         });
1892                 }
1893
1894                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1895
1896                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1897                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1898
1899                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1900
1901                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1902                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1903                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1904                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1905                 }
1906
1907                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1908
1909                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1910                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1911
1912                 check_preimage_claim(&nodes[4], &node_txn);
1913         }
1914         get_announce_close_broadcast_events(&nodes, 3, 4);
1915         assert_eq!(nodes[3].node.list_channels().len(), 0);
1916         assert_eq!(nodes[4].node.list_channels().len(), 0);
1917 }
1918
1919 #[test]
1920 fn test_justice_tx() {
1921         // Test justice txn built on revoked HTLC-Success tx, against both sides
1922         let mut alice_config = UserConfig::default();
1923         alice_config.channel_options.announced_channel = true;
1924         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1925         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1926         let mut bob_config = UserConfig::default();
1927         bob_config.channel_options.announced_channel = true;
1928         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1929         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1930         let user_cfgs = [Some(alice_config), Some(bob_config)];
1931         let node_cfgs = create_node_cfgs(2);
1932         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
1933         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1934         // Create some new channels:
1935         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1936
1937         // A pending HTLC which will be revoked:
1938         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1939         // Get the will-be-revoked local txn from nodes[0]
1940         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1941         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1942         assert_eq!(revoked_local_txn[0].input.len(), 1);
1943         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1944         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1945         assert_eq!(revoked_local_txn[1].input.len(), 1);
1946         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1947         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1948         // Revoke the old state
1949         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1950
1951         {
1952                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1953                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1954                 {
1955                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1956                         assert_eq!(node_txn.len(), 3);
1957                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1958                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1959
1960                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1961                         node_txn.swap_remove(0);
1962                         node_txn.truncate(1);
1963                 }
1964                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1965
1966                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1967                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1968                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1969                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1970                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
1971         }
1972         get_announce_close_broadcast_events(&nodes, 0, 1);
1973
1974         assert_eq!(nodes[0].node.list_channels().len(), 0);
1975         assert_eq!(nodes[1].node.list_channels().len(), 0);
1976
1977         // We test justice_tx build by A on B's revoked HTLC-Success tx
1978         // Create some new channels:
1979         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1980         {
1981                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1982                 node_txn.clear();
1983         }
1984
1985         // A pending HTLC which will be revoked:
1986         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1987         // Get the will-be-revoked local txn from B
1988         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
1989         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1990         assert_eq!(revoked_local_txn[0].input.len(), 1);
1991         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1992         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1993         // Revoke the old state
1994         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
1995         {
1996                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1997                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1998                 {
1999                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2000                         assert_eq!(node_txn.len(), 3);
2001                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
2002                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2003
2004                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2005                         node_txn.swap_remove(0);
2006                 }
2007                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2008
2009                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2010                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2011                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2012                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2013                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2014         }
2015         get_announce_close_broadcast_events(&nodes, 0, 1);
2016         assert_eq!(nodes[0].node.list_channels().len(), 0);
2017         assert_eq!(nodes[1].node.list_channels().len(), 0);
2018 }
2019
2020 #[test]
2021 fn revoked_output_claim() {
2022         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2023         // transaction is broadcast by its counterparty
2024         let node_cfgs = create_node_cfgs(2);
2025         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2026         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2027         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2028         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2029         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2030         assert_eq!(revoked_local_txn.len(), 1);
2031         // Only output is the full channel value back to nodes[0]:
2032         assert_eq!(revoked_local_txn[0].output.len(), 1);
2033         // Send a payment through, updating everyone's latest commitment txn
2034         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2035
2036         // Inform nodes[1] that nodes[0] broadcast a stale tx
2037         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2038         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2039         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2040         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
2041
2042         assert_eq!(node_txn[0], node_txn[2]);
2043
2044         check_spends!(node_txn[0], revoked_local_txn[0].clone());
2045         check_spends!(node_txn[1], chan_1.3.clone());
2046
2047         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2048         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2049         get_announce_close_broadcast_events(&nodes, 0, 1);
2050 }
2051
2052 #[test]
2053 fn claim_htlc_outputs_shared_tx() {
2054         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2055         let node_cfgs = create_node_cfgs(2);
2056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2057         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2058
2059         // Create some new channel:
2060         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2061
2062         // Rebalance the network to generate htlc in the two directions
2063         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2064         // 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
2065         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2066         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2067
2068         // Get the will-be-revoked local txn from node[0]
2069         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2070         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2071         assert_eq!(revoked_local_txn[0].input.len(), 1);
2072         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2073         assert_eq!(revoked_local_txn[1].input.len(), 1);
2074         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2075         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2076         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
2077
2078         //Revoke the old state
2079         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2080
2081         {
2082                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2083                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2084                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2085                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2086
2087                 let events = nodes[1].node.get_and_clear_pending_events();
2088                 assert_eq!(events.len(), 1);
2089                 match events[0] {
2090                         Event::PaymentFailed { payment_hash, .. } => {
2091                                 assert_eq!(payment_hash, payment_hash_2);
2092                         },
2093                         _ => panic!("Unexpected event"),
2094                 }
2095
2096                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2097                 assert_eq!(node_txn.len(), 4);
2098
2099                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2100                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2101
2102                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2103
2104                 let mut witness_lens = BTreeSet::new();
2105                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2106                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2107                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2108                 assert_eq!(witness_lens.len(), 3);
2109                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2110                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2111                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2112
2113                 // Next nodes[1] broadcasts its current local tx state:
2114                 assert_eq!(node_txn[1].input.len(), 1);
2115                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2116
2117                 assert_eq!(node_txn[2].input.len(), 1);
2118                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2119                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2120                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2121                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2122                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2123         }
2124         get_announce_close_broadcast_events(&nodes, 0, 1);
2125         assert_eq!(nodes[0].node.list_channels().len(), 0);
2126         assert_eq!(nodes[1].node.list_channels().len(), 0);
2127 }
2128
2129 #[test]
2130 fn claim_htlc_outputs_single_tx() {
2131         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2132         let node_cfgs = create_node_cfgs(2);
2133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2135
2136         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2137
2138         // Rebalance the network to generate htlc in the two directions
2139         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2140         // 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
2141         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2142         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2143         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2144
2145         // Get the will-be-revoked local txn from node[0]
2146         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2147
2148         //Revoke the old state
2149         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2150
2151         {
2152                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2153                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2154                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2155                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2156
2157                 let events = nodes[1].node.get_and_clear_pending_events();
2158                 assert_eq!(events.len(), 1);
2159                 match events[0] {
2160                         Event::PaymentFailed { payment_hash, .. } => {
2161                                 assert_eq!(payment_hash, payment_hash_2);
2162                         },
2163                         _ => panic!("Unexpected event"),
2164                 }
2165
2166                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2167                 assert_eq!(node_txn.len(), 29); // 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)
2168
2169                 assert_eq!(node_txn[0], node_txn[7]);
2170                 assert_eq!(node_txn[1], node_txn[8]);
2171                 assert_eq!(node_txn[2], node_txn[9]);
2172                 assert_eq!(node_txn[3], node_txn[10]);
2173                 assert_eq!(node_txn[4], node_txn[11]);
2174                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2175                 assert_eq!(node_txn[4], node_txn[6]);
2176
2177                 assert_eq!(node_txn[0].input.len(), 1);
2178                 assert_eq!(node_txn[1].input.len(), 1);
2179                 assert_eq!(node_txn[2].input.len(), 1);
2180
2181                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2182                         if out_point.txid == tx.txid() {
2183                                 tx.output.get(out_point.vout as usize).cloned()
2184                         } else {
2185                                 None
2186                         }
2187                 }
2188                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2189                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2190                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2191
2192                 let mut witness_lens = BTreeSet::new();
2193                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2194                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2195                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2196                 assert_eq!(witness_lens.len(), 3);
2197                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2198                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2199                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2200
2201                 assert_eq!(node_txn[3].input.len(), 1);
2202                 check_spends!(node_txn[3], chan_1.3.clone());
2203
2204                 assert_eq!(node_txn[4].input.len(), 1);
2205                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2206                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2207                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2208                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2209                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2210         }
2211         get_announce_close_broadcast_events(&nodes, 0, 1);
2212         assert_eq!(nodes[0].node.list_channels().len(), 0);
2213         assert_eq!(nodes[1].node.list_channels().len(), 0);
2214 }
2215
2216 #[test]
2217 fn test_htlc_on_chain_success() {
2218         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2219         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2220         // broadcasting the right event to other nodes in payment path.
2221         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2222         // A --------------------> B ----------------------> C (preimage)
2223         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2224         // commitment transaction was broadcast.
2225         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2226         // towards B.
2227         // B should be able to claim via preimage if A then broadcasts its local tx.
2228         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2229         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2230         // PaymentSent event).
2231
2232         let node_cfgs = create_node_cfgs(3);
2233         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2234         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2235
2236         // Create some initial channels
2237         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2238         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2239
2240         // Rebalance the network a bit by relaying one payment through all the channels...
2241         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2242         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2243
2244         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2245         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2246         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2247
2248         // Broadcast legit commitment tx from C on B's chain
2249         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2250         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2251         assert_eq!(commitment_tx.len(), 1);
2252         check_spends!(commitment_tx[0], chan_2.3.clone());
2253         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2254         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2255         check_added_monitors!(nodes[2], 2);
2256         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2257         assert!(updates.update_add_htlcs.is_empty());
2258         assert!(updates.update_fail_htlcs.is_empty());
2259         assert!(updates.update_fail_malformed_htlcs.is_empty());
2260         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2261
2262         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2263         check_closed_broadcast!(nodes[2], false);
2264         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2265         assert_eq!(node_txn.len(), 7);
2266         assert_eq!(node_txn[0], node_txn[3]);
2267         assert_eq!(node_txn[1], node_txn[4]);
2268         assert_eq!(node_txn[0], node_txn[5]);
2269         assert_eq!(node_txn[1], node_txn[6]);
2270         assert_eq!(node_txn[2], commitment_tx[0]);
2271         check_spends!(node_txn[0], commitment_tx[0].clone());
2272         check_spends!(node_txn[1], commitment_tx[0].clone());
2273         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2274         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2275         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2276         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2277         assert_eq!(node_txn[0].lock_time, 0);
2278         assert_eq!(node_txn[1].lock_time, 0);
2279
2280         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2281         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2282         let events = nodes[1].node.get_and_clear_pending_msg_events();
2283         {
2284                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2285                 assert_eq!(added_monitors.len(), 2);
2286                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2287                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2288                 added_monitors.clear();
2289         }
2290         assert_eq!(events.len(), 2);
2291         match events[0] {
2292                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2293                 _ => panic!("Unexpected event"),
2294         }
2295         match events[1] {
2296                 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, .. } } => {
2297                         assert!(update_add_htlcs.is_empty());
2298                         assert!(update_fail_htlcs.is_empty());
2299                         assert_eq!(update_fulfill_htlcs.len(), 1);
2300                         assert!(update_fail_malformed_htlcs.is_empty());
2301                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2302                 },
2303                 _ => panic!("Unexpected event"),
2304         };
2305         macro_rules! check_tx_local_broadcast {
2306                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2307                         // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2308                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2309                         assert_eq!(node_txn.len(), 7);
2310                         assert_eq!(node_txn[0], node_txn[5]);
2311                         assert_eq!(node_txn[1], node_txn[6]);
2312                         check_spends!(node_txn[0], $commitment_tx.clone());
2313                         check_spends!(node_txn[1], $commitment_tx.clone());
2314                         assert_ne!(node_txn[0].lock_time, 0);
2315                         assert_ne!(node_txn[1].lock_time, 0);
2316                         if $htlc_offered {
2317                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2318                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2319                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2320                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2321                         } else {
2322                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2323                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2324                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2325                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2326                         }
2327                         check_spends!(node_txn[2], $chan_tx.clone());
2328                         check_spends!(node_txn[3], node_txn[2].clone());
2329                         check_spends!(node_txn[4], node_txn[2].clone());
2330                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2331                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2332                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2333                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2334                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2335                         assert_ne!(node_txn[3].lock_time, 0);
2336                         assert_ne!(node_txn[4].lock_time, 0);
2337                         node_txn.clear();
2338                 } }
2339         }
2340         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2341         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2342         // timeout-claim of the output that nodes[2] just claimed via success.
2343         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2344
2345         // Broadcast legit commitment tx from A on B's chain
2346         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2347         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2348         check_spends!(commitment_tx[0], chan_1.3.clone());
2349         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2350         check_closed_broadcast!(nodes[1], false);
2351         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + 2*HTLC-Success), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2352         assert_eq!(node_txn.len(), 5);
2353         assert_eq!(node_txn[0], node_txn[4]);
2354         check_spends!(node_txn[0], commitment_tx[0].clone());
2355         assert_eq!(node_txn[0].input.len(), 2);
2356         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2357         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2358         assert_eq!(node_txn[0].lock_time, 0);
2359         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2360         check_spends!(node_txn[1], chan_1.3.clone());
2361         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2362         check_spends!(node_txn[2], node_txn[1]);
2363         check_spends!(node_txn[3], node_txn[1]);
2364         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2365         // we already checked the same situation with A.
2366
2367         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2368         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2369         check_closed_broadcast!(nodes[0], false);
2370         let events = nodes[0].node.get_and_clear_pending_events();
2371         assert_eq!(events.len(), 2);
2372         let mut first_claimed = false;
2373         for event in events {
2374                 match event {
2375                         Event::PaymentSent { payment_preimage } => {
2376                                 if payment_preimage == our_payment_preimage {
2377                                         assert!(!first_claimed);
2378                                         first_claimed = true;
2379                                 } else {
2380                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2381                                 }
2382                         },
2383                         _ => panic!("Unexpected event"),
2384                 }
2385         }
2386         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2387 }
2388
2389 #[test]
2390 fn test_htlc_on_chain_timeout() {
2391         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2392         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2393         // broadcasting the right event to other nodes in payment path.
2394         // A ------------------> B ----------------------> C (timeout)
2395         //    B's commitment tx                 C's commitment tx
2396         //            \                                  \
2397         //         B's HTLC timeout tx               B's timeout tx
2398
2399         let node_cfgs = create_node_cfgs(3);
2400         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2401         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2402
2403         // Create some intial channels
2404         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2405         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2406
2407         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2408         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2409         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2410
2411         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2412         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2413
2414         // Broadcast legit commitment tx from C on B's chain
2415         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2416         check_spends!(commitment_tx[0], chan_2.3.clone());
2417         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2418         check_added_monitors!(nodes[2], 0);
2419         expect_pending_htlcs_forwardable!(nodes[2]);
2420         check_added_monitors!(nodes[2], 1);
2421
2422         let events = nodes[2].node.get_and_clear_pending_msg_events();
2423         assert_eq!(events.len(), 1);
2424         match events[0] {
2425                 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, .. } } => {
2426                         assert!(update_add_htlcs.is_empty());
2427                         assert!(!update_fail_htlcs.is_empty());
2428                         assert!(update_fulfill_htlcs.is_empty());
2429                         assert!(update_fail_malformed_htlcs.is_empty());
2430                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2431                 },
2432                 _ => panic!("Unexpected event"),
2433         };
2434         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2435         check_closed_broadcast!(nodes[2], false);
2436         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2437         assert_eq!(node_txn.len(), 1);
2438         check_spends!(node_txn[0], chan_2.3.clone());
2439         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2440
2441         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2442         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2443         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2444         let timeout_tx;
2445         {
2446                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2447                 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)
2448                 assert_eq!(node_txn[0], node_txn[5]);
2449                 assert_eq!(node_txn[1], node_txn[6]);
2450                 assert_eq!(node_txn[2], node_txn[7]);
2451                 check_spends!(node_txn[0], commitment_tx[0].clone());
2452                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2453                 check_spends!(node_txn[1], chan_2.3.clone());
2454                 check_spends!(node_txn[2], node_txn[1].clone());
2455                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2456                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2457                 check_spends!(node_txn[3], chan_2.3.clone());
2458                 check_spends!(node_txn[4], node_txn[3].clone());
2459                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2460                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2461                 timeout_tx = node_txn[0].clone();
2462                 node_txn.clear();
2463         }
2464
2465         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2466         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2467         check_added_monitors!(nodes[1], 0);
2468         check_closed_broadcast!(nodes[1], false);
2469
2470         expect_pending_htlcs_forwardable!(nodes[1]);
2471         check_added_monitors!(nodes[1], 1);
2472         let events = nodes[1].node.get_and_clear_pending_msg_events();
2473         assert_eq!(events.len(), 1);
2474         match events[0] {
2475                 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, .. } } => {
2476                         assert!(update_add_htlcs.is_empty());
2477                         assert!(!update_fail_htlcs.is_empty());
2478                         assert!(update_fulfill_htlcs.is_empty());
2479                         assert!(update_fail_malformed_htlcs.is_empty());
2480                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2481                 },
2482                 _ => panic!("Unexpected event"),
2483         };
2484         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
2485         assert_eq!(node_txn.len(), 0);
2486
2487         // Broadcast legit commitment tx from B on A's chain
2488         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2489         check_spends!(commitment_tx[0], chan_1.3.clone());
2490
2491         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2492         check_closed_broadcast!(nodes[0], false);
2493         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
2494         assert_eq!(node_txn.len(), 4);
2495         assert_eq!(node_txn[0], node_txn[3]);
2496         check_spends!(node_txn[0], commitment_tx[0].clone());
2497         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2498         check_spends!(node_txn[1], chan_1.3.clone());
2499         check_spends!(node_txn[2], node_txn[1].clone());
2500         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2501         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2502 }
2503
2504 #[test]
2505 fn test_simple_commitment_revoked_fail_backward() {
2506         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2507         // and fail backward accordingly.
2508
2509         let node_cfgs = create_node_cfgs(3);
2510         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2511         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2512
2513         // Create some initial channels
2514         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2515         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2516
2517         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2518         // Get the will-be-revoked local txn from nodes[2]
2519         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2520         // Revoke the old state
2521         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2522
2523         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2524
2525         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2526         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2527         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2528         check_added_monitors!(nodes[1], 0);
2529         check_closed_broadcast!(nodes[1], false);
2530
2531         expect_pending_htlcs_forwardable!(nodes[1]);
2532         check_added_monitors!(nodes[1], 1);
2533         let events = nodes[1].node.get_and_clear_pending_msg_events();
2534         assert_eq!(events.len(), 1);
2535         match events[0] {
2536                 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, .. } } => {
2537                         assert!(update_add_htlcs.is_empty());
2538                         assert_eq!(update_fail_htlcs.len(), 1);
2539                         assert!(update_fulfill_htlcs.is_empty());
2540                         assert!(update_fail_malformed_htlcs.is_empty());
2541                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2542
2543                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2544                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2545
2546                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2547                         assert_eq!(events.len(), 1);
2548                         match events[0] {
2549                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2550                                 _ => panic!("Unexpected event"),
2551                         }
2552                         let events = nodes[0].node.get_and_clear_pending_events();
2553                         assert_eq!(events.len(), 1);
2554                         match events[0] {
2555                                 Event::PaymentFailed { .. } => {},
2556                                 _ => panic!("Unexpected event"),
2557                         }
2558                 },
2559                 _ => panic!("Unexpected event"),
2560         }
2561 }
2562
2563 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2564         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2565         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2566         // commitment transaction anymore.
2567         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2568         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2569         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2570         // technically disallowed and we should probably handle it reasonably.
2571         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2572         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2573         // transactions:
2574         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2575         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2576         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2577         //   and once they revoke the previous commitment transaction (allowing us to send a new
2578         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2579         let node_cfgs = create_node_cfgs(3);
2580         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2581         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2582
2583         // Create some initial channels
2584         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2585         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2586
2587         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2588         // Get the will-be-revoked local txn from nodes[2]
2589         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
2590         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2591         // Revoke the old state
2592         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2593
2594         let value = if use_dust {
2595                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2596                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2597                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2598         } else { 3000000 };
2599
2600         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2601         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2602         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2603
2604         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2605         expect_pending_htlcs_forwardable!(nodes[2]);
2606         check_added_monitors!(nodes[2], 1);
2607         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2608         assert!(updates.update_add_htlcs.is_empty());
2609         assert!(updates.update_fulfill_htlcs.is_empty());
2610         assert!(updates.update_fail_malformed_htlcs.is_empty());
2611         assert_eq!(updates.update_fail_htlcs.len(), 1);
2612         assert!(updates.update_fee.is_none());
2613         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2614         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2615         // Drop the last RAA from 3 -> 2
2616
2617         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2618         expect_pending_htlcs_forwardable!(nodes[2]);
2619         check_added_monitors!(nodes[2], 1);
2620         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2621         assert!(updates.update_add_htlcs.is_empty());
2622         assert!(updates.update_fulfill_htlcs.is_empty());
2623         assert!(updates.update_fail_malformed_htlcs.is_empty());
2624         assert_eq!(updates.update_fail_htlcs.len(), 1);
2625         assert!(updates.update_fee.is_none());
2626         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2627         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2628         check_added_monitors!(nodes[1], 1);
2629         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2630         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2631         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2632         check_added_monitors!(nodes[2], 1);
2633
2634         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2635         expect_pending_htlcs_forwardable!(nodes[2]);
2636         check_added_monitors!(nodes[2], 1);
2637         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2638         assert!(updates.update_add_htlcs.is_empty());
2639         assert!(updates.update_fulfill_htlcs.is_empty());
2640         assert!(updates.update_fail_malformed_htlcs.is_empty());
2641         assert_eq!(updates.update_fail_htlcs.len(), 1);
2642         assert!(updates.update_fee.is_none());
2643         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2644         // At this point first_payment_hash has dropped out of the latest two commitment
2645         // transactions that nodes[1] is tracking...
2646         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2647         check_added_monitors!(nodes[1], 1);
2648         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2649         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2650         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2651         check_added_monitors!(nodes[2], 1);
2652
2653         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2654         // on nodes[2]'s RAA.
2655         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2656         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2657         nodes[1].node.send_payment(route, fourth_payment_hash, None).unwrap();
2658         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2659         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2660         check_added_monitors!(nodes[1], 0);
2661
2662         if deliver_bs_raa {
2663                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2664                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2665                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2666                 check_added_monitors!(nodes[1], 1);
2667                 let events = nodes[1].node.get_and_clear_pending_events();
2668                 assert_eq!(events.len(), 1);
2669                 match events[0] {
2670                         Event::PendingHTLCsForwardable { .. } => { },
2671                         _ => panic!("Unexpected event"),
2672                 };
2673                 // Deliberately don't process the pending fail-back so they all fail back at once after
2674                 // block connection just like the !deliver_bs_raa case
2675         }
2676
2677         let mut failed_htlcs = HashSet::new();
2678         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2679
2680         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2681         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2682         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2683
2684         let events = nodes[1].node.get_and_clear_pending_events();
2685         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2686         match events[0] {
2687                 Event::PaymentFailed { ref payment_hash, .. } => {
2688                         assert_eq!(*payment_hash, fourth_payment_hash);
2689                 },
2690                 _ => panic!("Unexpected event"),
2691         }
2692         if !deliver_bs_raa {
2693                 match events[1] {
2694                         Event::PendingHTLCsForwardable { .. } => { },
2695                         _ => panic!("Unexpected event"),
2696                 };
2697         }
2698         nodes[1].node.process_pending_htlc_forwards();
2699         check_added_monitors!(nodes[1], 1);
2700
2701         let events = nodes[1].node.get_and_clear_pending_msg_events();
2702         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2703         match events[if deliver_bs_raa { 1 } else { 0 }] {
2704                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2705                 _ => panic!("Unexpected event"),
2706         }
2707         if deliver_bs_raa {
2708                 match events[0] {
2709                         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, .. } } => {
2710                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2711                                 assert_eq!(update_add_htlcs.len(), 1);
2712                                 assert!(update_fulfill_htlcs.is_empty());
2713                                 assert!(update_fail_htlcs.is_empty());
2714                                 assert!(update_fail_malformed_htlcs.is_empty());
2715                         },
2716                         _ => panic!("Unexpected event"),
2717                 }
2718         }
2719         match events[if deliver_bs_raa { 2 } else { 1 }] {
2720                 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, .. } } => {
2721                         assert!(update_add_htlcs.is_empty());
2722                         assert_eq!(update_fail_htlcs.len(), 3);
2723                         assert!(update_fulfill_htlcs.is_empty());
2724                         assert!(update_fail_malformed_htlcs.is_empty());
2725                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2726
2727                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2728                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2729                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2730
2731                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2732
2733                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2734                         // If we delivered B's RAA we got an unknown preimage error, not something
2735                         // that we should update our routing table for.
2736                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2737                         for event in events {
2738                                 match event {
2739                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2740                                         _ => panic!("Unexpected event"),
2741                                 }
2742                         }
2743                         let events = nodes[0].node.get_and_clear_pending_events();
2744                         assert_eq!(events.len(), 3);
2745                         match events[0] {
2746                                 Event::PaymentFailed { ref payment_hash, .. } => {
2747                                         assert!(failed_htlcs.insert(payment_hash.0));
2748                                 },
2749                                 _ => panic!("Unexpected event"),
2750                         }
2751                         match events[1] {
2752                                 Event::PaymentFailed { ref payment_hash, .. } => {
2753                                         assert!(failed_htlcs.insert(payment_hash.0));
2754                                 },
2755                                 _ => panic!("Unexpected event"),
2756                         }
2757                         match events[2] {
2758                                 Event::PaymentFailed { ref payment_hash, .. } => {
2759                                         assert!(failed_htlcs.insert(payment_hash.0));
2760                                 },
2761                                 _ => panic!("Unexpected event"),
2762                         }
2763                 },
2764                 _ => panic!("Unexpected event"),
2765         }
2766
2767         assert!(failed_htlcs.contains(&first_payment_hash.0));
2768         assert!(failed_htlcs.contains(&second_payment_hash.0));
2769         assert!(failed_htlcs.contains(&third_payment_hash.0));
2770 }
2771
2772 #[test]
2773 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2774         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2775         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2776         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2777         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2778 }
2779
2780 #[test]
2781 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2782         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2783         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2784         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2785         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2786 }
2787
2788 #[test]
2789 fn test_htlc_ignore_latest_remote_commitment() {
2790         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2791         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2792         let node_cfgs = create_node_cfgs(2);
2793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2794         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2795         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2796
2797         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2798         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2799         check_closed_broadcast!(nodes[0], false);
2800
2801         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2802         assert_eq!(node_txn.len(), 2);
2803
2804         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2805         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2806         check_closed_broadcast!(nodes[1], false);
2807
2808         // Duplicate the block_connected call since this may happen due to other listeners
2809         // registering new transactions
2810         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2811 }
2812
2813 #[test]
2814 fn test_force_close_fail_back() {
2815         // Check which HTLCs are failed-backwards on channel force-closure
2816         let node_cfgs = create_node_cfgs(3);
2817         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2818         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2819         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2820         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2821
2822         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2823
2824         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2825
2826         let mut payment_event = {
2827                 nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
2828                 check_added_monitors!(nodes[0], 1);
2829
2830                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2831                 assert_eq!(events.len(), 1);
2832                 SendEvent::from_event(events.remove(0))
2833         };
2834
2835         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2836         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2837
2838         expect_pending_htlcs_forwardable!(nodes[1]);
2839
2840         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2841         assert_eq!(events_2.len(), 1);
2842         payment_event = SendEvent::from_event(events_2.remove(0));
2843         assert_eq!(payment_event.msgs.len(), 1);
2844
2845         check_added_monitors!(nodes[1], 1);
2846         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2847         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
2848         check_added_monitors!(nodes[2], 1);
2849         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2850
2851         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2852         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2853         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2854
2855         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2856         check_closed_broadcast!(nodes[2], false);
2857         let tx = {
2858                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2859                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2860                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2861                 // back to nodes[1] upon timeout otherwise.
2862                 assert_eq!(node_txn.len(), 1);
2863                 node_txn.remove(0)
2864         };
2865
2866         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2867         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2868
2869         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2870         check_closed_broadcast!(nodes[1], false);
2871
2872         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2873         {
2874                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2875                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2876                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2877         }
2878         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2879         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2880         assert_eq!(node_txn.len(), 1);
2881         assert_eq!(node_txn[0].input.len(), 1);
2882         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2883         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2884         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2885
2886         check_spends!(node_txn[0], tx);
2887 }
2888
2889 #[test]
2890 fn test_unconf_chan() {
2891         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2892         let node_cfgs = create_node_cfgs(2);
2893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2894         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2895         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2896
2897         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2898         assert_eq!(channel_state.by_id.len(), 1);
2899         assert_eq!(channel_state.short_to_id.len(), 1);
2900         mem::drop(channel_state);
2901
2902         let mut headers = Vec::new();
2903         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2904         headers.push(header.clone());
2905         for _i in 2..100 {
2906                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2907                 headers.push(header.clone());
2908         }
2909         let mut height = 99;
2910         while !headers.is_empty() {
2911                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2912                 height -= 1;
2913         }
2914         check_closed_broadcast!(nodes[0], false);
2915         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2916         assert_eq!(channel_state.by_id.len(), 0);
2917         assert_eq!(channel_state.short_to_id.len(), 0);
2918 }
2919
2920 #[test]
2921 fn test_simple_peer_disconnect() {
2922         // Test that we can reconnect when there are no lost messages
2923         let node_cfgs = create_node_cfgs(3);
2924         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2925         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2926         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2927         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2928
2929         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2930         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2931         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2932
2933         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2934         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2935         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2936         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2937
2938         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2939         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2940         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2941
2942         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2943         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2944         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2945         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2946
2947         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2948         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2949
2950         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2951         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2952
2953         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2954         {
2955                 let events = nodes[0].node.get_and_clear_pending_events();
2956                 assert_eq!(events.len(), 2);
2957                 match events[0] {
2958                         Event::PaymentSent { payment_preimage } => {
2959                                 assert_eq!(payment_preimage, payment_preimage_3);
2960                         },
2961                         _ => panic!("Unexpected event"),
2962                 }
2963                 match events[1] {
2964                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2965                                 assert_eq!(payment_hash, payment_hash_5);
2966                                 assert!(rejected_by_dest);
2967                         },
2968                         _ => panic!("Unexpected event"),
2969                 }
2970         }
2971
2972         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2973         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2974 }
2975
2976 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2977         // Test that we can reconnect when in-flight HTLC updates get dropped
2978         let node_cfgs = create_node_cfgs(2);
2979         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2980         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2981         if messages_delivered == 0 {
2982                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
2983                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2984         } else {
2985                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2986         }
2987
2988         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();
2989         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2990
2991         let payment_event = {
2992                 nodes[0].node.send_payment(route.clone(), payment_hash_1, None).unwrap();
2993                 check_added_monitors!(nodes[0], 1);
2994
2995                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2996                 assert_eq!(events.len(), 1);
2997                 SendEvent::from_event(events.remove(0))
2998         };
2999         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3000
3001         if messages_delivered < 2 {
3002                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3003         } else {
3004                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3005                 if messages_delivered >= 3 {
3006                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3007                         check_added_monitors!(nodes[1], 1);
3008                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3009
3010                         if messages_delivered >= 4 {
3011                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3012                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3013                                 check_added_monitors!(nodes[0], 1);
3014
3015                                 if messages_delivered >= 5 {
3016                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3017                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3018                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3019                                         check_added_monitors!(nodes[0], 1);
3020
3021                                         if messages_delivered >= 6 {
3022                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3023                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3024                                                 check_added_monitors!(nodes[1], 1);
3025                                         }
3026                                 }
3027                         }
3028                 }
3029         }
3030
3031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3032         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3033         if messages_delivered < 3 {
3034                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3035                 // received on either side, both sides will need to resend them.
3036                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3037         } else if messages_delivered == 3 {
3038                 // nodes[0] still wants its RAA + commitment_signed
3039                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3040         } else if messages_delivered == 4 {
3041                 // nodes[0] still wants its commitment_signed
3042                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3043         } else if messages_delivered == 5 {
3044                 // nodes[1] still wants its final RAA
3045                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3046         } else if messages_delivered == 6 {
3047                 // Everything was delivered...
3048                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3049         }
3050
3051         let events_1 = nodes[1].node.get_and_clear_pending_events();
3052         assert_eq!(events_1.len(), 1);
3053         match events_1[0] {
3054                 Event::PendingHTLCsForwardable { .. } => { },
3055                 _ => panic!("Unexpected event"),
3056         };
3057
3058         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3059         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3060         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3061
3062         nodes[1].node.process_pending_htlc_forwards();
3063
3064         let events_2 = nodes[1].node.get_and_clear_pending_events();
3065         assert_eq!(events_2.len(), 1);
3066         match events_2[0] {
3067                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3068                         assert_eq!(payment_hash_1, *payment_hash);
3069                         assert_eq!(*payment_secret, None);
3070                         assert_eq!(amt, 1000000);
3071                 },
3072                 _ => panic!("Unexpected event"),
3073         }
3074
3075         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3076         check_added_monitors!(nodes[1], 1);
3077
3078         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3079         assert_eq!(events_3.len(), 1);
3080         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3081                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3082                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3083                         assert!(updates.update_add_htlcs.is_empty());
3084                         assert!(updates.update_fail_htlcs.is_empty());
3085                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3086                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3087                         assert!(updates.update_fee.is_none());
3088                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3089                 },
3090                 _ => panic!("Unexpected event"),
3091         };
3092
3093         if messages_delivered >= 1 {
3094                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3095
3096                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3097                 assert_eq!(events_4.len(), 1);
3098                 match events_4[0] {
3099                         Event::PaymentSent { ref payment_preimage } => {
3100                                 assert_eq!(payment_preimage_1, *payment_preimage);
3101                         },
3102                         _ => panic!("Unexpected event"),
3103                 }
3104
3105                 if messages_delivered >= 2 {
3106                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3107                         check_added_monitors!(nodes[0], 1);
3108                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3109
3110                         if messages_delivered >= 3 {
3111                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3112                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3113                                 check_added_monitors!(nodes[1], 1);
3114
3115                                 if messages_delivered >= 4 {
3116                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3117                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3118                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3119                                         check_added_monitors!(nodes[1], 1);
3120
3121                                         if messages_delivered >= 5 {
3122                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3123                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3124                                                 check_added_monitors!(nodes[0], 1);
3125                                         }
3126                                 }
3127                         }
3128                 }
3129         }
3130
3131         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3132         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3133         if messages_delivered < 2 {
3134                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3135                 //TODO: Deduplicate PaymentSent events, then enable this if:
3136                 //if messages_delivered < 1 {
3137                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3138                         assert_eq!(events_4.len(), 1);
3139                         match events_4[0] {
3140                                 Event::PaymentSent { ref payment_preimage } => {
3141                                         assert_eq!(payment_preimage_1, *payment_preimage);
3142                                 },
3143                                 _ => panic!("Unexpected event"),
3144                         }
3145                 //}
3146         } else if messages_delivered == 2 {
3147                 // nodes[0] still wants its RAA + commitment_signed
3148                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3149         } else if messages_delivered == 3 {
3150                 // nodes[0] still wants its commitment_signed
3151                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3152         } else if messages_delivered == 4 {
3153                 // nodes[1] still wants its final RAA
3154                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3155         } else if messages_delivered == 5 {
3156                 // Everything was delivered...
3157                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3158         }
3159
3160         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3161         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3162         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3163
3164         // Channel should still work fine...
3165         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3166         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3167 }
3168
3169 #[test]
3170 fn test_drop_messages_peer_disconnect_a() {
3171         do_test_drop_messages_peer_disconnect(0);
3172         do_test_drop_messages_peer_disconnect(1);
3173         do_test_drop_messages_peer_disconnect(2);
3174         do_test_drop_messages_peer_disconnect(3);
3175 }
3176
3177 #[test]
3178 fn test_drop_messages_peer_disconnect_b() {
3179         do_test_drop_messages_peer_disconnect(4);
3180         do_test_drop_messages_peer_disconnect(5);
3181         do_test_drop_messages_peer_disconnect(6);
3182 }
3183
3184 #[test]
3185 fn test_funding_peer_disconnect() {
3186         // Test that we can lock in our funding tx while disconnected
3187         let node_cfgs = create_node_cfgs(2);
3188         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3189         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3190         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3191
3192         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3193         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3194
3195         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3196         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3197         assert_eq!(events_1.len(), 1);
3198         match events_1[0] {
3199                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3200                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3201                 },
3202                 _ => panic!("Unexpected event"),
3203         }
3204
3205         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3206
3207         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3208         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3209
3210         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3211         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3212         assert_eq!(events_2.len(), 2);
3213         let funding_locked = match events_2[0] {
3214                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3215                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3216                         msg.clone()
3217                 },
3218                 _ => panic!("Unexpected event"),
3219         };
3220         let bs_announcement_sigs = match events_2[1] {
3221                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3222                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3223                         msg.clone()
3224                 },
3225                 _ => panic!("Unexpected event"),
3226         };
3227
3228         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3229
3230         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3231         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3232         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3233         assert_eq!(events_3.len(), 2);
3234         let as_announcement_sigs = match events_3[0] {
3235                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3236                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3237                         msg.clone()
3238                 },
3239                 _ => panic!("Unexpected event"),
3240         };
3241         let (as_announcement, as_update) = match events_3[1] {
3242                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3243                         (msg.clone(), update_msg.clone())
3244                 },
3245                 _ => panic!("Unexpected event"),
3246         };
3247
3248         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3249         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3250         assert_eq!(events_4.len(), 1);
3251         let (_, bs_update) = match events_4[0] {
3252                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3253                         (msg.clone(), update_msg.clone())
3254                 },
3255                 _ => panic!("Unexpected event"),
3256         };
3257
3258         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3259         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3260         nodes[0].router.handle_channel_update(&as_update).unwrap();
3261
3262         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3263         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3264         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3265 }
3266
3267 #[test]
3268 fn test_drop_messages_peer_disconnect_dual_htlc() {
3269         // Test that we can handle reconnecting when both sides of a channel have pending
3270         // commitment_updates when we disconnect.
3271         let node_cfgs = create_node_cfgs(2);
3272         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3273         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3274         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3275
3276         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3277
3278         // Now try to send a second payment which will fail to send
3279         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3280         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3281
3282         nodes[0].node.send_payment(route.clone(), payment_hash_2, None).unwrap();
3283         check_added_monitors!(nodes[0], 1);
3284
3285         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3286         assert_eq!(events_1.len(), 1);
3287         match events_1[0] {
3288                 MessageSendEvent::UpdateHTLCs { .. } => {},
3289                 _ => panic!("Unexpected event"),
3290         }
3291
3292         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3293         check_added_monitors!(nodes[1], 1);
3294
3295         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3296         assert_eq!(events_2.len(), 1);
3297         match events_2[0] {
3298                 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 } } => {
3299                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3300                         assert!(update_add_htlcs.is_empty());
3301                         assert_eq!(update_fulfill_htlcs.len(), 1);
3302                         assert!(update_fail_htlcs.is_empty());
3303                         assert!(update_fail_malformed_htlcs.is_empty());
3304                         assert!(update_fee.is_none());
3305
3306                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3307                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3308                         assert_eq!(events_3.len(), 1);
3309                         match events_3[0] {
3310                                 Event::PaymentSent { ref payment_preimage } => {
3311                                         assert_eq!(*payment_preimage, payment_preimage_1);
3312                                 },
3313                                 _ => panic!("Unexpected event"),
3314                         }
3315
3316                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3317                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3318                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3319                         check_added_monitors!(nodes[0], 1);
3320                 },
3321                 _ => panic!("Unexpected event"),
3322         }
3323
3324         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3325         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3326
3327         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3328         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3329         assert_eq!(reestablish_1.len(), 1);
3330         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3331         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3332         assert_eq!(reestablish_2.len(), 1);
3333
3334         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3335         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3336         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3337         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3338
3339         assert!(as_resp.0.is_none());
3340         assert!(bs_resp.0.is_none());
3341
3342         assert!(bs_resp.1.is_none());
3343         assert!(bs_resp.2.is_none());
3344
3345         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3346
3347         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3348         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3349         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3350         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3351         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3352         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3353         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3354         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3355         // No commitment_signed so get_event_msg's assert(len == 1) passes
3356         check_added_monitors!(nodes[1], 1);
3357
3358         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3359         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3360         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3361         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3362         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3363         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3364         assert!(bs_second_commitment_signed.update_fee.is_none());
3365         check_added_monitors!(nodes[1], 1);
3366
3367         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3368         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3369         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3370         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3371         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3372         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3373         assert!(as_commitment_signed.update_fee.is_none());
3374         check_added_monitors!(nodes[0], 1);
3375
3376         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3377         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3378         // No commitment_signed so get_event_msg's assert(len == 1) passes
3379         check_added_monitors!(nodes[0], 1);
3380
3381         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3382         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3383         // No commitment_signed so get_event_msg's assert(len == 1) passes
3384         check_added_monitors!(nodes[1], 1);
3385
3386         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3387         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3388         check_added_monitors!(nodes[1], 1);
3389
3390         expect_pending_htlcs_forwardable!(nodes[1]);
3391
3392         let events_5 = nodes[1].node.get_and_clear_pending_events();
3393         assert_eq!(events_5.len(), 1);
3394         match events_5[0] {
3395                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3396                         assert_eq!(payment_hash_2, *payment_hash);
3397                         assert_eq!(*payment_secret, None);
3398                 },
3399                 _ => panic!("Unexpected event"),
3400         }
3401
3402         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3403         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3404         check_added_monitors!(nodes[0], 1);
3405
3406         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3407 }
3408
3409 #[test]
3410 fn test_invalid_channel_announcement() {
3411         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3412         let secp_ctx = Secp256k1::new();
3413         let node_cfgs = create_node_cfgs(2);
3414         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3415         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3416
3417         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3418
3419         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3420         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3421         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3422         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3423
3424         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3425
3426         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().inner.funding_key);
3427         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().inner.funding_key);
3428
3429         let as_network_key = nodes[0].node.get_our_node_id();
3430         let bs_network_key = nodes[1].node.get_our_node_id();
3431
3432         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3433
3434         let mut chan_announcement;
3435
3436         macro_rules! dummy_unsigned_msg {
3437                 () => {
3438                         msgs::UnsignedChannelAnnouncement {
3439                                 features: ChannelFeatures::supported(),
3440                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3441                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3442                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3443                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3444                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3445                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3446                                 excess_data: Vec::new(),
3447                         };
3448                 }
3449         }
3450
3451         macro_rules! sign_msg {
3452                 ($unsigned_msg: expr) => {
3453                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3454                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
3455                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
3456                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3457                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3458                         chan_announcement = msgs::ChannelAnnouncement {
3459                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3460                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3461                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3462                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3463                                 contents: $unsigned_msg
3464                         }
3465                 }
3466         }
3467
3468         let unsigned_msg = dummy_unsigned_msg!();
3469         sign_msg!(unsigned_msg);
3470         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3471         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 } );
3472
3473         // Configured with Network::Testnet
3474         let mut unsigned_msg = dummy_unsigned_msg!();
3475         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3476         sign_msg!(unsigned_msg);
3477         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3478
3479         let mut unsigned_msg = dummy_unsigned_msg!();
3480         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3481         sign_msg!(unsigned_msg);
3482         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3483 }
3484
3485 #[test]
3486 fn test_no_txn_manager_serialize_deserialize() {
3487         let node_cfgs = create_node_cfgs(2);
3488         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3489         let new_chan_monitor: test_utils::TestChannelMonitor;
3490         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3491         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3492
3493         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3494
3495         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3496
3497         let nodes_0_serialized = nodes[0].node.encode();
3498         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3499         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3500
3501         new_chan_monitor = 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 }));
3502         nodes[0].chan_monitor = &new_chan_monitor;
3503         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3504         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3505         assert!(chan_0_monitor_read.is_empty());
3506
3507         let mut nodes_0_read = &nodes_0_serialized[..];
3508         let config = UserConfig::default();
3509         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3510         let (_, nodes_0_deserialized_tmp) = {
3511                 let mut channel_monitors = HashMap::new();
3512                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3513                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3514                         default_config: config,
3515                         keys_manager,
3516                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3517                         monitor: nodes[0].chan_monitor,
3518                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3519                         logger: Arc::new(test_utils::TestLogger::new()),
3520                         channel_monitors: &mut channel_monitors,
3521                 }).unwrap()
3522         };
3523         nodes_0_deserialized = nodes_0_deserialized_tmp;
3524         assert!(nodes_0_read.is_empty());
3525
3526         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3527         nodes[0].node = &nodes_0_deserialized;
3528         nodes[0].block_notifier.register_listener(nodes[0].node);
3529         assert_eq!(nodes[0].node.list_channels().len(), 1);
3530         check_added_monitors!(nodes[0], 1);
3531
3532         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3533         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3534         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3535         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3536
3537         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3538         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3539         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3540         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3541
3542         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3543         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3544         for node in nodes.iter() {
3545                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3546                 node.router.handle_channel_update(&as_update).unwrap();
3547                 node.router.handle_channel_update(&bs_update).unwrap();
3548         }
3549
3550         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3551 }
3552
3553 #[test]
3554 fn test_simple_manager_serialize_deserialize() {
3555         let node_cfgs = create_node_cfgs(2);
3556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3557         let new_chan_monitor: test_utils::TestChannelMonitor;
3558         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3559         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3560         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3561
3562         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3563         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3564
3565         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3566
3567         let nodes_0_serialized = nodes[0].node.encode();
3568         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3569         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3570
3571         new_chan_monitor = 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 }));
3572         nodes[0].chan_monitor = &new_chan_monitor;
3573         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3574         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3575         assert!(chan_0_monitor_read.is_empty());
3576
3577         let mut nodes_0_read = &nodes_0_serialized[..];
3578         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3579         let (_, nodes_0_deserialized_tmp) = {
3580                 let mut channel_monitors = HashMap::new();
3581                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3582                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3583                         default_config: UserConfig::default(),
3584                         keys_manager,
3585                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3586                         monitor: nodes[0].chan_monitor,
3587                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3588                         logger: Arc::new(test_utils::TestLogger::new()),
3589                         channel_monitors: &mut channel_monitors,
3590                 }).unwrap()
3591         };
3592         nodes_0_deserialized = nodes_0_deserialized_tmp;
3593         assert!(nodes_0_read.is_empty());
3594
3595         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3596         nodes[0].node = &nodes_0_deserialized;
3597         check_added_monitors!(nodes[0], 1);
3598
3599         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3600
3601         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3602         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3603 }
3604
3605 #[test]
3606 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3607         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3608         let node_cfgs = create_node_cfgs(4);
3609         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3610         let new_chan_monitor: test_utils::TestChannelMonitor;
3611         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>;
3612         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3613         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3614         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3615         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3616
3617         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3618
3619         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3620         let nodes_0_serialized = nodes[0].node.encode();
3621
3622         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3623         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3624         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3625         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3626
3627         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3628         // nodes[3])
3629         let mut node_0_monitors_serialized = Vec::new();
3630         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3631                 let mut writer = test_utils::TestVecWriter(Vec::new());
3632                 monitor.1.write_for_disk(&mut writer).unwrap();
3633                 node_0_monitors_serialized.push(writer.0);
3634         }
3635
3636         new_chan_monitor = 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 }));
3637         nodes[0].chan_monitor = &new_chan_monitor;
3638         let mut node_0_monitors = Vec::new();
3639         for serialized in node_0_monitors_serialized.iter() {
3640                 let mut read = &serialized[..];
3641                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3642                 assert!(read.is_empty());
3643                 node_0_monitors.push(monitor);
3644         }
3645
3646         let mut nodes_0_read = &nodes_0_serialized[..];
3647         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3648         let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3649                 default_config: UserConfig::default(),
3650                 keys_manager,
3651                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3652                 monitor: nodes[0].chan_monitor,
3653                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3654                 logger: Arc::new(test_utils::TestLogger::new()),
3655                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3656         }).unwrap();
3657         nodes_0_deserialized = nodes_0_deserialized_tmp;
3658         assert!(nodes_0_read.is_empty());
3659
3660         { // Channel close should result in a commitment tx and an HTLC tx
3661                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3662                 assert_eq!(txn.len(), 2);
3663                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3664                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3665         }
3666
3667         for monitor in node_0_monitors.drain(..) {
3668                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3669                 check_added_monitors!(nodes[0], 1);
3670         }
3671         nodes[0].node = &nodes_0_deserialized;
3672
3673         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3674         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3675         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3676         //... and we can even still claim the payment!
3677         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3678
3679         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3680         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3681         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3682         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3683         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3684         assert_eq!(msg_events.len(), 1);
3685         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3686                 match action {
3687                         &ErrorAction::SendErrorMessage { ref msg } => {
3688                                 assert_eq!(msg.channel_id, channel_id);
3689                         },
3690                         _ => panic!("Unexpected event!"),
3691                 }
3692         }
3693 }
3694
3695 macro_rules! check_spendable_outputs {
3696         ($node: expr, $der_idx: expr) => {
3697                 {
3698                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3699                         let mut txn = Vec::new();
3700                         for event in events {
3701                                 match event {
3702                                         Event::SpendableOutputs { ref outputs } => {
3703                                                 for outp in outputs {
3704                                                         match *outp {
3705                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3706                                                                         let input = TxIn {
3707                                                                                 previous_output: outpoint.clone(),
3708                                                                                 script_sig: Script::new(),
3709                                                                                 sequence: 0,
3710                                                                                 witness: Vec::new(),
3711                                                                         };
3712                                                                         let outp = TxOut {
3713                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3714                                                                                 value: output.value,
3715                                                                         };
3716                                                                         let mut spend_tx = Transaction {
3717                                                                                 version: 2,
3718                                                                                 lock_time: 0,
3719                                                                                 input: vec![input],
3720                                                                                 output: vec![outp],
3721                                                                         };
3722                                                                         let secp_ctx = Secp256k1::new();
3723                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3724                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3725                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3726                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3727                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3728                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3729                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3730                                                                         txn.push(spend_tx);
3731                                                                 },
3732                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3733                                                                         let input = TxIn {
3734                                                                                 previous_output: outpoint.clone(),
3735                                                                                 script_sig: Script::new(),
3736                                                                                 sequence: *to_self_delay as u32,
3737                                                                                 witness: Vec::new(),
3738                                                                         };
3739                                                                         let outp = TxOut {
3740                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3741                                                                                 value: output.value,
3742                                                                         };
3743                                                                         let mut spend_tx = Transaction {
3744                                                                                 version: 2,
3745                                                                                 lock_time: 0,
3746                                                                                 input: vec![input],
3747                                                                                 output: vec![outp],
3748                                                                         };
3749                                                                         let secp_ctx = Secp256k1::new();
3750                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3751                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3752                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3753                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3754                                                                         spend_tx.input[0].witness.push(vec!(0));
3755                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3756                                                                         txn.push(spend_tx);
3757                                                                 },
3758                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3759                                                                         let secp_ctx = Secp256k1::new();
3760                                                                         let input = TxIn {
3761                                                                                 previous_output: outpoint.clone(),
3762                                                                                 script_sig: Script::new(),
3763                                                                                 sequence: 0,
3764                                                                                 witness: Vec::new(),
3765                                                                         };
3766                                                                         let outp = TxOut {
3767                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3768                                                                                 value: output.value,
3769                                                                         };
3770                                                                         let mut spend_tx = Transaction {
3771                                                                                 version: 2,
3772                                                                                 lock_time: 0,
3773                                                                                 input: vec![input],
3774                                                                                 output: vec![outp.clone()],
3775                                                                         };
3776                                                                         let secret = {
3777                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3778                                                                                         Ok(master_key) => {
3779                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3780                                                                                                         Ok(key) => key,
3781                                                                                                         Err(_) => panic!("Your RNG is busted"),
3782                                                                                                 }
3783                                                                                         }
3784                                                                                         Err(_) => panic!("Your rng is busted"),
3785                                                                                 }
3786                                                                         };
3787                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3788                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3789                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3790                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3791                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3792                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3793                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3794                                                                         txn.push(spend_tx);
3795                                                                 },
3796                                                         }
3797                                                 }
3798                                         },
3799                                         _ => panic!("Unexpected event"),
3800                                 };
3801                         }
3802                         txn
3803                 }
3804         }
3805 }
3806
3807 #[test]
3808 fn test_claim_sizeable_push_msat() {
3809         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3810         let node_cfgs = create_node_cfgs(2);
3811         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3812         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3813
3814         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3815         nodes[1].node.force_close_channel(&chan.2);
3816         check_closed_broadcast!(nodes[1], false);
3817         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3818         assert_eq!(node_txn.len(), 1);
3819         check_spends!(node_txn[0], chan.3.clone());
3820         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
3821
3822         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3823         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3824         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3825         assert_eq!(spend_txn.len(), 1);
3826         check_spends!(spend_txn[0], node_txn[0].clone());
3827 }
3828
3829 #[test]
3830 fn test_claim_on_remote_sizeable_push_msat() {
3831         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3832         // to_remote output is encumbered by a P2WPKH
3833         let node_cfgs = create_node_cfgs(2);
3834         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3835         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3836
3837         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
3838         nodes[0].node.force_close_channel(&chan.2);
3839         check_closed_broadcast!(nodes[0], false);
3840
3841         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3842         assert_eq!(node_txn.len(), 1);
3843         check_spends!(node_txn[0], chan.3.clone());
3844         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
3845
3846         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3847         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3848         check_closed_broadcast!(nodes[1], false);
3849         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3850         assert_eq!(spend_txn.len(), 2);
3851         assert_eq!(spend_txn[0], spend_txn[1]);
3852         check_spends!(spend_txn[0], node_txn[0].clone());
3853 }
3854
3855 #[test]
3856 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3857         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3858         // to_remote output is encumbered by a P2WPKH
3859
3860         let node_cfgs = create_node_cfgs(2);
3861         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3862         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3863
3864         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
3865         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3866         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3867         assert_eq!(revoked_local_txn[0].input.len(), 1);
3868         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3869
3870         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3871         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3872         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3873         check_closed_broadcast!(nodes[1], false);
3874
3875         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3876         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3877         assert_eq!(spend_txn.len(), 4);
3878         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3879         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3880         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3881         check_spends!(spend_txn[1], node_txn[0].clone());
3882 }
3883
3884 #[test]
3885 fn test_static_spendable_outputs_preimage_tx() {
3886         let node_cfgs = create_node_cfgs(2);
3887         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3888         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3889
3890         // Create some initial channels
3891         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3892
3893         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3894
3895         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3896         assert_eq!(commitment_tx[0].input.len(), 1);
3897         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3898
3899         // Settle A's commitment tx on B's chain
3900         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3901         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
3902         check_added_monitors!(nodes[1], 1);
3903         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3904         let events = nodes[1].node.get_and_clear_pending_msg_events();
3905         match events[0] {
3906                 MessageSendEvent::UpdateHTLCs { .. } => {},
3907                 _ => panic!("Unexpected event"),
3908         }
3909         match events[1] {
3910                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3911                 _ => panic!("Unexepected event"),
3912         }
3913
3914         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3915         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: 2 (1 preimage tx)
3916         assert_eq!(node_txn.len(), 4);
3917         check_spends!(node_txn[0], commitment_tx[0].clone());
3918         assert_eq!(node_txn[0], node_txn[3]);
3919         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3920 eprintln!("{:?}", node_txn[1]);
3921         check_spends!(node_txn[1], chan_1.3.clone());
3922         check_spends!(node_txn[2], node_txn[1]);
3923
3924         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3925         assert_eq!(spend_txn.len(), 2);
3926         assert_eq!(spend_txn[0], spend_txn[1]);
3927         check_spends!(spend_txn[0], node_txn[0].clone());
3928 }
3929
3930 #[test]
3931 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3932         let node_cfgs = create_node_cfgs(2);
3933         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3934         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3935
3936         // Create some initial channels
3937         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3938
3939         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3940         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter_mut().next().unwrap().1.channel_monitor().get_latest_local_commitment_txn();
3941         assert_eq!(revoked_local_txn[0].input.len(), 1);
3942         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3943
3944         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3945
3946         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3947         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3948         check_closed_broadcast!(nodes[1], false);
3949
3950         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3951         assert_eq!(node_txn.len(), 3);
3952         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3953         assert_eq!(node_txn[0].input.len(), 2);
3954         check_spends!(node_txn[0], revoked_local_txn[0].clone());
3955
3956         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3957         assert_eq!(spend_txn.len(), 2);
3958         assert_eq!(spend_txn[0], spend_txn[1]);
3959         check_spends!(spend_txn[0], node_txn[0].clone());
3960 }
3961
3962 #[test]
3963 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3964         let node_cfgs = create_node_cfgs(2);
3965         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3966         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3967
3968         // Create some initial channels
3969         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3970
3971         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3972         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
3973         assert_eq!(revoked_local_txn[0].input.len(), 1);
3974         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3975
3976         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3977
3978         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3979         // A will generate HTLC-Timeout from revoked commitment tx
3980         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3981         check_closed_broadcast!(nodes[0], false);
3982
3983         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3984         assert_eq!(revoked_htlc_txn.len(), 3);
3985         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3986         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3987         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3988         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3989         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3990
3991         // B will generate justice tx from A's revoked commitment/HTLC tx
3992         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3993         check_closed_broadcast!(nodes[1], false);
3994
3995         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3996         assert_eq!(node_txn.len(), 5);
3997         assert_eq!(node_txn[3].input.len(), 1);
3998         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3999
4000         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4001         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4002         assert_eq!(spend_txn.len(), 3);
4003         assert_eq!(spend_txn[0], spend_txn[1]);
4004         check_spends!(spend_txn[0], node_txn[0].clone());
4005         check_spends!(spend_txn[2], node_txn[3].clone());
4006 }
4007
4008 #[test]
4009 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4010         let node_cfgs = create_node_cfgs(2);
4011         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4012         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4013
4014         // Create some initial channels
4015         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4016
4017         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4018         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4019         assert_eq!(revoked_local_txn[0].input.len(), 1);
4020         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4021
4022         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4023
4024         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4025         // B will generate HTLC-Success from revoked commitment tx
4026         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4027         check_closed_broadcast!(nodes[1], false);
4028         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4029
4030         assert_eq!(revoked_htlc_txn.len(), 3);
4031         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4032         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4033         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4034         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
4035
4036         // A will generate justice tx from B's revoked commitment/HTLC tx
4037         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4038         check_closed_broadcast!(nodes[0], false);
4039
4040         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4041         assert_eq!(node_txn.len(), 4);
4042         assert_eq!(node_txn[3].input.len(), 1);
4043         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
4044
4045         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4046         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4047         assert_eq!(spend_txn.len(), 5);
4048         assert_eq!(spend_txn[0], spend_txn[2]);
4049         assert_eq!(spend_txn[1], spend_txn[3]);
4050         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
4051         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
4052         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
4053 }
4054
4055 #[test]
4056 fn test_onchain_to_onchain_claim() {
4057         // Test that in case of channel closure, we detect the state of output thanks to
4058         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4059         // First, have C claim an HTLC against its own latest commitment transaction.
4060         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4061         // channel.
4062         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4063         // gets broadcast.
4064
4065         let node_cfgs = create_node_cfgs(3);
4066         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4067         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4068
4069         // Create some initial channels
4070         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4071         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4072
4073         // Rebalance the network a bit by relaying one payment through all the channels ...
4074         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4075         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4076
4077         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4078         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4079         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4080         check_spends!(commitment_tx[0], chan_2.3.clone());
4081         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4082         check_added_monitors!(nodes[2], 1);
4083         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4084         assert!(updates.update_add_htlcs.is_empty());
4085         assert!(updates.update_fail_htlcs.is_empty());
4086         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4087         assert!(updates.update_fail_malformed_htlcs.is_empty());
4088
4089         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4090         check_closed_broadcast!(nodes[2], false);
4091
4092         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4093         assert_eq!(c_txn.len(), 4);
4094         assert_eq!(c_txn[0], c_txn[2]);
4095         assert_eq!(c_txn[0], c_txn[3]);
4096         assert_eq!(commitment_tx[0], c_txn[1]);
4097         check_spends!(c_txn[1], chan_2.3.clone());
4098         check_spends!(c_txn[2], c_txn[1].clone());
4099         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4100         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4101         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4102         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4103
4104         // 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
4105         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4106         {
4107                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4108                 assert_eq!(b_txn.len(), 4);
4109                 assert_eq!(b_txn[0], b_txn[3]);
4110                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4111                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4112                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4113                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4114                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4115                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4116                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4117                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4118                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4119                 b_txn.clear();
4120         }
4121         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4122         check_added_monitors!(nodes[1], 1);
4123         match msg_events[0] {
4124                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4125                 _ => panic!("Unexpected event"),
4126         }
4127         match msg_events[1] {
4128                 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, .. } } => {
4129                         assert!(update_add_htlcs.is_empty());
4130                         assert!(update_fail_htlcs.is_empty());
4131                         assert_eq!(update_fulfill_htlcs.len(), 1);
4132                         assert!(update_fail_malformed_htlcs.is_empty());
4133                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4134                 },
4135                 _ => panic!("Unexpected event"),
4136         };
4137         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4138         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4139         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4140         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4141         assert_eq!(b_txn.len(), 4);
4142         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
4143         check_spends!(b_txn[2], b_txn[1]); // HTLC-Success tx, as a part of the local txn rebroadcast by ChannelManager in the force close
4144         assert_eq!(b_txn[0], b_txn[3]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
4145         check_spends!(b_txn[0], commitment_tx[0].clone());
4146         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4147         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4148         assert_eq!(b_txn[2].lock_time, 0); // Success tx
4149
4150         check_closed_broadcast!(nodes[1], false);
4151 }
4152
4153 #[test]
4154 fn test_duplicate_payment_hash_one_failure_one_success() {
4155         // Topology : A --> B --> C
4156         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4157         let node_cfgs = create_node_cfgs(3);
4158         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4159         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4160
4161         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4162         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4163
4164         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4165         *nodes[0].network_payment_count.borrow_mut() -= 1;
4166         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4167
4168         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get_mut(&chan_2.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4169         assert_eq!(commitment_txn[0].input.len(), 1);
4170         check_spends!(commitment_txn[0], chan_2.3.clone());
4171
4172         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4173         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4174         check_closed_broadcast!(nodes[1], false);
4175
4176         let htlc_timeout_tx;
4177         { // Extract one of the two HTLC-Timeout transaction
4178                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4179                 assert_eq!(node_txn.len(), 7);
4180                 assert_eq!(node_txn[0], node_txn[5]);
4181                 assert_eq!(node_txn[1], node_txn[6]);
4182                 check_spends!(node_txn[0], commitment_txn[0].clone());
4183                 assert_eq!(node_txn[0].input.len(), 1);
4184                 check_spends!(node_txn[1], commitment_txn[0].clone());
4185                 assert_eq!(node_txn[1].input.len(), 1);
4186                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4187                 check_spends!(node_txn[2], chan_2.3.clone());
4188                 check_spends!(node_txn[3], node_txn[2].clone());
4189                 check_spends!(node_txn[4], node_txn[2].clone());
4190                 htlc_timeout_tx = node_txn[1].clone();
4191         }
4192
4193         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4194         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4195         check_added_monitors!(nodes[2], 2);
4196         let events = nodes[2].node.get_and_clear_pending_msg_events();
4197         match events[0] {
4198                 MessageSendEvent::UpdateHTLCs { .. } => {},
4199                 _ => panic!("Unexpected event"),
4200         }
4201         match events[1] {
4202                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4203                 _ => panic!("Unexepected event"),
4204         }
4205         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4206         assert_eq!(htlc_success_txn.len(), 7);
4207         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4208         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4209         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4210         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4211         assert_eq!(htlc_success_txn[0].input.len(), 1);
4212         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4213         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4214         assert_eq!(htlc_success_txn[1].input.len(), 1);
4215         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4216         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4217         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4218         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4219
4220         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4221         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4222         expect_pending_htlcs_forwardable!(nodes[1]);
4223         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4224         assert!(htlc_updates.update_add_htlcs.is_empty());
4225         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4226         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4227         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4228         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4229         check_added_monitors!(nodes[1], 1);
4230
4231         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4232         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4233         {
4234                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4235                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4236                 assert_eq!(events.len(), 1);
4237                 match events[0] {
4238                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4239                         },
4240                         _ => { panic!("Unexpected event"); }
4241                 }
4242         }
4243         let events = nodes[0].node.get_and_clear_pending_events();
4244         match events[0] {
4245                 Event::PaymentFailed { ref payment_hash, .. } => {
4246                         assert_eq!(*payment_hash, duplicate_payment_hash);
4247                 }
4248                 _ => panic!("Unexpected event"),
4249         }
4250
4251         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4252         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4253         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4254         assert!(updates.update_add_htlcs.is_empty());
4255         assert!(updates.update_fail_htlcs.is_empty());
4256         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4257         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4258         assert!(updates.update_fail_malformed_htlcs.is_empty());
4259         check_added_monitors!(nodes[1], 1);
4260
4261         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4262         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4263
4264         let events = nodes[0].node.get_and_clear_pending_events();
4265         match events[0] {
4266                 Event::PaymentSent { ref payment_preimage } => {
4267                         assert_eq!(*payment_preimage, our_payment_preimage);
4268                 }
4269                 _ => panic!("Unexpected event"),
4270         }
4271 }
4272
4273 #[test]
4274 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4275         let node_cfgs = create_node_cfgs(2);
4276         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4277         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4278
4279         // Create some initial channels
4280         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4281
4282         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4283         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4284         assert_eq!(local_txn[0].input.len(), 1);
4285         check_spends!(local_txn[0], chan_1.3.clone());
4286
4287         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4288         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4289         check_added_monitors!(nodes[1], 1);
4290         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4291         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4292         let events = nodes[1].node.get_and_clear_pending_msg_events();
4293         match events[0] {
4294                 MessageSendEvent::UpdateHTLCs { .. } => {},
4295                 _ => panic!("Unexpected event"),
4296         }
4297         match events[1] {
4298                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4299                 _ => panic!("Unexepected event"),
4300         }
4301         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4302         assert_eq!(node_txn[0].input.len(), 1);
4303         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4304         check_spends!(node_txn[0], local_txn[0].clone());
4305
4306         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4307         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4308         assert_eq!(spend_txn.len(), 2);
4309         check_spends!(spend_txn[0], node_txn[0].clone());
4310         check_spends!(spend_txn[1], node_txn[2].clone());
4311 }
4312
4313 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4314         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4315         // unrevoked commitment transaction.
4316         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4317         // a remote RAA before they could be failed backwards (and combinations thereof).
4318         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4319         // use the same payment hashes.
4320         // Thus, we use a six-node network:
4321         //
4322         // A \         / E
4323         //    - C - D -
4324         // B /         \ F
4325         // And test where C fails back to A/B when D announces its latest commitment transaction
4326         let node_cfgs = create_node_cfgs(6);
4327         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4328         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4329
4330         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4331         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4332         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4333         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4334         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4335
4336         // Rebalance and check output sanity...
4337         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4338         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4339         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 2);
4340
4341         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4342         // 0th HTLC:
4343         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
4344         // 1st HTLC:
4345         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
4346         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();
4347         // 2nd HTLC:
4348         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
4349         // 3rd HTLC:
4350         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
4351         // 4th HTLC:
4352         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4353         // 5th HTLC:
4354         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4355         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4356         // 6th HTLC:
4357         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4358         // 7th HTLC:
4359         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4360
4361         // 8th HTLC:
4362         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4363         // 9th HTLC:
4364         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();
4365         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
4366
4367         // 10th HTLC:
4368         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
4369         // 11th HTLC:
4370         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4371         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4372
4373         // Double-check that six of the new HTLC were added
4374         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4375         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4376         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn().len(), 1);
4377         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn()[0].output.len(), 8);
4378
4379         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4380         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4381         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4382         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4383         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4384         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4385         check_added_monitors!(nodes[4], 0);
4386         expect_pending_htlcs_forwardable!(nodes[4]);
4387         check_added_monitors!(nodes[4], 1);
4388
4389         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4390         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4391         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4392         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4393         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4394         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4395
4396         // Fail 3rd below-dust and 7th above-dust HTLCs
4397         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4398         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4399         check_added_monitors!(nodes[5], 0);
4400         expect_pending_htlcs_forwardable!(nodes[5]);
4401         check_added_monitors!(nodes[5], 1);
4402
4403         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4404         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4405         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4406         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4407
4408         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4409
4410         expect_pending_htlcs_forwardable!(nodes[3]);
4411         check_added_monitors!(nodes[3], 1);
4412         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4413         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4414         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4415         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4416         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4417         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4418         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4419         if deliver_last_raa {
4420                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4421         } else {
4422                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4423         }
4424
4425         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4426         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4427         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4428         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4429         //
4430         // We now broadcast the latest commitment transaction, which *should* result in failures for
4431         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4432         // the non-broadcast above-dust HTLCs.
4433         //
4434         // Alternatively, we may broadcast the previous commitment transaction, which should only
4435         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4436         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4437
4438         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4439         if announce_latest {
4440                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4441         } else {
4442                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4443         }
4444         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4445         check_closed_broadcast!(nodes[2], false);
4446         expect_pending_htlcs_forwardable!(nodes[2]);
4447         check_added_monitors!(nodes[2], 2);
4448
4449         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4450         assert_eq!(cs_msgs.len(), 2);
4451         let mut a_done = false;
4452         for msg in cs_msgs {
4453                 match msg {
4454                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4455                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4456                                 // should be failed-backwards here.
4457                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4458                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4459                                         for htlc in &updates.update_fail_htlcs {
4460                                                 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 });
4461                                         }
4462                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4463                                         assert!(!a_done);
4464                                         a_done = true;
4465                                         &nodes[0]
4466                                 } else {
4467                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4468                                         for htlc in &updates.update_fail_htlcs {
4469                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4470                                         }
4471                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4472                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4473                                         &nodes[1]
4474                                 };
4475                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4476                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4477                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4478                                 if announce_latest {
4479                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4480                                         if *node_id == nodes[0].node.get_our_node_id() {
4481                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4482                                         }
4483                                 }
4484                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4485                         },
4486                         _ => panic!("Unexpected event"),
4487                 }
4488         }
4489
4490         let as_events = nodes[0].node.get_and_clear_pending_events();
4491         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4492         let mut as_failds = HashSet::new();
4493         for event in as_events.iter() {
4494                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4495                         assert!(as_failds.insert(*payment_hash));
4496                         if *payment_hash != payment_hash_2 {
4497                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4498                         } else {
4499                                 assert!(!rejected_by_dest);
4500                         }
4501                 } else { panic!("Unexpected event"); }
4502         }
4503         assert!(as_failds.contains(&payment_hash_1));
4504         assert!(as_failds.contains(&payment_hash_2));
4505         if announce_latest {
4506                 assert!(as_failds.contains(&payment_hash_3));
4507                 assert!(as_failds.contains(&payment_hash_5));
4508         }
4509         assert!(as_failds.contains(&payment_hash_6));
4510
4511         let bs_events = nodes[1].node.get_and_clear_pending_events();
4512         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4513         let mut bs_failds = HashSet::new();
4514         for event in bs_events.iter() {
4515                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4516                         assert!(bs_failds.insert(*payment_hash));
4517                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4518                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4519                         } else {
4520                                 assert!(!rejected_by_dest);
4521                         }
4522                 } else { panic!("Unexpected event"); }
4523         }
4524         assert!(bs_failds.contains(&payment_hash_1));
4525         assert!(bs_failds.contains(&payment_hash_2));
4526         if announce_latest {
4527                 assert!(bs_failds.contains(&payment_hash_4));
4528         }
4529         assert!(bs_failds.contains(&payment_hash_5));
4530
4531         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4532         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4533         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4534         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4535         // PaymentFailureNetworkUpdates.
4536         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4537         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4538         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4539         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4540         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4541                 match event {
4542                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4543                         _ => panic!("Unexpected event"),
4544                 }
4545         }
4546 }
4547
4548 #[test]
4549 fn test_fail_backwards_latest_remote_announce_a() {
4550         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4551 }
4552
4553 #[test]
4554 fn test_fail_backwards_latest_remote_announce_b() {
4555         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4556 }
4557
4558 #[test]
4559 fn test_fail_backwards_previous_remote_announce() {
4560         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4561         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4562         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4563 }
4564
4565 #[test]
4566 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4567         let node_cfgs = create_node_cfgs(2);
4568         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4569         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4570
4571         // Create some initial channels
4572         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4573
4574         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4575         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
4576         assert_eq!(local_txn[0].input.len(), 1);
4577         check_spends!(local_txn[0], chan_1.3.clone());
4578
4579         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4580         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4581         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4582         check_closed_broadcast!(nodes[0], false);
4583
4584         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4585         assert_eq!(node_txn[0].input.len(), 1);
4586         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4587         check_spends!(node_txn[0], local_txn[0].clone());
4588
4589         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4590         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4591         assert_eq!(spend_txn.len(), 8);
4592         assert_eq!(spend_txn[0], spend_txn[2]);
4593         assert_eq!(spend_txn[0], spend_txn[4]);
4594         assert_eq!(spend_txn[0], spend_txn[6]);
4595         assert_eq!(spend_txn[1], spend_txn[3]);
4596         assert_eq!(spend_txn[1], spend_txn[5]);
4597         assert_eq!(spend_txn[1], spend_txn[7]);
4598         check_spends!(spend_txn[0], local_txn[0].clone());
4599         check_spends!(spend_txn[1], node_txn[0].clone());
4600 }
4601
4602 #[test]
4603 fn test_static_output_closing_tx() {
4604         let node_cfgs = create_node_cfgs(2);
4605         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4606         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4607
4608         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4609
4610         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4611         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4612
4613         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4614         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4615         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4616         assert_eq!(spend_txn.len(), 1);
4617         check_spends!(spend_txn[0], closing_tx.clone());
4618
4619         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4620         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4621         assert_eq!(spend_txn.len(), 1);
4622         check_spends!(spend_txn[0], closing_tx);
4623 }
4624
4625 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4626         let node_cfgs = create_node_cfgs(2);
4627         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4628         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4629         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4630
4631         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4632
4633         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4634         // present in B's local commitment transaction, but none of A's commitment transactions.
4635         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
4636         check_added_monitors!(nodes[1], 1);
4637
4638         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4639         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
4640         let events = nodes[0].node.get_and_clear_pending_events();
4641         assert_eq!(events.len(), 1);
4642         match events[0] {
4643                 Event::PaymentSent { payment_preimage } => {
4644                         assert_eq!(payment_preimage, our_payment_preimage);
4645                 },
4646                 _ => panic!("Unexpected event"),
4647         }
4648
4649         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4650         check_added_monitors!(nodes[0], 1);
4651         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4652         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4653         check_added_monitors!(nodes[1], 1);
4654
4655         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4656         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4657                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4658                 header.prev_blockhash = header.bitcoin_hash();
4659         }
4660         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4661         check_closed_broadcast!(nodes[1], false);
4662 }
4663
4664 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4665         let node_cfgs = create_node_cfgs(2);
4666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4667         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4668         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4669
4670         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();
4671         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4672         nodes[0].node.send_payment(route, payment_hash, None).unwrap();
4673         check_added_monitors!(nodes[0], 1);
4674
4675         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4676
4677         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4678         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4679         // to "time out" the HTLC.
4680
4681         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4682
4683         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4684                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4685                 header.prev_blockhash = header.bitcoin_hash();
4686         }
4687         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4688         check_closed_broadcast!(nodes[0], false);
4689 }
4690
4691 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4692         let node_cfgs = create_node_cfgs(3);
4693         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4694         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4695         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4696
4697         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4698         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4699         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4700         // actually revoked.
4701         let htlc_value = if use_dust { 50000 } else { 3000000 };
4702         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4703         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
4704         expect_pending_htlcs_forwardable!(nodes[1]);
4705         check_added_monitors!(nodes[1], 1);
4706
4707         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4708         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
4709         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
4710         check_added_monitors!(nodes[0], 1);
4711         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4712         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
4713         check_added_monitors!(nodes[1], 1);
4714         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
4715         check_added_monitors!(nodes[1], 1);
4716         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4717
4718         if check_revoke_no_close {
4719                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4720                 check_added_monitors!(nodes[0], 1);
4721         }
4722
4723         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4724         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4725                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4726                 header.prev_blockhash = header.bitcoin_hash();
4727         }
4728         if !check_revoke_no_close {
4729                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4730                 check_closed_broadcast!(nodes[0], false);
4731         } else {
4732                 let events = nodes[0].node.get_and_clear_pending_events();
4733                 assert_eq!(events.len(), 1);
4734                 match events[0] {
4735                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4736                                 assert_eq!(payment_hash, our_payment_hash);
4737                                 assert!(rejected_by_dest);
4738                         },
4739                         _ => panic!("Unexpected event"),
4740                 }
4741         }
4742 }
4743
4744 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4745 // There are only a few cases to test here:
4746 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4747 //    broadcastable commitment transactions result in channel closure,
4748 //  * its included in an unrevoked-but-previous remote commitment transaction,
4749 //  * its included in the latest remote or local commitment transactions.
4750 // We test each of the three possible commitment transactions individually and use both dust and
4751 // non-dust HTLCs.
4752 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4753 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4754 // tested for at least one of the cases in other tests.
4755 #[test]
4756 fn htlc_claim_single_commitment_only_a() {
4757         do_htlc_claim_local_commitment_only(true);
4758         do_htlc_claim_local_commitment_only(false);
4759
4760         do_htlc_claim_current_remote_commitment_only(true);
4761         do_htlc_claim_current_remote_commitment_only(false);
4762 }
4763
4764 #[test]
4765 fn htlc_claim_single_commitment_only_b() {
4766         do_htlc_claim_previous_remote_commitment_only(true, false);
4767         do_htlc_claim_previous_remote_commitment_only(false, false);
4768         do_htlc_claim_previous_remote_commitment_only(true, true);
4769         do_htlc_claim_previous_remote_commitment_only(false, true);
4770 }
4771
4772 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>)
4773         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4774                                 F2: FnMut(),
4775 {
4776         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);
4777 }
4778
4779 // test_case
4780 // 0: node1 fails backward
4781 // 1: final node fails backward
4782 // 2: payment completed but the user rejects the payment
4783 // 3: final node fails backward (but tamper onion payloads from node0)
4784 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4785 // 200: trigger error in the final node and tamper returning fail_htlc
4786 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>)
4787         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4788                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4789                                 F3: FnMut(),
4790 {
4791
4792         // reset block height
4793         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4794         for ix in 0..nodes.len() {
4795                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4796         }
4797
4798         macro_rules! expect_event {
4799                 ($node: expr, $event_type: path) => {{
4800                         let events = $node.node.get_and_clear_pending_events();
4801                         assert_eq!(events.len(), 1);
4802                         match events[0] {
4803                                 $event_type { .. } => {},
4804                                 _ => panic!("Unexpected event"),
4805                         }
4806                 }}
4807         }
4808
4809         macro_rules! expect_htlc_forward {
4810                 ($node: expr) => {{
4811                         expect_event!($node, Event::PendingHTLCsForwardable);
4812                         $node.node.process_pending_htlc_forwards();
4813                 }}
4814         }
4815
4816         // 0 ~~> 2 send payment
4817         nodes[0].node.send_payment(route.clone(), payment_hash.clone(), None).unwrap();
4818         check_added_monitors!(nodes[0], 1);
4819         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4820         // temper update_add (0 => 1)
4821         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4822         if test_case == 0 || test_case == 3 || test_case == 100 {
4823                 callback_msg(&mut update_add_0);
4824                 callback_node();
4825         }
4826         // 0 => 1 update_add & CS
4827         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
4828         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4829
4830         let update_1_0 = match test_case {
4831                 0|100 => { // intermediate node failure; fail backward to 0
4832                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4833                         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));
4834                         update_1_0
4835                 },
4836                 1|2|3|200 => { // final node failure; forwarding to 2
4837                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4838                         // forwarding on 1
4839                         if test_case != 200 {
4840                                 callback_node();
4841                         }
4842                         expect_htlc_forward!(&nodes[1]);
4843
4844                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4845                         check_added_monitors!(&nodes[1], 1);
4846                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4847                         // tamper update_add (1 => 2)
4848                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4849                         if test_case != 3 && test_case != 200 {
4850                                 callback_msg(&mut update_add_1);
4851                         }
4852
4853                         // 1 => 2
4854                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
4855                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4856
4857                         if test_case == 2 || test_case == 200 {
4858                                 expect_htlc_forward!(&nodes[2]);
4859                                 expect_event!(&nodes[2], Event::PaymentReceived);
4860                                 callback_node();
4861                                 expect_pending_htlcs_forwardable!(nodes[2]);
4862                         }
4863
4864                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4865                         if test_case == 2 || test_case == 200 {
4866                                 check_added_monitors!(&nodes[2], 1);
4867                         }
4868                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4869
4870                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4871                         if test_case == 200 {
4872                                 callback_fail(&mut fail_msg);
4873                         }
4874
4875                         // 2 => 1
4876                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
4877                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4878
4879                         // backward fail on 1
4880                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4881                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4882                         update_1_0
4883                 },
4884                 _ => unreachable!(),
4885         };
4886
4887         // 1 => 0 commitment_signed_dance
4888         if update_1_0.update_fail_htlcs.len() > 0 {
4889                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4890                 if test_case == 100 {
4891                         callback_fail(&mut fail_msg);
4892                 }
4893                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
4894         } else {
4895                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
4896         };
4897
4898         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4899
4900         let events = nodes[0].node.get_and_clear_pending_events();
4901         assert_eq!(events.len(), 1);
4902         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4903                 assert_eq!(*rejected_by_dest, !expected_retryable);
4904                 assert_eq!(*error_code, expected_error_code);
4905         } else {
4906                 panic!("Uexpected event");
4907         }
4908
4909         let events = nodes[0].node.get_and_clear_pending_msg_events();
4910         if expected_channel_update.is_some() {
4911                 assert_eq!(events.len(), 1);
4912                 match events[0] {
4913                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4914                                 match update {
4915                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4916                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4917                                                         panic!("channel_update not found!");
4918                                                 }
4919                                         },
4920                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4921                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4922                                                         assert!(*short_channel_id == *expected_short_channel_id);
4923                                                         assert!(*is_permanent == *expected_is_permanent);
4924                                                 } else {
4925                                                         panic!("Unexpected message event");
4926                                                 }
4927                                         },
4928                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4929                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4930                                                         assert!(*node_id == *expected_node_id);
4931                                                         assert!(*is_permanent == *expected_is_permanent);
4932                                                 } else {
4933                                                         panic!("Unexpected message event");
4934                                                 }
4935                                         },
4936                                 }
4937                         },
4938                         _ => panic!("Unexpected message event"),
4939                 }
4940         } else {
4941                 assert_eq!(events.len(), 0);
4942         }
4943 }
4944
4945 impl msgs::ChannelUpdate {
4946         fn dummy() -> msgs::ChannelUpdate {
4947                 use secp256k1::ffi::Signature as FFISignature;
4948                 use secp256k1::Signature;
4949                 msgs::ChannelUpdate {
4950                         signature: Signature::from(FFISignature::new()),
4951                         contents: msgs::UnsignedChannelUpdate {
4952                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4953                                 short_channel_id: 0,
4954                                 timestamp: 0,
4955                                 flags: 0,
4956                                 cltv_expiry_delta: 0,
4957                                 htlc_minimum_msat: 0,
4958                                 fee_base_msat: 0,
4959                                 fee_proportional_millionths: 0,
4960                                 excess_data: vec![],
4961                         }
4962                 }
4963         }
4964 }
4965
4966 struct BogusOnionHopData {
4967         data: Vec<u8>
4968 }
4969 impl BogusOnionHopData {
4970         fn new(orig: msgs::OnionHopData) -> Self {
4971                 Self { data: orig.encode() }
4972         }
4973 }
4974 impl Writeable for BogusOnionHopData {
4975         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4976                 writer.write_all(&self.data[..])
4977         }
4978 }
4979
4980 #[test]
4981 fn test_onion_failure() {
4982         use ln::msgs::ChannelUpdate;
4983         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4984         use secp256k1;
4985
4986         const BADONION: u16 = 0x8000;
4987         const PERM: u16 = 0x4000;
4988         const NODE: u16 = 0x2000;
4989         const UPDATE: u16 = 0x1000;
4990
4991         let node_cfgs = create_node_cfgs(3);
4992         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4993         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4994         for node in nodes.iter() {
4995                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4996         }
4997         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
4998         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4999         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5000         // positve case
5001         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5002
5003         // intermediate node failure
5004         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5005                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5006                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5007                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5008                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, cur_height).unwrap();
5009                 let mut new_payloads = Vec::new();
5010                 for payload in onion_payloads.drain(..) {
5011                         new_payloads.push(BogusOnionHopData::new(payload));
5012                 }
5013                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5014                 // describing a length-1 TLV payload, which is obviously bogus.
5015                 new_payloads[0].data[0] = 1;
5016                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5017         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5018
5019         // final node failure
5020         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5021                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5022                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5023                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5024                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, cur_height).unwrap();
5025                 let mut new_payloads = Vec::new();
5026                 for payload in onion_payloads.drain(..) {
5027                         new_payloads.push(BogusOnionHopData::new(payload));
5028                 }
5029                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5030                 // length-1 TLV payload, which is obviously bogus.
5031                 new_payloads[1].data[0] = 1;
5032                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5033         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5034
5035         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5036         // receiving simulated fail messages
5037         // intermediate node failure
5038         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5039                 // trigger error
5040                 msg.amount_msat -= 1;
5041         }, |msg| {
5042                 // and tamper returning error message
5043                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5044                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5045                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5046         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5047
5048         // final node failure
5049         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5050                 // and tamper returning error message
5051                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5052                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5053                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5054         }, ||{
5055                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5056         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5057
5058         // intermediate node failure
5059         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5060                 msg.amount_msat -= 1;
5061         }, |msg| {
5062                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5063                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5064                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5065         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5066
5067         // final node failure
5068         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5069                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5070                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5071                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5072         }, ||{
5073                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5074         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5075
5076         // intermediate node failure
5077         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5078                 msg.amount_msat -= 1;
5079         }, |msg| {
5080                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5081                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5082                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5083         }, ||{
5084                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5085         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5086
5087         // final node failure
5088         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5089                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5090                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5091                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5092         }, ||{
5093                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5094         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5095
5096         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5097                 Some(BADONION|PERM|4), None);
5098
5099         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5100                 Some(BADONION|PERM|5), None);
5101
5102         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5103                 Some(BADONION|PERM|6), None);
5104
5105         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5106                 msg.amount_msat -= 1;
5107         }, |msg| {
5108                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5109                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5110                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5111         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5112
5113         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5114                 msg.amount_msat -= 1;
5115         }, |msg| {
5116                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5117                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5118                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5119                 // short_channel_id from the processing node
5120         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5121
5122         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5123                 msg.amount_msat -= 1;
5124         }, |msg| {
5125                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5126                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5127                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5128                 // short_channel_id from the processing node
5129         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5130
5131         let mut bogus_route = route.clone();
5132         bogus_route.paths[0][1].short_channel_id -= 1;
5133         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5134           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5135
5136         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5137         let mut bogus_route = route.clone();
5138         let route_len = bogus_route.paths[0].len();
5139         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5140         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5141
5142         //TODO: with new config API, we will be able to generate both valid and
5143         //invalid channel_update cases.
5144         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5145                 msg.amount_msat -= 1;
5146         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5147
5148         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5149                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5150                 msg.cltv_expiry -= 1;
5151         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5152
5153         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5154                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5155                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5156
5157                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5158         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5159
5160         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5161                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5162         }, false, Some(PERM|15), None);
5163
5164         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5165                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5166                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5167
5168                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5169         }, || {}, true, Some(17), None);
5170
5171         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5172                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5173                         for f in pending_forwards.iter_mut() {
5174                                 match f {
5175                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5176                                                 forward_info.outgoing_cltv_value += 1,
5177                                         _ => {},
5178                                 }
5179                         }
5180                 }
5181         }, true, Some(18), None);
5182
5183         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5184                 // violate amt_to_forward > msg.amount_msat
5185                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5186                         for f in pending_forwards.iter_mut() {
5187                                 match f {
5188                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5189                                                 forward_info.amt_to_forward -= 1,
5190                                         _ => {},
5191                                 }
5192                         }
5193                 }
5194         }, true, Some(19), None);
5195
5196         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5197                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5198                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5199                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5200         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5201         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5202
5203         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5204                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5205                 let mut route = route.clone();
5206                 let height = 1;
5207                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5208                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5209                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, None, height).unwrap();
5210                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5211                 msg.cltv_expiry = htlc_cltv;
5212                 msg.onion_routing_packet = onion_packet;
5213         }, ||{}, true, Some(21), None);
5214 }
5215
5216 #[test]
5217 #[should_panic]
5218 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5219         let node_cfgs = create_node_cfgs(2);
5220         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5221         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5222         //Force duplicate channel ids
5223         for node in nodes.iter() {
5224                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5225         }
5226
5227         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5228         let channel_value_satoshis=10000;
5229         let push_msat=10001;
5230         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5231         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5232         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5233
5234         //Create a second channel with a channel_id collision
5235         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5236 }
5237
5238 #[test]
5239 fn bolt2_open_channel_sending_node_checks_part2() {
5240         let node_cfgs = create_node_cfgs(2);
5241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5242         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5243
5244         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5245         let channel_value_satoshis=2^24;
5246         let push_msat=10001;
5247         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5248
5249         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5250         let channel_value_satoshis=10000;
5251         // Test when push_msat is equal to 1000 * funding_satoshis.
5252         let push_msat=1000*channel_value_satoshis+1;
5253         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5254
5255         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5256         let channel_value_satoshis=10000;
5257         let push_msat=10001;
5258         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
5259         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5260         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5261
5262         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5263         // 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
5264         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5265
5266         // 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.
5267         assert!(BREAKDOWN_TIMEOUT>0);
5268         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5269
5270         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5271         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5272         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5273
5274         // 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.
5275         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5276         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5277         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5278         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5279         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5280 }
5281
5282 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5283 // 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.
5284 //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.
5285
5286 #[test]
5287 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5288         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5289         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5290         let node_cfgs = create_node_cfgs(2);
5291         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5292         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5293         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5294         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5295         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5296
5297         route.paths[0][0].fee_msat = 0;
5298
5299         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5300                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5301         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5302         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5303 }
5304
5305 #[test]
5306 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5307         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5308         //It is enforced when constructing a route.
5309         let node_cfgs = create_node_cfgs(2);
5310         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5311         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5312         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5313         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5314         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5315
5316         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::RouteError { err },
5317                 assert_eq!(err, "Channel CLTV overflowed?!"));
5318 }
5319
5320 #[test]
5321 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5322         //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.
5323         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5324         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5325         let node_cfgs = create_node_cfgs(2);
5326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5328         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5329         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5330
5331         for i in 0..max_accepted_htlcs {
5332                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5333                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5334                 let payment_event = {
5335                         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5336                         check_added_monitors!(nodes[0], 1);
5337
5338                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5339                         assert_eq!(events.len(), 1);
5340                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5341                                 assert_eq!(htlcs[0].htlc_id, i);
5342                         } else {
5343                                 assert!(false);
5344                         }
5345                         SendEvent::from_event(events.remove(0))
5346                 };
5347                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5348                 check_added_monitors!(nodes[1], 0);
5349                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5350
5351                 expect_pending_htlcs_forwardable!(nodes[1]);
5352                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5353         }
5354         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5355         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5356         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5357                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5358
5359         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5360         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5361 }
5362
5363 #[test]
5364 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5365         //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.
5366         let node_cfgs = create_node_cfgs(2);
5367         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5368         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5369         let channel_value = 100000;
5370         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5371         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5372
5373         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5374
5375         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5376         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5377         unwrap_send_err!(nodes[0].node.send_payment(route, our_payment_hash, None), true, APIError::ChannelUnavailable { err },
5378                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5379
5380         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5381         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
5382
5383         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5384 }
5385
5386 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5387 #[test]
5388 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5389         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5390         let node_cfgs = create_node_cfgs(2);
5391         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5392         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5393         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5394         let htlc_minimum_msat: u64;
5395         {
5396                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5397                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5398                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5399         }
5400         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5401         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5402         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5403         check_added_monitors!(nodes[0], 1);
5404         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5405         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5406         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5407         assert!(nodes[1].node.list_channels().is_empty());
5408         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5409         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5410 }
5411
5412 #[test]
5413 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5414         //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
5415         let node_cfgs = create_node_cfgs(2);
5416         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5417         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5418         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5419
5420         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5421
5422         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5423         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5424         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5425         check_added_monitors!(nodes[0], 1);
5426         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5427
5428         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5429         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5430
5431         assert!(nodes[1].node.list_channels().is_empty());
5432         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5433         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5434 }
5435
5436 #[test]
5437 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5438         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5439         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5440         let node_cfgs = create_node_cfgs(2);
5441         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5442         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5443         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5444         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5445         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5446
5447         let session_priv = SecretKey::from_slice(&{
5448                 let mut session_key = [0; 32];
5449                 let mut rng = thread_rng();
5450                 rng.fill_bytes(&mut session_key);
5451                 session_key
5452         }).expect("RNG is bad!");
5453
5454         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5455         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5456         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, None, cur_height).unwrap();
5457         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5458
5459         let mut msg = msgs::UpdateAddHTLC {
5460                 channel_id: chan.2,
5461                 htlc_id: 0,
5462                 amount_msat: 1000,
5463                 payment_hash: our_payment_hash,
5464                 cltv_expiry: htlc_cltv,
5465                 onion_routing_packet: onion_packet.clone(),
5466         };
5467
5468         for i in 0..super::channel::OUR_MAX_HTLCS {
5469                 msg.htlc_id = i as u64;
5470                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5471         }
5472         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5473         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5474
5475         assert!(nodes[1].node.list_channels().is_empty());
5476         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5477         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5478 }
5479
5480 #[test]
5481 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5482         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5483         let node_cfgs = create_node_cfgs(2);
5484         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5485         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5486         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5487         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5488         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5489         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5490         check_added_monitors!(nodes[0], 1);
5491         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5492         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5493         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5494
5495         assert!(nodes[1].node.list_channels().is_empty());
5496         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5497         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5498 }
5499
5500 #[test]
5501 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5502         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5503         let node_cfgs = create_node_cfgs(2);
5504         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5505         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5506         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5507         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5508         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5509         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5510         check_added_monitors!(nodes[0], 1);
5511         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5512         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5513         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5514
5515         assert!(nodes[1].node.list_channels().is_empty());
5516         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5517         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5518 }
5519
5520 #[test]
5521 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5522         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5523         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5524         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5525         let node_cfgs = create_node_cfgs(2);
5526         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5527         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5528         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5529         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5530         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5531         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5532         check_added_monitors!(nodes[0], 1);
5533         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5534         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5535
5536         //Disconnect and Reconnect
5537         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5538         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5539         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5540         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5541         assert_eq!(reestablish_1.len(), 1);
5542         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
5543         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5544         assert_eq!(reestablish_2.len(), 1);
5545         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
5546         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5547         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
5548         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5549
5550         //Resend HTLC
5551         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5552         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5553         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
5554         check_added_monitors!(nodes[1], 1);
5555         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5556
5557         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5558
5559         assert!(nodes[1].node.list_channels().is_empty());
5560         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5561         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
5562 }
5563
5564 #[test]
5565 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5566         //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.
5567
5568         let node_cfgs = create_node_cfgs(2);
5569         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5570         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5571         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5572
5573         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5574         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5575         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5576         check_added_monitors!(nodes[0], 1);
5577         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5578         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5579
5580         let update_msg = msgs::UpdateFulfillHTLC{
5581                 channel_id: chan.2,
5582                 htlc_id: 0,
5583                 payment_preimage: our_payment_preimage,
5584         };
5585
5586         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5587
5588         assert!(nodes[0].node.list_channels().is_empty());
5589         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5590         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5591 }
5592
5593 #[test]
5594 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5595         //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.
5596
5597         let node_cfgs = create_node_cfgs(2);
5598         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5599         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5600         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5601
5602         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5603         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5604         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5605         check_added_monitors!(nodes[0], 1);
5606         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5608
5609         let update_msg = msgs::UpdateFailHTLC{
5610                 channel_id: chan.2,
5611                 htlc_id: 0,
5612                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5613         };
5614
5615         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5616
5617         assert!(nodes[0].node.list_channels().is_empty());
5618         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5619         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5620 }
5621
5622 #[test]
5623 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5624         //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.
5625
5626         let node_cfgs = create_node_cfgs(2);
5627         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5628         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5629         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5630
5631         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5632         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5633         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5634         check_added_monitors!(nodes[0], 1);
5635         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5636         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5637
5638         let update_msg = msgs::UpdateFailMalformedHTLC{
5639                 channel_id: chan.2,
5640                 htlc_id: 0,
5641                 sha256_of_onion: [1; 32],
5642                 failure_code: 0x8000,
5643         };
5644
5645         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5646
5647         assert!(nodes[0].node.list_channels().is_empty());
5648         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5649         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
5650 }
5651
5652 #[test]
5653 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5654         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5655
5656         let node_cfgs = create_node_cfgs(2);
5657         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5658         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5659         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5660
5661         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5662
5663         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
5664         check_added_monitors!(nodes[1], 1);
5665
5666         let events = nodes[1].node.get_and_clear_pending_msg_events();
5667         assert_eq!(events.len(), 1);
5668         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5669                 match events[0] {
5670                         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, .. } } => {
5671                                 assert!(update_add_htlcs.is_empty());
5672                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5673                                 assert!(update_fail_htlcs.is_empty());
5674                                 assert!(update_fail_malformed_htlcs.is_empty());
5675                                 assert!(update_fee.is_none());
5676                                 update_fulfill_htlcs[0].clone()
5677                         },
5678                         _ => panic!("Unexpected event"),
5679                 }
5680         };
5681
5682         update_fulfill_msg.htlc_id = 1;
5683
5684         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5685
5686         assert!(nodes[0].node.list_channels().is_empty());
5687         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5688         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
5689 }
5690
5691 #[test]
5692 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5693         //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.
5694
5695         let node_cfgs = create_node_cfgs(2);
5696         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5697         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5698         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5699
5700         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5701
5702         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
5703         check_added_monitors!(nodes[1], 1);
5704
5705         let events = nodes[1].node.get_and_clear_pending_msg_events();
5706         assert_eq!(events.len(), 1);
5707         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5708                 match events[0] {
5709                         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, .. } } => {
5710                                 assert!(update_add_htlcs.is_empty());
5711                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5712                                 assert!(update_fail_htlcs.is_empty());
5713                                 assert!(update_fail_malformed_htlcs.is_empty());
5714                                 assert!(update_fee.is_none());
5715                                 update_fulfill_htlcs[0].clone()
5716                         },
5717                         _ => panic!("Unexpected event"),
5718                 }
5719         };
5720
5721         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5722
5723         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5724
5725         assert!(nodes[0].node.list_channels().is_empty());
5726         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5727         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
5728 }
5729
5730
5731 #[test]
5732 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5733         //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.
5734
5735         let node_cfgs = create_node_cfgs(2);
5736         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5737         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5738         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5739         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5740         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5741         nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5742         check_added_monitors!(nodes[0], 1);
5743
5744         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5745         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5746
5747         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5748         check_added_monitors!(nodes[1], 0);
5749         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5750
5751         let events = nodes[1].node.get_and_clear_pending_msg_events();
5752
5753         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5754                 match events[0] {
5755                         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, .. } } => {
5756                                 assert!(update_add_htlcs.is_empty());
5757                                 assert!(update_fulfill_htlcs.is_empty());
5758                                 assert!(update_fail_htlcs.is_empty());
5759                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5760                                 assert!(update_fee.is_none());
5761                                 update_fail_malformed_htlcs[0].clone()
5762                         },
5763                         _ => panic!("Unexpected event"),
5764                 }
5765         };
5766         update_msg.failure_code &= !0x8000;
5767         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5768
5769         assert!(nodes[0].node.list_channels().is_empty());
5770         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
5771         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
5772 }
5773
5774 #[test]
5775 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5776         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5777         //    * 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.
5778
5779         let node_cfgs = create_node_cfgs(3);
5780         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5781         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5782         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5783         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5784
5785         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5786         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5787
5788         //First hop
5789         let mut payment_event = {
5790                 nodes[0].node.send_payment(route, our_payment_hash, None).unwrap();
5791                 check_added_monitors!(nodes[0], 1);
5792                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5793                 assert_eq!(events.len(), 1);
5794                 SendEvent::from_event(events.remove(0))
5795         };
5796         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5797         check_added_monitors!(nodes[1], 0);
5798         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5799         expect_pending_htlcs_forwardable!(nodes[1]);
5800         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5801         assert_eq!(events_2.len(), 1);
5802         check_added_monitors!(nodes[1], 1);
5803         payment_event = SendEvent::from_event(events_2.remove(0));
5804         assert_eq!(payment_event.msgs.len(), 1);
5805
5806         //Second Hop
5807         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5808         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
5809         check_added_monitors!(nodes[2], 0);
5810         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5811
5812         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5813         assert_eq!(events_3.len(), 1);
5814         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5815                 match events_3[0] {
5816                         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 } } => {
5817                                 assert!(update_add_htlcs.is_empty());
5818                                 assert!(update_fulfill_htlcs.is_empty());
5819                                 assert!(update_fail_htlcs.is_empty());
5820                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5821                                 assert!(update_fee.is_none());
5822                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5823                         },
5824                         _ => panic!("Unexpected event"),
5825                 }
5826         };
5827
5828         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
5829
5830         check_added_monitors!(nodes[1], 0);
5831         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5832         expect_pending_htlcs_forwardable!(nodes[1]);
5833         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5834         assert_eq!(events_4.len(), 1);
5835
5836         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5837         match events_4[0] {
5838                 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, .. } } => {
5839                         assert!(update_add_htlcs.is_empty());
5840                         assert!(update_fulfill_htlcs.is_empty());
5841                         assert_eq!(update_fail_htlcs.len(), 1);
5842                         assert!(update_fail_malformed_htlcs.is_empty());
5843                         assert!(update_fee.is_none());
5844                 },
5845                 _ => panic!("Unexpected event"),
5846         };
5847
5848         check_added_monitors!(nodes[1], 1);
5849 }
5850
5851 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5852         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5853         // We can have at most two valid local commitment tx, so both cases must be covered, and both txs must be checked to get them all as
5854         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5855
5856         let node_cfgs = create_node_cfgs(2);
5857         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5858         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5859         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5860
5861         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5862
5863         // We route 2 dust-HTLCs between A and B
5864         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5865         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5866         route_payment(&nodes[0], &[&nodes[1]], 1000000);
5867
5868         // Cache one local commitment tx as previous
5869         let as_prev_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5870
5871         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5872         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
5873         check_added_monitors!(nodes[1], 0);
5874         expect_pending_htlcs_forwardable!(nodes[1]);
5875         check_added_monitors!(nodes[1], 1);
5876
5877         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5878         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
5879         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
5880         check_added_monitors!(nodes[0], 1);
5881
5882         // Cache one local commitment tx as lastest
5883         let as_last_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
5884
5885         let events = nodes[0].node.get_and_clear_pending_msg_events();
5886         match events[0] {
5887                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5888                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5889                 },
5890                 _ => panic!("Unexpected event"),
5891         }
5892         match events[1] {
5893                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5894                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5895                 },
5896                 _ => panic!("Unexpected event"),
5897         }
5898
5899         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5900         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5901         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5902
5903         if announce_latest {
5904                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5905         } else {
5906                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5907         }
5908
5909         let events = nodes[0].node.get_and_clear_pending_msg_events();
5910         assert_eq!(events.len(), 1);
5911         match events[0] {
5912                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5913                 _ => panic!("Unexpected event"),
5914         }
5915
5916         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5917         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5918         let events = nodes[0].node.get_and_clear_pending_events();
5919         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5920         assert_eq!(events.len(), 2);
5921         let mut first_failed = false;
5922         for event in events {
5923                 match event {
5924                         Event::PaymentFailed { payment_hash, .. } => {
5925                                 if payment_hash == payment_hash_1 {
5926                                         assert!(!first_failed);
5927                                         first_failed = true;
5928                                 } else {
5929                                         assert_eq!(payment_hash, payment_hash_2);
5930                                 }
5931                         }
5932                         _ => panic!("Unexpected event"),
5933                 }
5934         }
5935 }
5936
5937 #[test]
5938 fn test_failure_delay_dust_htlc_local_commitment() {
5939         do_test_failure_delay_dust_htlc_local_commitment(true);
5940         do_test_failure_delay_dust_htlc_local_commitment(false);
5941 }
5942
5943 #[test]
5944 fn test_no_failure_dust_htlc_local_commitment() {
5945         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5946         // prone to error, we test here that a dummy transaction don't fail them.
5947
5948         let node_cfgs = create_node_cfgs(2);
5949         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5950         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5951         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5952
5953         // Rebalance a bit
5954         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5955
5956         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5957         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5958
5959         // We route 2 dust-HTLCs between A and B
5960         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5961         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5962
5963         // Build a dummy invalid transaction trying to spend a commitment tx
5964         let input = TxIn {
5965                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
5966                 script_sig: Script::new(),
5967                 sequence: 0,
5968                 witness: Vec::new(),
5969         };
5970
5971         let outp = TxOut {
5972                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
5973                 value: 10000,
5974         };
5975
5976         let dummy_tx = Transaction {
5977                 version: 2,
5978                 lock_time: 0,
5979                 input: vec![input],
5980                 output: vec![outp]
5981         };
5982
5983         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5984         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
5985         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5986         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5987         // We broadcast a few more block to check everything is all right
5988         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
5989         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5990         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5991
5992         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
5993         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
5994 }
5995
5996 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
5997         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
5998         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
5999         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6000         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6001         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6002         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6003
6004         let node_cfgs = create_node_cfgs(3);
6005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6007         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6008
6009         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6010
6011         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6012         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6013
6014         let as_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6015         let bs_commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6016
6017         // We revoked bs_commitment_tx
6018         if revoked {
6019                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6020                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6021         }
6022
6023         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6024         let mut timeout_tx = Vec::new();
6025         if local {
6026                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6027                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6028                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6029                 assert_eq!(events.len(), 1);
6030                 match events[0] {
6031                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6032                         _ => panic!("Unexpected event"),
6033                 }
6034                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6035                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6036                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6037                 let events = nodes[0].node.get_and_clear_pending_events();
6038                 assert_eq!(events.len(), 1);
6039                 match events[0] {
6040                         Event::PaymentFailed { payment_hash, .. } => {
6041                                 assert_eq!(payment_hash, dust_hash);
6042                         },
6043                         _ => panic!("Unexpected event"),
6044                 }
6045                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6046                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6047                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6048                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6049                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6050                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6051                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6052                 let events = nodes[0].node.get_and_clear_pending_events();
6053                 assert_eq!(events.len(), 1);
6054                 match events[0] {
6055                         Event::PaymentFailed { payment_hash, .. } => {
6056                                 assert_eq!(payment_hash, non_dust_hash);
6057                         },
6058                         _ => panic!("Unexpected event"),
6059                 }
6060         } else {
6061                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6062                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6063                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6064                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6065                 assert_eq!(events.len(), 1);
6066                 match events[0] {
6067                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6068                         _ => panic!("Unexpected event"),
6069                 }
6070                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6071                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6072                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6073                 if !revoked {
6074                         let events = nodes[0].node.get_and_clear_pending_events();
6075                         assert_eq!(events.len(), 1);
6076                         match events[0] {
6077                                 Event::PaymentFailed { payment_hash, .. } => {
6078                                         assert_eq!(payment_hash, dust_hash);
6079                                 },
6080                                 _ => panic!("Unexpected event"),
6081                         }
6082                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6083                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6084                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6085                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6086                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6087                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6088                         let events = nodes[0].node.get_and_clear_pending_events();
6089                         assert_eq!(events.len(), 1);
6090                         match events[0] {
6091                                 Event::PaymentFailed { payment_hash, .. } => {
6092                                         assert_eq!(payment_hash, non_dust_hash);
6093                                 },
6094                                 _ => panic!("Unexpected event"),
6095                         }
6096                 } else {
6097                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6098                         // commitment tx
6099                         let events = nodes[0].node.get_and_clear_pending_events();
6100                         assert_eq!(events.len(), 2);
6101                         let first;
6102                         match events[0] {
6103                                 Event::PaymentFailed { payment_hash, .. } => {
6104                                         if payment_hash == dust_hash { first = true; }
6105                                         else { first = false; }
6106                                 },
6107                                 _ => panic!("Unexpected event"),
6108                         }
6109                         match events[1] {
6110                                 Event::PaymentFailed { payment_hash, .. } => {
6111                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6112                                         else { assert_eq!(payment_hash, dust_hash); }
6113                                 },
6114                                 _ => panic!("Unexpected event"),
6115                         }
6116                 }
6117         }
6118 }
6119
6120 #[test]
6121 fn test_sweep_outbound_htlc_failure_update() {
6122         do_test_sweep_outbound_htlc_failure_update(false, true);
6123         do_test_sweep_outbound_htlc_failure_update(false, false);
6124         do_test_sweep_outbound_htlc_failure_update(true, false);
6125 }
6126
6127 #[test]
6128 fn test_upfront_shutdown_script() {
6129         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6130         // enforce it at shutdown message
6131
6132         let mut config = UserConfig::default();
6133         config.channel_options.announced_channel = true;
6134         config.peer_channel_config_limits.force_announced_channel_preference = false;
6135         config.channel_options.commit_upfront_shutdown_pubkey = false;
6136         let user_cfgs = [None, Some(config), None];
6137         let node_cfgs = create_node_cfgs(3);
6138         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6139         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6140
6141         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6142         let flags = InitFeatures::supported();
6143         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6144         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6145         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6146         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6147         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6148         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6149         let events = nodes[2].node.get_and_clear_pending_msg_events();
6150         assert_eq!(events.len(), 2);
6151         match events[0] {
6152                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6153                 _ => panic!("Unexpected event"),
6154         }
6155         if let MessageSendEvent::HandleError { ref action, .. } = events[1] {
6156                 match action {
6157                         &ErrorAction::SendErrorMessage { ref msg } => {
6158                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6159                         },
6160                         _ => { assert!(false); }
6161                 }
6162         } else { assert!(false); }
6163
6164         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6165         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6166         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6167         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6168         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6169         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6170         let events = nodes[2].node.get_and_clear_pending_msg_events();
6171         assert_eq!(events.len(), 1);
6172         match events[0] {
6173                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6174                 _ => panic!("Unexpected event"),
6175         }
6176
6177         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6178         let mut flags_no = InitFeatures::supported();
6179         flags_no.unset_upfront_shutdown_script();
6180         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6181         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6182         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6183         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6184         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6185         let events = nodes[1].node.get_and_clear_pending_msg_events();
6186         assert_eq!(events.len(), 1);
6187         match events[0] {
6188                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6189                 _ => panic!("Unexpected event"),
6190         }
6191
6192         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6193         // channel smoothly, opt-out is from channel initiator here
6194         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6195         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6196         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6197         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6198         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6199         let events = nodes[0].node.get_and_clear_pending_msg_events();
6200         assert_eq!(events.len(), 1);
6201         match events[0] {
6202                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6203                 _ => panic!("Unexpected event"),
6204         }
6205
6206         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6207         //// channel smoothly
6208         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6209         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6210         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6211         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6212         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6213         let events = nodes[0].node.get_and_clear_pending_msg_events();
6214         assert_eq!(events.len(), 2);
6215         match events[0] {
6216                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6217                 _ => panic!("Unexpected event"),
6218         }
6219         match events[1] {
6220                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6221                 _ => panic!("Unexpected event"),
6222         }
6223 }
6224
6225 #[test]
6226 fn test_user_configurable_csv_delay() {
6227         // We test our channel constructors yield errors when we pass them absurd csv delay
6228
6229         let mut low_our_to_self_config = UserConfig::default();
6230         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6231         let mut high_their_to_self_config = UserConfig::default();
6232         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6233         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6234         let node_cfgs = create_node_cfgs(2);
6235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6236         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6237
6238         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6239         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6240         if let Err(error) = Channel::new_outbound(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6241                 match error {
6242                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6243                         _ => panic!("Unexpected event"),
6244                 }
6245         } else { assert!(false) }
6246
6247         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6248         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6249         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6250         open_channel.to_self_delay = 200;
6251         if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6252                 match error {
6253                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6254                         _ => panic!("Unexpected event"),
6255                 }
6256         } else { assert!(false); }
6257
6258         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6259         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6260         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6261         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6262         accept_channel.to_self_delay = 200;
6263         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6264         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6265                 match action {
6266                         &ErrorAction::SendErrorMessage { ref msg } => {
6267                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6268                         },
6269                         _ => { assert!(false); }
6270                 }
6271         } else { assert!(false); }
6272
6273         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6274         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6275         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6276         open_channel.to_self_delay = 200;
6277         if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6278                 match error {
6279                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6280                         _ => panic!("Unexpected event"),
6281                 }
6282         } else { assert!(false); }
6283 }
6284
6285 #[test]
6286 fn test_data_loss_protect() {
6287         // We want to be sure that :
6288         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6289         // * we close channel in case of detecting other being fallen behind
6290         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6291         let monitor;
6292         let node_state_0;
6293         let node_cfgs = create_node_cfgs(2);
6294         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6295         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6296
6297         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6298
6299         // Cache node A state before any channel update
6300         let previous_node_state = nodes[0].node.encode();
6301         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6302         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6303
6304         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6305         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6306
6307         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6308         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6309
6310         // Restore node A from previous state
6311         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6312         let mut chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6313         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6314         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6315         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6316         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone());
6317         node_state_0 = {
6318                 let mut channel_monitors = HashMap::new();
6319                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6320                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6321                         keys_manager: Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger))),
6322                         fee_estimator: feeest.clone(),
6323                         monitor: &monitor,
6324                         logger: Arc::clone(&logger),
6325                         tx_broadcaster,
6326                         default_config: UserConfig::default(),
6327                         channel_monitors: &mut channel_monitors,
6328                 }).unwrap().1
6329         };
6330         nodes[0].node = &node_state_0;
6331         assert!(monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok());
6332         nodes[0].chan_monitor = &monitor;
6333         nodes[0].chain_monitor = chain_monitor;
6334
6335         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6336         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6337         nodes[0].block_notifier.register_listener(nodes[0].node);
6338
6339         check_added_monitors!(nodes[0], 1);
6340
6341         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6342         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6343
6344         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6345
6346         // Check we update monitor following learning of per_commitment_point from B
6347         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6348         check_added_monitors!(nodes[0], 1);
6349
6350         {
6351                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6352                 assert_eq!(node_txn.len(), 0);
6353         }
6354
6355         let mut reestablish_1 = Vec::with_capacity(1);
6356         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6357                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6358                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6359                         reestablish_1.push(msg.clone());
6360                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6361                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6362                         match action {
6363                                 &ErrorAction::SendErrorMessage { ref msg } => {
6364                                         assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
6365                                 },
6366                                 _ => panic!("Unexpected event!"),
6367                         }
6368                 } else {
6369                         panic!("Unexpected event")
6370                 }
6371         }
6372
6373         // Check we close channel detecting A is fallen-behind
6374         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6375         let events = nodes[1].node.get_and_clear_pending_msg_events();
6376         assert_eq!(events.len(), 2);
6377         match events[0] {
6378                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6379                 _ => panic!("Unexpected event"),
6380         }
6381         match events [1] {
6382                 MessageSendEvent::HandleError { ref action, .. } => {
6383                         match action {
6384                                 &ErrorAction::SendErrorMessage { ref msg } => {
6385                                         assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6386                                 _ => panic!("Unexpected event!"),
6387                         }
6388                 },
6389                 _ => panic!("Unexpected event"),
6390         }
6391
6392         // Check A is able to claim to_remote output
6393         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6394         assert_eq!(node_txn.len(), 1);
6395         check_spends!(node_txn[0], chan.3.clone());
6396         assert_eq!(node_txn[0].output.len(), 2);
6397         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6398         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6399         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6400         assert_eq!(spend_txn.len(), 1);
6401         check_spends!(spend_txn[0], node_txn[0].clone());
6402 }
6403
6404 #[test]
6405 fn test_check_htlc_underpaying() {
6406         // Send payment through A -> B but A is maliciously
6407         // sending a probe payment (i.e less than expected value0
6408         // to B, B should refuse payment.
6409
6410         let node_cfgs = create_node_cfgs(2);
6411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6412         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6413
6414         // Create some initial channels
6415         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6416
6417         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6418
6419         // Node 3 is expecting payment of 100_000 but receive 10_000,
6420         // fail htlc like we didn't know the preimage.
6421         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6422         nodes[1].node.process_pending_htlc_forwards();
6423
6424         let events = nodes[1].node.get_and_clear_pending_msg_events();
6425         assert_eq!(events.len(), 1);
6426         let (update_fail_htlc, commitment_signed) = match events[0] {
6427                 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 } } => {
6428                         assert!(update_add_htlcs.is_empty());
6429                         assert!(update_fulfill_htlcs.is_empty());
6430                         assert_eq!(update_fail_htlcs.len(), 1);
6431                         assert!(update_fail_malformed_htlcs.is_empty());
6432                         assert!(update_fee.is_none());
6433                         (update_fail_htlcs[0].clone(), commitment_signed)
6434                 },
6435                 _ => panic!("Unexpected event"),
6436         };
6437         check_added_monitors!(nodes[1], 1);
6438
6439         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6440         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6441
6442         let events = nodes[0].node.get_and_clear_pending_events();
6443         assert_eq!(events.len(), 1);
6444         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6445                 assert_eq!(*rejected_by_dest, true);
6446                 assert_eq!(error_code.unwrap(), 0x4000|15);
6447         } else {
6448                 panic!("Unexpected event");
6449         }
6450         nodes[1].node.get_and_clear_pending_events();
6451 }
6452
6453 #[test]
6454 fn test_announce_disable_channels() {
6455         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6456         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6457
6458         let node_cfgs = create_node_cfgs(2);
6459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6461
6462         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6463         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6464         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6465
6466         // Disconnect peers
6467         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6468         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6469
6470         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6471         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6472         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6473         assert_eq!(msg_events.len(), 3);
6474         for e in msg_events {
6475                 match e {
6476                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6477                                 let short_id = msg.contents.short_channel_id;
6478                                 // Check generated channel_update match list in PendingChannelUpdate
6479                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6480                                         panic!("Generated ChannelUpdate for wrong chan!");
6481                                 }
6482                         },
6483                         _ => panic!("Unexpected event"),
6484                 }
6485         }
6486         // Reconnect peers
6487         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6488         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6489         assert_eq!(reestablish_1.len(), 3);
6490         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6491         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6492         assert_eq!(reestablish_2.len(), 3);
6493
6494         // Reestablish chan_1
6495         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6496         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6497         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6498         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6499         // Reestablish chan_2
6500         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6501         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6502         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6503         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6504         // Reestablish chan_3
6505         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6506         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6507         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6508         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6509
6510         nodes[0].node.timer_chan_freshness_every_min();
6511         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6512 }
6513
6514 #[test]
6515 fn test_bump_penalty_txn_on_revoked_commitment() {
6516         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6517         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6518
6519         let node_cfgs = create_node_cfgs(2);
6520         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6521         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6522
6523         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6524         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6525         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6526         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6527
6528         let revoked_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6529         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6530         assert_eq!(revoked_txn[0].output.len(), 4);
6531         assert_eq!(revoked_txn[0].input.len(), 1);
6532         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6533         let revoked_txid = revoked_txn[0].txid();
6534
6535         let mut penalty_sum = 0;
6536         for outp in revoked_txn[0].output.iter() {
6537                 if outp.script_pubkey.is_v0_p2wsh() {
6538                         penalty_sum += outp.value;
6539                 }
6540         }
6541
6542         // Connect blocks to change height_timer range to see if we use right soonest_timelock
6543         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
6544
6545         // Actually revoke tx by claiming a HTLC
6546         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6547         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6548         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
6549
6550         // One or more justice tx should have been broadcast, check it
6551         let penalty_1;
6552         let feerate_1;
6553         {
6554                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6555                 assert_eq!(node_txn.len(), 4); // justice tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
6556                 assert_eq!(node_txn[0], node_txn[3]);
6557                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6558                 assert_eq!(node_txn[0].output.len(), 1);
6559                 check_spends!(node_txn[0], revoked_txn[0].clone());
6560                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
6561                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
6562                 penalty_1 = node_txn[0].txid();
6563                 node_txn.clear();
6564         };
6565
6566         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
6567         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
6568         let mut penalty_2 = penalty_1;
6569         let mut feerate_2 = 0;
6570         {
6571                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6572                 assert_eq!(node_txn.len(), 1);
6573                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6574                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6575                         assert_eq!(node_txn[0].output.len(), 1);
6576                         check_spends!(node_txn[0], revoked_txn[0].clone());
6577                         penalty_2 = node_txn[0].txid();
6578                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6579                         assert_ne!(penalty_2, penalty_1);
6580                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
6581                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
6582                         // Verify 25% bump heuristic
6583                         assert!(feerate_2 * 100 >= feerate_1 * 125);
6584                         node_txn.clear();
6585                 }
6586         }
6587         assert_ne!(feerate_2, 0);
6588
6589         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
6590         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
6591         let penalty_3;
6592         let mut feerate_3 = 0;
6593         {
6594                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6595                 assert_eq!(node_txn.len(), 1);
6596                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
6597                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
6598                         assert_eq!(node_txn[0].output.len(), 1);
6599                         check_spends!(node_txn[0], revoked_txn[0].clone());
6600                         penalty_3 = node_txn[0].txid();
6601                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
6602                         assert_ne!(penalty_3, penalty_2);
6603                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
6604                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
6605                         // Verify 25% bump heuristic
6606                         assert!(feerate_3 * 100 >= feerate_2 * 125);
6607                         node_txn.clear();
6608                 }
6609         }
6610         assert_ne!(feerate_3, 0);
6611
6612         nodes[1].node.get_and_clear_pending_events();
6613         nodes[1].node.get_and_clear_pending_msg_events();
6614 }
6615
6616 #[test]
6617 fn test_bump_penalty_txn_on_revoked_htlcs() {
6618         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
6619         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
6620
6621         let node_cfgs = create_node_cfgs(2);
6622         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6623         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6624
6625         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6626         // Lock HTLC in both directions
6627         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
6628         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6629
6630         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6631         assert_eq!(revoked_local_txn[0].input.len(), 1);
6632         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6633
6634         // Revoke local commitment tx
6635         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
6636
6637         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6638         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
6639         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6640         check_closed_broadcast!(nodes[1], false);
6641
6642         let mut received = ::std::usize::MAX;
6643         let mut offered = ::std::usize::MAX;
6644         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6645         assert_eq!(revoked_htlc_txn.len(), 6);
6646         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6647                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6648                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6649                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6650                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6651                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6652                 received = 0;
6653                 offered = 1;
6654         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6655                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
6656                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0].clone());
6657                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
6658                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6659                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
6660                 received = 1;
6661                 offered = 0;
6662         }
6663
6664         // Broadcast set of revoked txn on A
6665         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  true, header.bitcoin_hash());
6666         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6667         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
6668         let first;
6669         let second;
6670         let feerate_1;
6671         let feerate_2;
6672         {
6673                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6674                 assert_eq!(node_txn.len(), 9); // 3 penalty txn on revoked commitment tx * 2 (block-rescan) + A commitment tx + 2 penalty tnx on revoked HTLC txn
6675                 // Verify claim tx are spending revoked HTLC txn
6676                 assert_eq!(node_txn[7].input.len(), 1);
6677                 assert_eq!(node_txn[7].output.len(), 1);
6678                 check_spends!(node_txn[7], revoked_htlc_txn[0].clone());
6679                 first = node_txn[7].txid();
6680                 assert_eq!(node_txn[8].input.len(), 1);
6681                 assert_eq!(node_txn[8].output.len(), 1);
6682                 check_spends!(node_txn[8], revoked_htlc_txn[1].clone());
6683                 second = node_txn[8].txid();
6684                 // Store both feerates for later comparison
6685                 let fee_1 = revoked_htlc_txn[0].output[0].value - node_txn[7].output[0].value;
6686                 feerate_1 = fee_1 * 1000 / node_txn[7].get_weight() as u64;
6687                 let fee_2 = revoked_htlc_txn[1].output[0].value - node_txn[8].output[0].value;
6688                 feerate_2 = fee_2 * 1000 / node_txn[8].get_weight() as u64;
6689                 node_txn.clear();
6690         }
6691
6692         // Connect three more block to see if bumped penalty are issued for HTLC txn
6693         let header_132 = connect_blocks(&nodes[0].block_notifier, 3, 129, true, header_129.bitcoin_hash());
6694         let penalty_local_tx;
6695         {
6696                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6697                 assert_eq!(node_txn.len(), 3); // 2 bumped penalty txn on offered/received HTLC outputs of revoked commitment tx + 1 penalty tx on to_local of revoked commitment tx + 2 bumped penalty tx on revoked HTLC txn
6698
6699                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6700                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
6701
6702                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
6703
6704                 penalty_local_tx = node_txn[2].clone();
6705                 node_txn.clear();
6706         };
6707         // Few more blocks to broadcast and confirm penalty_local_tx
6708         let header_133 = BlockHeader { version: 0x20000000, prev_blockhash: header_132, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6709         nodes[0].block_notifier.block_connected(&Block { header: header_133, txdata: vec![penalty_local_tx] }, 133);
6710         let header_135 = connect_blocks(&nodes[0].block_notifier, 2, 133, true, header_133.bitcoin_hash());
6711         {
6712                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6713                 assert_eq!(node_txn.len(), 1);
6714                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
6715                 node_txn.clear();
6716         }
6717         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
6718         let node_txn = {
6719                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6720                 assert_eq!(node_txn.len(), 2);
6721
6722                 let mut penalty_offered = ::std::usize::MAX;
6723                 let mut penalty_received = ::std::usize::MAX;
6724
6725                 {
6726                         for (i, tx) in node_txn.iter().enumerate() {
6727                                 if tx.input[0].previous_output.txid == revoked_htlc_txn[offered].txid() {
6728                                         penalty_offered = i;
6729                                 } else if tx.input[0].previous_output.txid == revoked_htlc_txn[received].txid() {
6730                                         penalty_received = i;
6731                                 }
6732                         }
6733                 }
6734
6735                 assert_eq!(node_txn[penalty_received].input.len(), 1);
6736                 assert_eq!(node_txn[penalty_received].output.len(), 1);
6737                 assert_eq!(node_txn[penalty_offered].input.len(), 1);
6738                 assert_eq!(node_txn[penalty_offered].output.len(), 1);
6739                 // Verify bumped tx is different and 25% bump heuristic
6740                 check_spends!(node_txn[penalty_offered], revoked_htlc_txn[offered].clone());
6741                 assert_ne!(first, node_txn[penalty_offered].txid());
6742                 let fee = revoked_htlc_txn[offered].output[0].value - node_txn[penalty_offered].output[0].value;
6743                 let new_feerate = fee * 1000 / node_txn[penalty_offered].get_weight() as u64;
6744                 assert!(new_feerate * 100 > feerate_1 * 125);
6745
6746                 check_spends!(node_txn[penalty_received], revoked_htlc_txn[received].clone());
6747                 assert_ne!(second, node_txn[penalty_received].txid());
6748                 let fee = revoked_htlc_txn[received].output[0].value - node_txn[penalty_received].output[0].value;
6749                 let new_feerate = fee * 1000 / node_txn[penalty_received].get_weight() as u64;
6750                 assert!(new_feerate * 100 > feerate_2 * 125);
6751                 let txn = vec![node_txn[0].clone(), node_txn[1].clone()];
6752                 node_txn.clear();
6753                 txn
6754         };
6755         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
6756         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6757         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
6758         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
6759         {
6760                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6761                 assert_eq!(node_txn.len(), 2); //TODO: fix check_spend_remote_htlc lack of watch output
6762                 node_txn.clear();
6763         }
6764         check_closed_broadcast!(nodes[0], false);
6765 }
6766
6767 #[test]
6768 fn test_bump_penalty_txn_on_remote_commitment() {
6769         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
6770         // we're able to claim outputs on remote commitment transaction before timelocks expiration
6771
6772         // Create 2 HTLCs
6773         // Provide preimage for one
6774         // Check aggregation
6775
6776         let node_cfgs = create_node_cfgs(2);
6777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6778         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6779
6780         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6781         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6782         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6783
6784         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6785         let remote_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6786         assert_eq!(remote_txn[0].output.len(), 4);
6787         assert_eq!(remote_txn[0].input.len(), 1);
6788         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6789
6790         // Claim a HTLC without revocation (provide B monitor with preimage)
6791         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
6792         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6793         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
6794         check_added_monitors!(nodes[1], 1);
6795
6796         // One or more claim tx should have been broadcast, check it
6797         let timeout;
6798         let preimage;
6799         let feerate_timeout;
6800         let feerate_preimage;
6801         {
6802                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6803                 assert_eq!(node_txn.len(), 7); // 2 * claim tx (broadcasted from ChannelMonitor) * 2 (block-reparsing) + local commitment tx + local HTLC-timeout + HTLC-success (broadcasted from ChannelManager)
6804                 assert_eq!(node_txn[0], node_txn[5]);
6805                 assert_eq!(node_txn[1], node_txn[6]);
6806                 assert_eq!(node_txn[0].input.len(), 1);
6807                 assert_eq!(node_txn[1].input.len(), 1);
6808                 check_spends!(node_txn[0], remote_txn[0].clone());
6809                 check_spends!(node_txn[1], remote_txn[0].clone());
6810                 check_spends!(node_txn[2], chan.3);
6811                 check_spends!(node_txn[3], node_txn[2]);
6812                 check_spends!(node_txn[4], node_txn[2]);
6813                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6814                         timeout = node_txn[0].txid();
6815                         let index = node_txn[0].input[0].previous_output.vout;
6816                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6817                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
6818
6819                         preimage = node_txn[1].txid();
6820                         let index = node_txn[1].input[0].previous_output.vout;
6821                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6822                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
6823                 } else {
6824                         timeout = node_txn[1].txid();
6825                         let index = node_txn[1].input[0].previous_output.vout;
6826                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6827                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
6828
6829                         preimage = node_txn[0].txid();
6830                         let index = node_txn[0].input[0].previous_output.vout;
6831                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6832                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
6833                 }
6834                 node_txn.clear();
6835         };
6836         assert_ne!(feerate_timeout, 0);
6837         assert_ne!(feerate_preimage, 0);
6838
6839         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
6840         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
6841         {
6842                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6843                 assert_eq!(node_txn.len(), 2);
6844                 assert_eq!(node_txn[0].input.len(), 1);
6845                 assert_eq!(node_txn[1].input.len(), 1);
6846                 check_spends!(node_txn[0], remote_txn[0].clone());
6847                 check_spends!(node_txn[1], remote_txn[0].clone());
6848                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
6849                         let index = node_txn[0].input[0].previous_output.vout;
6850                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6851                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6852                         assert!(new_feerate * 100 > feerate_timeout * 125);
6853                         assert_ne!(timeout, node_txn[0].txid());
6854
6855                         let index = node_txn[1].input[0].previous_output.vout;
6856                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6857                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6858                         assert!(new_feerate * 100 > feerate_preimage * 125);
6859                         assert_ne!(preimage, node_txn[1].txid());
6860                 } else {
6861                         let index = node_txn[1].input[0].previous_output.vout;
6862                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
6863                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
6864                         assert!(new_feerate * 100 > feerate_timeout * 125);
6865                         assert_ne!(timeout, node_txn[1].txid());
6866
6867                         let index = node_txn[0].input[0].previous_output.vout;
6868                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
6869                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
6870                         assert!(new_feerate * 100 > feerate_preimage * 125);
6871                         assert_ne!(preimage, node_txn[0].txid());
6872                 }
6873                 node_txn.clear();
6874         }
6875
6876         nodes[1].node.get_and_clear_pending_events();
6877         nodes[1].node.get_and_clear_pending_msg_events();
6878 }
6879
6880 #[test]
6881 fn test_set_outpoints_partial_claiming() {
6882         // - remote party claim tx, new bump tx
6883         // - disconnect remote claiming tx, new bump
6884         // - disconnect tx, see no tx anymore
6885         let node_cfgs = create_node_cfgs(2);
6886         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6887         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6888
6889         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6890         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6891         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
6892
6893         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
6894         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6895         assert_eq!(remote_txn.len(), 3);
6896         assert_eq!(remote_txn[0].output.len(), 4);
6897         assert_eq!(remote_txn[0].input.len(), 1);
6898         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
6899         check_spends!(remote_txn[1], remote_txn[0].clone());
6900         check_spends!(remote_txn[2], remote_txn[0].clone());
6901
6902         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
6903         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
6904         // Provide node A with both preimage
6905         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
6906         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
6907         check_added_monitors!(nodes[0], 2);
6908         nodes[0].node.get_and_clear_pending_events();
6909         nodes[0].node.get_and_clear_pending_msg_events();
6910
6911         // Connect blocks on node A commitment transaction
6912         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6913         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
6914         // Verify node A broadcast tx claiming both HTLCs
6915         {
6916                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6917                 assert_eq!(node_txn.len(), 5);
6918                 assert_eq!(node_txn[0], node_txn[4]);
6919                 check_spends!(node_txn[0], remote_txn[0].clone());
6920                 check_spends!(node_txn[1], chan.3.clone());
6921                 check_spends!(node_txn[2], node_txn[1]);
6922                 check_spends!(node_txn[3], node_txn[1]);
6923                 assert_eq!(node_txn[0].input.len(), 2);
6924                 node_txn.clear();
6925         }
6926         nodes[0].node.get_and_clear_pending_msg_events();
6927
6928         // Connect blocks on node B
6929         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
6930         // Verify node B broadcast 2 HTLC-timeout txn
6931         let partial_claim_tx = {
6932                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6933                 assert_eq!(node_txn.len(), 3);
6934                 check_spends!(node_txn[1], node_txn[0].clone());
6935                 check_spends!(node_txn[2], node_txn[0].clone());
6936                 assert_eq!(node_txn[1].input.len(), 1);
6937                 assert_eq!(node_txn[2].input.len(), 1);
6938                 node_txn[1].clone()
6939         };
6940         nodes[1].node.get_and_clear_pending_msg_events();
6941
6942         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
6943         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6944         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
6945         {
6946                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6947                 assert_eq!(node_txn.len(), 1);
6948                 check_spends!(node_txn[0], remote_txn[0].clone());
6949                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
6950                 node_txn.clear();
6951         }
6952         nodes[0].node.get_and_clear_pending_msg_events();
6953
6954         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
6955         nodes[0].block_notifier.block_disconnected(&header, 102);
6956         {
6957                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6958                 assert_eq!(node_txn.len(), 1);
6959                 check_spends!(node_txn[0], remote_txn[0].clone());
6960                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
6961                 node_txn.clear();
6962         }
6963
6964         //// Disconnect one more block and then reconnect multiple no transaction should be generated
6965         nodes[0].block_notifier.block_disconnected(&header, 101);
6966         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
6967         {
6968                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6969                 assert_eq!(node_txn.len(), 0);
6970                 node_txn.clear();
6971         }
6972 }
6973
6974 #[test]
6975 fn test_bump_txn_sanitize_tracking_maps() {
6976         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
6977         // verify we clean then right after expiration of ANTI_REORG_DELAY.
6978
6979         let node_cfgs = create_node_cfgs(2);
6980         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6981         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6982
6983         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6984         // Lock HTLC in both directions
6985         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
6986         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
6987
6988         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan.2).unwrap().channel_monitor().get_latest_local_commitment_txn();
6989         assert_eq!(revoked_local_txn[0].input.len(), 1);
6990         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
6991
6992         // Revoke local commitment tx
6993         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
6994
6995         // Broadcast set of revoked txn on A
6996         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
6997         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6998         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
6999         check_closed_broadcast!(nodes[0], false);
7000         let penalty_txn = {
7001                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7002                 assert_eq!(node_txn.len(), 7);
7003                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7004                 check_spends!(node_txn[1], revoked_local_txn[0].clone());
7005                 check_spends!(node_txn[2], revoked_local_txn[0].clone());
7006                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7007                 node_txn.clear();
7008                 penalty_txn
7009         };
7010         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7011         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7012         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7013         {
7014                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7015                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7016                         assert!(monitor.pending_claim_requests.is_empty());
7017                         assert!(monitor.claimable_outpoints.is_empty());
7018                 }
7019         }
7020 }
7021
7022 #[test]
7023 fn test_simple_payment_secret() {
7024         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7025         // features, however.
7026         let node_cfgs = create_node_cfgs(3);
7027         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7028         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7029
7030         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7031         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7032
7033         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7034         let (_, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7035         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7036         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.0));
7037         // Claiming with all the correct values but the wrong secret should result in nothing...
7038         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7039         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some([42; 32]), 100_000), false);
7040         // ...but with the right secret we should be able to claim all the way back
7041         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.0), 100_000);
7042 }
7043
7044 #[test]
7045 fn test_simple_mpp() {
7046         // Simple test of sending a multi-path payment.
7047         let node_cfgs = create_node_cfgs(4);
7048         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7049         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7050
7051         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7052         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7053         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7054         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7055
7056         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7057         let (_, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7058         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7059         let path = route.paths[0].clone();
7060         route.paths.push(path);
7061         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7062         route.paths[0][0].short_channel_id = chan_1_id;
7063         route.paths[0][1].short_channel_id = chan_3_id;
7064         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7065         route.paths[1][0].short_channel_id = chan_2_id;
7066         route.paths[1][1].short_channel_id = chan_4_id;
7067         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.0));
7068         // Claiming with all the correct values but the wrong secret should result in nothing...
7069         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7070         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some([42; 32]), 200_000), false);
7071         // ...but with the right secret we should be able to claim all the way back
7072         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret.0), 200_000);
7073 }