_ 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::{ChannelKeys, 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, 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::{chan_utils, 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 chanmon_cfgs = create_chanmon_cfgs(2);
  57         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  58         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  59         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  60
  61         // Instantiate channel parameters where we push the maximum msats given our
  62         // funding satoshis
  63         let channel_value_sat = 31337; // same as funding satoshis
  64         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  65         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  66
  67         // Have node0 initiate a channel to node1 with aforementioned parameters
  68         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  69
  70         // Extract the channel open message from node0 to node1
  71         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  72
  73         // Test helper that asserts we get the correct error string given a mutator
  74         // that supposedly makes the channel open message insane
  75         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  76                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  77                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  78                 assert_eq!(msg_events.len(), 1);
  79                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  80                         match action {
  81                                 &ErrorAction::SendErrorMessage { .. } => {
  82                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  83                                 },
  84                                 _ => panic!("unexpected event!"),
  85                         }
  86                 } else { assert!(false); }
  87         };
  88
  89         use ln::channel::MAX_FUNDING_SATOSHIS;
  90         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  91
  92         // Test all mutations that would make the channel open message insane
  93         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  94
  95         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  96
  97         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  98
  99         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 100
 101         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 102
 103         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 });
 104
 105         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 });
 106
 107         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 108
 109         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 110 }
 111
 112 #[test]
 113 fn test_async_inbound_update_fee() {
 114         let chanmon_cfgs = create_chanmon_cfgs(2);
 115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 118         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 119         let channel_id = chan.2;
 120
 121         // balancing
 122         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 123
 124         // A                                        B
 125         // update_fee                            ->
 126         // send (1) commitment_signed            -.
 127         //                                       <- update_add_htlc/commitment_signed
 128         // send (2) RAA (awaiting remote revoke) -.
 129         // (1) commitment_signed is delivered    ->
 130         //                                       .- send (3) RAA (awaiting remote revoke)
 131         // (2) RAA is delivered                  ->
 132         //                                       .- send (4) commitment_signed
 133         //                                       <- (3) RAA is delivered
 134         // send (5) commitment_signed            -.
 135         //                                       <- (4) commitment_signed is delivered
 136         // send (6) RAA                          -.
 137         // (5) commitment_signed is delivered    ->
 138         //                                       <- RAA
 139         // (6) RAA is delivered                  ->
 140
 141         // First nodes[0] generates an update_fee
 142         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 143         check_added_monitors!(nodes[0], 1);
 144
 145         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 146         assert_eq!(events_0.len(), 1);
 147         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 148                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 149                         (update_fee.as_ref(), commitment_signed)
 150                 },
 151                 _ => panic!("Unexpected event"),
 152         };
 153
 154         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 155
 156         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 157         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 158         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
 159         check_added_monitors!(nodes[1], 1);
 160
 161         let payment_event = {
 162                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 163                 assert_eq!(events_1.len(), 1);
 164                 SendEvent::from_event(events_1.remove(0))
 165         };
 166         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 167         assert_eq!(payment_event.msgs.len(), 1);
 168
 169         // ...now when the messages get delivered everyone should be happy
 170         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 171         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 172         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 173         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 174         check_added_monitors!(nodes[0], 1);
 175
 176         // deliver(1), generate (3):
 177         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 178         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 179         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 180         check_added_monitors!(nodes[1], 1);
 181
 182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 183         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 184         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 185         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 186         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 187         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 188         assert!(bs_update.update_fee.is_none()); // (4)
 189         check_added_monitors!(nodes[1], 1);
 190
 191         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 192         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 193         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 194         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 195         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 196         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 197         assert!(as_update.update_fee.is_none()); // (5)
 198         check_added_monitors!(nodes[0], 1);
 199
 200         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 201         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 202         // only (6) so get_event_msg's assert(len == 1) passes
 203         check_added_monitors!(nodes[0], 1);
 204
 205         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 206         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 207         check_added_monitors!(nodes[1], 1);
 208
 209         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 210         check_added_monitors!(nodes[0], 1);
 211
 212         let events_2 = nodes[0].node.get_and_clear_pending_events();
 213         assert_eq!(events_2.len(), 1);
 214         match events_2[0] {
 215                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 216                 _ => panic!("Unexpected event"),
 217         }
 218
 219         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 220         check_added_monitors!(nodes[1], 1);
 221 }
 222
 223 #[test]
 224 fn test_update_fee_unordered_raa() {
 225         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 226         // crash in an earlier version of the update_fee patch)
 227         let chanmon_cfgs = create_chanmon_cfgs(2);
 228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 230         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 231         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 232         let channel_id = chan.2;
 233
 234         // balancing
 235         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 236
 237         // First nodes[0] generates an update_fee
 238         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 239         check_added_monitors!(nodes[0], 1);
 240
 241         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 242         assert_eq!(events_0.len(), 1);
 243         let update_msg = match events_0[0] { // (1)
 244                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 245                         update_fee.as_ref()
 246                 },
 247                 _ => panic!("Unexpected event"),
 248         };
 249
 250         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 251
 252         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 253         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 254         nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
 255         check_added_monitors!(nodes[1], 1);
 256
 257         let payment_event = {
 258                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 259                 assert_eq!(events_1.len(), 1);
 260                 SendEvent::from_event(events_1.remove(0))
 261         };
 262         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 263         assert_eq!(payment_event.msgs.len(), 1);
 264
 265         // ...now when the messages get delivered everyone should be happy
 266         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 267         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 268         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 269         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 270         check_added_monitors!(nodes[0], 1);
 271
 272         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 273         check_added_monitors!(nodes[1], 1);
 274
 275         // We can't continue, sadly, because our (1) now has a bogus signature
 276 }
 277
 278 #[test]
 279 fn test_multi_flight_update_fee() {
 280         let chanmon_cfgs = create_chanmon_cfgs(2);
 281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 284         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 285         let channel_id = chan.2;
 286
 287         // A                                        B
 288         // update_fee/commitment_signed          ->
 289         //                                       .- send (1) RAA and (2) commitment_signed
 290         // update_fee (never committed)          ->
 291         // (3) update_fee                        ->
 292         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 293         // don't track which updates correspond to which revoke_and_ack responses so we're in
 294         // AwaitingRAA mode and will not generate the update_fee yet.
 295         //                                       <- (1) RAA delivered
 296         // (3) is generated and send (4) CS      -.
 297         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 298         // know the per_commitment_point to use for it.
 299         //                                       <- (2) commitment_signed delivered
 300         // revoke_and_ack                        ->
 301         //                                          B should send no response here
 302         // (4) commitment_signed delivered       ->
 303         //                                       <- RAA/commitment_signed delivered
 304         // revoke_and_ack                        ->
 305
 306         // First nodes[0] generates an update_fee
 307         let initial_feerate = get_feerate!(nodes[0], channel_id);
 308         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 309         check_added_monitors!(nodes[0], 1);
 310
 311         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 312         assert_eq!(events_0.len(), 1);
 313         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 314                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 315                         (update_fee.as_ref().unwrap(), commitment_signed)
 316                 },
 317                 _ => panic!("Unexpected event"),
 318         };
 319
 320         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 321         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 322         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 323         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 324         check_added_monitors!(nodes[1], 1);
 325
 326         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 327         // transaction:
 328         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 329         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 330         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 331
 332         // Create the (3) update_fee message that nodes[0] will generate before it does...
 333         let mut update_msg_2 = msgs::UpdateFee {
 334                 channel_id: update_msg_1.channel_id.clone(),
 335                 feerate_per_kw: (initial_feerate + 30) as u32,
 336         };
 337
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 339
 340         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 341         // Deliver (3)
 342         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 343
 344         // Deliver (1), generating (3) and (4)
 345         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 346         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 347         check_added_monitors!(nodes[0], 1);
 348         assert!(as_second_update.update_add_htlcs.is_empty());
 349         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 350         assert!(as_second_update.update_fail_htlcs.is_empty());
 351         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 352         // Check that the update_fee newly generated matches what we delivered:
 353         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 354         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 355
 356         // Deliver (2) commitment_signed
 357         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 358         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 359         check_added_monitors!(nodes[0], 1);
 360         // No commitment_signed so get_event_msg's assert(len == 1) passes
 361
 362         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 363         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 364         check_added_monitors!(nodes[1], 1);
 365
 366         // Delever (4)
 367         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 368         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 369         check_added_monitors!(nodes[1], 1);
 370
 371         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 372         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 373         check_added_monitors!(nodes[0], 1);
 374
 375         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 376         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 377         // No commitment_signed so get_event_msg's assert(len == 1) passes
 378         check_added_monitors!(nodes[0], 1);
 379
 380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 381         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 382         check_added_monitors!(nodes[1], 1);
 383 }
 384
 385 #[test]
 386 fn test_1_conf_open() {
 387         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 388         // tests that we properly send one in that case.
 389         let mut alice_config = UserConfig::default();
 390         alice_config.own_channel_config.minimum_depth = 1;
 391         alice_config.channel_options.announced_channel = true;
 392         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 393         let mut bob_config = UserConfig::default();
 394         bob_config.own_channel_config.minimum_depth = 1;
 395         bob_config.channel_options.announced_channel = true;
 396         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 397         let chanmon_cfgs = create_chanmon_cfgs(2);
 398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 400         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 401
 402         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
 403         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 404         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 405
 406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 407         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 408         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 409
 410         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 411         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 412         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 413
 414         for node in nodes {
 415                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
 416                 node.router.handle_channel_update(&as_update).unwrap();
 417                 node.router.handle_channel_update(&bs_update).unwrap();
 418         }
 419 }
 420
 421 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 422         // Previously, we had issues deserializing channels when we hadn't connected the first block
 423         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 424         // serialization round-trips and simply do steps towards opening a channel and then drop the
 425         // Node objects.
 426
 427         let chanmon_cfgs = create_chanmon_cfgs(2);
 428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 430         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 431
 432         if steps & 0b1000_0000 != 0{
 433                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 434                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 435                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 436         }
 437
 438         if steps & 0x0f == 0 { return; }
 439         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 440         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 441
 442         if steps & 0x0f == 1 { return; }
 443         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
 444         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 445
 446         if steps & 0x0f == 2 { return; }
 447         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
 448
 449         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 450
 451         if steps & 0x0f == 3 { return; }
 452         {
 453                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 454                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 455                 assert_eq!(added_monitors.len(), 1);
 456                 assert_eq!(added_monitors[0].0, funding_output);
 457                 added_monitors.clear();
 458         }
 459         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 460
 461         if steps & 0x0f == 4 { return; }
 462         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 463         {
 464                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 465                 assert_eq!(added_monitors.len(), 1);
 466                 assert_eq!(added_monitors[0].0, funding_output);
 467                 added_monitors.clear();
 468         }
 469         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 470
 471         if steps & 0x0f == 5 { return; }
 472         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 473         {
 474                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 475                 assert_eq!(added_monitors.len(), 1);
 476                 assert_eq!(added_monitors[0].0, funding_output);
 477                 added_monitors.clear();
 478         }
 479
 480         let events_4 = nodes[0].node.get_and_clear_pending_events();
 481         assert_eq!(events_4.len(), 1);
 482         match events_4[0] {
 483                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 484                         assert_eq!(user_channel_id, 42);
 485                         assert_eq!(*funding_txo, funding_output);
 486                 },
 487                 _ => panic!("Unexpected event"),
 488         };
 489
 490         if steps & 0x0f == 6 { return; }
 491         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 492
 493         if steps & 0x0f == 7 { return; }
 494         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 495         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 496 }
 497
 498 #[test]
 499 fn test_sanity_on_in_flight_opens() {
 500         do_test_sanity_on_in_flight_opens(0);
 501         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 502         do_test_sanity_on_in_flight_opens(1);
 503         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 504         do_test_sanity_on_in_flight_opens(2);
 505         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 506         do_test_sanity_on_in_flight_opens(3);
 507         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(4);
 509         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(5);
 511         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(6);
 513         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(7);
 515         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(8);
 517         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 518 }
 519
 520 #[test]
 521 fn test_update_fee_vanilla() {
 522         let chanmon_cfgs = create_chanmon_cfgs(2);
 523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 526         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 527         let channel_id = chan.2;
 528
 529         let feerate = get_feerate!(nodes[0], channel_id);
 530         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 531         check_added_monitors!(nodes[0], 1);
 532
 533         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 534         assert_eq!(events_0.len(), 1);
 535         let (update_msg, commitment_signed) = match events_0[0] {
 536                         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 } } => {
 537                         (update_fee.as_ref(), commitment_signed)
 538                 },
 539                 _ => panic!("Unexpected event"),
 540         };
 541         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 542
 543         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 544         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 545         check_added_monitors!(nodes[1], 1);
 546
 547         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 548         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 549         check_added_monitors!(nodes[0], 1);
 550
 551         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 552         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 553         // No commitment_signed so get_event_msg's assert(len == 1) passes
 554         check_added_monitors!(nodes[0], 1);
 555
 556         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[1], 1);
 559 }
 560
 561 #[test]
 562 fn test_update_fee_that_funder_cannot_afford() {
 563         let chanmon_cfgs = create_chanmon_cfgs(2);
 564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 567         let channel_value = 1888;
 568         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 569         let channel_id = chan.2;
 570
 571         let feerate = 260;
 572         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 573         check_added_monitors!(nodes[0], 1);
 574         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 575
 576         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 577
 578         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 579
 580         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 581         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 582         {
 583                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 584
 585                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 586                 let num_htlcs = commitment_tx.output.len() - 2;
 587                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 588                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 589                 actual_fee = channel_value - actual_fee;
 590                 assert_eq!(total_fee, actual_fee);
 591         }
 592
 593         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 594         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 595         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 596         check_added_monitors!(nodes[0], 1);
 597
 598         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 599
 600         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 601
 602         //While producing the commitment_signed response after handling a received update_fee request the
 603         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 604         //Should produce and error.
 605         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 606         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 607         check_added_monitors!(nodes[1], 1);
 608         check_closed_broadcast!(nodes[1], true);
 609 }
 610
 611 #[test]
 612 fn test_update_fee_with_fundee_update_add_htlc() {
 613         let chanmon_cfgs = create_chanmon_cfgs(2);
 614         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 615         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 616         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 617         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 618         let channel_id = chan.2;
 619
 620         // balancing
 621         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 622
 623         let feerate = get_feerate!(nodes[0], channel_id);
 624         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 625         check_added_monitors!(nodes[0], 1);
 626
 627         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 628         assert_eq!(events_0.len(), 1);
 629         let (update_msg, commitment_signed) = match events_0[0] {
 630                         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 } } => {
 631                         (update_fee.as_ref(), commitment_signed)
 632                 },
 633                 _ => panic!("Unexpected event"),
 634         };
 635         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 636         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 637         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 638         check_added_monitors!(nodes[1], 1);
 639
 640         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 641
 642         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 643
 644         // nothing happens since node[1] is in AwaitingRemoteRevoke
 645         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
 646         {
 647                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 648                 assert_eq!(added_monitors.len(), 0);
 649                 added_monitors.clear();
 650         }
 651         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 652         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 653         // node[1] has nothing to do
 654
 655         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 656         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 657         check_added_monitors!(nodes[0], 1);
 658
 659         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 660         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 661         // No commitment_signed so get_event_msg's assert(len == 1) passes
 662         check_added_monitors!(nodes[0], 1);
 663         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 664         check_added_monitors!(nodes[1], 1);
 665         // AwaitingRemoteRevoke ends here
 666
 667         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 668         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 669         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 670         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 671         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 672         assert_eq!(commitment_update.update_fee.is_none(), true);
 673
 674         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 675         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 676         check_added_monitors!(nodes[0], 1);
 677         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 678
 679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 680         check_added_monitors!(nodes[1], 1);
 681         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 682
 683         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 684         check_added_monitors!(nodes[1], 1);
 685         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 686         // No commitment_signed so get_event_msg's assert(len == 1) passes
 687
 688         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 689         check_added_monitors!(nodes[0], 1);
 690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 691
 692         expect_pending_htlcs_forwardable!(nodes[0]);
 693
 694         let events = nodes[0].node.get_and_clear_pending_events();
 695         assert_eq!(events.len(), 1);
 696         match events[0] {
 697                 Event::PaymentReceived { .. } => { },
 698                 _ => panic!("Unexpected event"),
 699         };
 700
 701         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 702
 703         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 704         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 705         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 706 }
 707
 708 #[test]
 709 fn test_update_fee() {
 710         let chanmon_cfgs = create_chanmon_cfgs(2);
 711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 713         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 714         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 715         let channel_id = chan.2;
 716
 717         // A                                        B
 718         // (1) update_fee/commitment_signed      ->
 719         //                                       <- (2) revoke_and_ack
 720         //                                       .- send (3) commitment_signed
 721         // (4) update_fee/commitment_signed      ->
 722         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 723         //                                       <- (3) commitment_signed delivered
 724         // send (6) revoke_and_ack               -.
 725         //                                       <- (5) deliver revoke_and_ack
 726         // (6) deliver revoke_and_ack            ->
 727         //                                       .- send (7) commitment_signed in response to (4)
 728         //                                       <- (7) deliver commitment_signed
 729         // revoke_and_ack                        ->
 730
 731         // Create and deliver (1)...
 732         let feerate = get_feerate!(nodes[0], channel_id);
 733         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 734         check_added_monitors!(nodes[0], 1);
 735
 736         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 737         assert_eq!(events_0.len(), 1);
 738         let (update_msg, commitment_signed) = match events_0[0] {
 739                         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 } } => {
 740                         (update_fee.as_ref(), commitment_signed)
 741                 },
 742                 _ => panic!("Unexpected event"),
 743         };
 744         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 745
 746         // Generate (2) and (3):
 747         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 748         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 749         check_added_monitors!(nodes[1], 1);
 750
 751         // Deliver (2):
 752         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 753         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 754         check_added_monitors!(nodes[0], 1);
 755
 756         // Create and deliver (4)...
 757         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 758         check_added_monitors!(nodes[0], 1);
 759         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 760         assert_eq!(events_0.len(), 1);
 761         let (update_msg, commitment_signed) = match events_0[0] {
 762                         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 } } => {
 763                         (update_fee.as_ref(), commitment_signed)
 764                 },
 765                 _ => panic!("Unexpected event"),
 766         };
 767
 768         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 769         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 770         check_added_monitors!(nodes[1], 1);
 771         // ... creating (5)
 772         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 773         // No commitment_signed so get_event_msg's assert(len == 1) passes
 774
 775         // Handle (3), creating (6):
 776         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 777         check_added_monitors!(nodes[0], 1);
 778         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 779         // No commitment_signed so get_event_msg's assert(len == 1) passes
 780
 781         // Deliver (5):
 782         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 783         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 784         check_added_monitors!(nodes[0], 1);
 785
 786         // Deliver (6), creating (7):
 787         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 788         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 789         assert!(commitment_update.update_add_htlcs.is_empty());
 790         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 791         assert!(commitment_update.update_fail_htlcs.is_empty());
 792         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 793         assert!(commitment_update.update_fee.is_none());
 794         check_added_monitors!(nodes[1], 1);
 795
 796         // Deliver (7)
 797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 798         check_added_monitors!(nodes[0], 1);
 799         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 800         // No commitment_signed so get_event_msg's assert(len == 1) passes
 801
 802         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 803         check_added_monitors!(nodes[1], 1);
 804         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 805
 806         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 807         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 808         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 809 }
 810
 811 #[test]
 812 fn pre_funding_lock_shutdown_test() {
 813         // Test sending a shutdown prior to funding_locked after funding generation
 814         let chanmon_cfgs = create_chanmon_cfgs(2);
 815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 817         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 818         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 819         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 820         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 821         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 822
 823         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 824         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 825         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 826         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 827         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 828
 829         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 830         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 831         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 832         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 833         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 834         assert!(node_0_none.is_none());
 835
 836         assert!(nodes[0].node.list_channels().is_empty());
 837         assert!(nodes[1].node.list_channels().is_empty());
 838 }
 839
 840 #[test]
 841 fn updates_shutdown_wait() {
 842         // Test sending a shutdown with outstanding updates pending
 843         let chanmon_cfgs = create_chanmon_cfgs(3);
 844         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 845         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 846         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 847         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 848         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 849         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 850         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 851
 852         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 853
 854         nodes[0].node.close_channel(&chan_1.2).unwrap();
 855         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 856         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 857         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 858         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 859
 860         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 861         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 862
 863         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 864         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 865         else { panic!("New sends should fail!") };
 866         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 867         else { panic!("New sends should fail!") };
 868
 869         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 870         check_added_monitors!(nodes[2], 1);
 871         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 872         assert!(updates.update_add_htlcs.is_empty());
 873         assert!(updates.update_fail_htlcs.is_empty());
 874         assert!(updates.update_fail_malformed_htlcs.is_empty());
 875         assert!(updates.update_fee.is_none());
 876         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 877         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 878         check_added_monitors!(nodes[1], 1);
 879         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 880         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 881
 882         assert!(updates_2.update_add_htlcs.is_empty());
 883         assert!(updates_2.update_fail_htlcs.is_empty());
 884         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 885         assert!(updates_2.update_fee.is_none());
 886         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 887         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 888         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 889
 890         let events = nodes[0].node.get_and_clear_pending_events();
 891         assert_eq!(events.len(), 1);
 892         match events[0] {
 893                 Event::PaymentSent { ref payment_preimage } => {
 894                         assert_eq!(our_payment_preimage, *payment_preimage);
 895                 },
 896                 _ => panic!("Unexpected event"),
 897         }
 898
 899         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 900         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 901         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 902         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 903         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 904         assert!(node_0_none.is_none());
 905
 906         assert!(nodes[0].node.list_channels().is_empty());
 907
 908         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 909         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 910         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 911         assert!(nodes[1].node.list_channels().is_empty());
 912         assert!(nodes[2].node.list_channels().is_empty());
 913 }
 914
 915 #[test]
 916 fn htlc_fail_async_shutdown() {
 917         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 918         let chanmon_cfgs = create_chanmon_cfgs(3);
 919         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 920         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 921         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 922         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 923         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 924
 925         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 926         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 927         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 928         check_added_monitors!(nodes[0], 1);
 929         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 930         assert_eq!(updates.update_add_htlcs.len(), 1);
 931         assert!(updates.update_fulfill_htlcs.is_empty());
 932         assert!(updates.update_fail_htlcs.is_empty());
 933         assert!(updates.update_fail_malformed_htlcs.is_empty());
 934         assert!(updates.update_fee.is_none());
 935
 936         nodes[1].node.close_channel(&chan_1.2).unwrap();
 937         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 938         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 939         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 940
 941         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 942         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 943         check_added_monitors!(nodes[1], 1);
 944         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 945         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 946
 947         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 948         assert!(updates_2.update_add_htlcs.is_empty());
 949         assert!(updates_2.update_fulfill_htlcs.is_empty());
 950         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 951         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates_2.update_fee.is_none());
 953
 954         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 955         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 956
 957         let events = nodes[0].node.get_and_clear_pending_events();
 958         assert_eq!(events.len(), 1);
 959         match events[0] {
 960                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 961                         assert_eq!(our_payment_hash, *payment_hash);
 962                         assert!(!rejected_by_dest);
 963                 },
 964                 _ => panic!("Unexpected event"),
 965         }
 966
 967         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 968         assert_eq!(msg_events.len(), 2);
 969         let node_0_closing_signed = match msg_events[0] {
 970                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 971                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 972                         (*msg).clone()
 973                 },
 974                 _ => panic!("Unexpected event"),
 975         };
 976         match msg_events[1] {
 977                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 978                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         }
 982
 983         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 984         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 985         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 986         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 987         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 988         assert!(node_0_none.is_none());
 989
 990         assert!(nodes[0].node.list_channels().is_empty());
 991
 992         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 993         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 994         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 995         assert!(nodes[1].node.list_channels().is_empty());
 996         assert!(nodes[2].node.list_channels().is_empty());
 997 }
 998
 999 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1000         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1001         // messages delivered prior to disconnect
1002         let chanmon_cfgs = create_chanmon_cfgs(3);
1003         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1004         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1005         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1007         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1008
1009         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1010
1011         nodes[1].node.close_channel(&chan_1.2).unwrap();
1012         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1013         if recv_count > 0 {
1014                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1015                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1016                 if recv_count > 1 {
1017                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1018                 }
1019         }
1020
1021         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1022         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1023
1024         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1026         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1028
1029         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1030         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1031         assert!(node_1_shutdown == node_1_2nd_shutdown);
1032
1033         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1034         let node_0_2nd_shutdown = if recv_count > 0 {
1035                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1036                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037                 node_0_2nd_shutdown
1038         } else {
1039                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1040                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1042         };
1043         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1044
1045         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1047
1048         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
1049         check_added_monitors!(nodes[2], 1);
1050         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1051         assert!(updates.update_add_htlcs.is_empty());
1052         assert!(updates.update_fail_htlcs.is_empty());
1053         assert!(updates.update_fail_malformed_htlcs.is_empty());
1054         assert!(updates.update_fee.is_none());
1055         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1056         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1057         check_added_monitors!(nodes[1], 1);
1058         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1059         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1060
1061         assert!(updates_2.update_add_htlcs.is_empty());
1062         assert!(updates_2.update_fail_htlcs.is_empty());
1063         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates_2.update_fee.is_none());
1065         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1066         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1067         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1068
1069         let events = nodes[0].node.get_and_clear_pending_events();
1070         assert_eq!(events.len(), 1);
1071         match events[0] {
1072                 Event::PaymentSent { ref payment_preimage } => {
1073                         assert_eq!(our_payment_preimage, *payment_preimage);
1074                 },
1075                 _ => panic!("Unexpected event"),
1076         }
1077
1078         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1079         if recv_count > 0 {
1080                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1081                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1082                 assert!(node_1_closing_signed.is_some());
1083         }
1084
1085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1087
1088         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1090         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         if recv_count == 0 {
1092                 // If all closing_signeds weren't delivered we can just resume where we left off...
1093                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1094
1095                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1096                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1097                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1098
1099                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1100                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1101                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1102
1103                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1104                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1105
1106                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1107                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1108                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1109
1110                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1111                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1112                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1113                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_none.is_none());
1115         } else {
1116                 // If one node, however, received + responded with an identical closing_signed we end
1117                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1118                 // There isn't really anything better we can do simply, but in the future we might
1119                 // explore storing a set of recently-closed channels that got disconnected during
1120                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1121                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1122                 // transaction.
1123                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124
1125                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1126                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1127                 assert_eq!(msg_events.len(), 1);
1128                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1129                         match action {
1130                                 &ErrorAction::SendErrorMessage { ref msg } => {
1131                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1132                                         assert_eq!(msg.channel_id, chan_1.2);
1133                                 },
1134                                 _ => panic!("Unexpected event!"),
1135                         }
1136                 } else { panic!("Needed SendErrorMessage close"); }
1137
1138                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1139                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1140                 // closing_signed so we do it ourselves
1141                 check_closed_broadcast!(nodes[0], false);
1142                 check_added_monitors!(nodes[0], 1);
1143         }
1144
1145         assert!(nodes[0].node.list_channels().is_empty());
1146
1147         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1148         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1149         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1150         assert!(nodes[1].node.list_channels().is_empty());
1151         assert!(nodes[2].node.list_channels().is_empty());
1152 }
1153
1154 #[test]
1155 fn test_shutdown_rebroadcast() {
1156         do_test_shutdown_rebroadcast(0);
1157         do_test_shutdown_rebroadcast(1);
1158         do_test_shutdown_rebroadcast(2);
1159 }
1160
1161 #[test]
1162 fn fake_network_test() {
1163         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1164         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1165         let chanmon_cfgs = create_chanmon_cfgs(4);
1166         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1167         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1168         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1169
1170         // Create some initial channels
1171         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1172         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1173         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1174
1175         // Rebalance the network a bit by relaying one payment through all the channels...
1176         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180
1181         // Send some more payments
1182         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1183         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1184         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1185
1186         // Test failure packets
1187         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1188         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1189
1190         // Add a new channel that skips 3
1191         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1192
1193         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200
1201         // Do some rebalance loop payments, simultaneously
1202         let mut hops = Vec::with_capacity(3);
1203         hops.push(RouteHop {
1204                 pubkey: nodes[2].node.get_our_node_id(),
1205                 node_features: NodeFeatures::empty(),
1206                 short_channel_id: chan_2.0.contents.short_channel_id,
1207                 channel_features: ChannelFeatures::empty(),
1208                 fee_msat: 0,
1209                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1210         });
1211         hops.push(RouteHop {
1212                 pubkey: nodes[3].node.get_our_node_id(),
1213                 node_features: NodeFeatures::empty(),
1214                 short_channel_id: chan_3.0.contents.short_channel_id,
1215                 channel_features: ChannelFeatures::empty(),
1216                 fee_msat: 0,
1217                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1218         });
1219         hops.push(RouteHop {
1220                 pubkey: nodes[1].node.get_our_node_id(),
1221                 node_features: NodeFeatures::empty(),
1222                 short_channel_id: chan_4.0.contents.short_channel_id,
1223                 channel_features: ChannelFeatures::empty(),
1224                 fee_msat: 1000000,
1225                 cltv_expiry_delta: TEST_FINAL_CLTV,
1226         });
1227         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;
1228         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;
1229         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1230
1231         let mut hops = Vec::with_capacity(3);
1232         hops.push(RouteHop {
1233                 pubkey: nodes[3].node.get_our_node_id(),
1234                 node_features: NodeFeatures::empty(),
1235                 short_channel_id: chan_4.0.contents.short_channel_id,
1236                 channel_features: ChannelFeatures::empty(),
1237                 fee_msat: 0,
1238                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1239         });
1240         hops.push(RouteHop {
1241                 pubkey: nodes[2].node.get_our_node_id(),
1242                 node_features: NodeFeatures::empty(),
1243                 short_channel_id: chan_3.0.contents.short_channel_id,
1244                 channel_features: ChannelFeatures::empty(),
1245                 fee_msat: 0,
1246                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1247         });
1248         hops.push(RouteHop {
1249                 pubkey: nodes[1].node.get_our_node_id(),
1250                 node_features: NodeFeatures::empty(),
1251                 short_channel_id: chan_2.0.contents.short_channel_id,
1252                 channel_features: ChannelFeatures::empty(),
1253                 fee_msat: 1000000,
1254                 cltv_expiry_delta: TEST_FINAL_CLTV,
1255         });
1256         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;
1257         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;
1258         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1259
1260         // Claim the rebalances...
1261         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1262         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1263
1264         // Add a duplicate new channel from 2 to 4
1265         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1266
1267         // Send some payments across both channels
1268         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271
1272
1273         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1274         let events = nodes[0].node.get_and_clear_pending_msg_events();
1275         assert_eq!(events.len(), 0);
1276         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);
1277
1278         //TODO: Test that routes work again here as we've been notified that the channel is full
1279
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1281         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1283
1284         // Close down the channels...
1285         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1286         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1287         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1288         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1289         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1290 }
1291
1292 #[test]
1293 fn holding_cell_htlc_counting() {
1294         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1295         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1296         // commitment dance rounds.
1297         let chanmon_cfgs = create_chanmon_cfgs(3);
1298         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1299         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1300         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1301         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1302         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1303
1304         let mut payments = Vec::new();
1305         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1306                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1307                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1308                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1309                 payments.push((payment_preimage, payment_hash));
1310         }
1311         check_added_monitors!(nodes[1], 1);
1312
1313         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1314         assert_eq!(events.len(), 1);
1315         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1316         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1317
1318         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1319         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1320         // another HTLC.
1321         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1322         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1323         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1324                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1325         } else { panic!("Unexpected event"); }
1326         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1327         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1328
1329         // This should also be true if we try to forward a payment.
1330         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1331         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1332         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1333         check_added_monitors!(nodes[0], 1);
1334
1335         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1336         assert_eq!(events.len(), 1);
1337         let payment_event = SendEvent::from_event(events.pop().unwrap());
1338         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1339
1340         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1341         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1342         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1343         // fails), the second will process the resulting failure and fail the HTLC backward.
1344         expect_pending_htlcs_forwardable!(nodes[1]);
1345         expect_pending_htlcs_forwardable!(nodes[1]);
1346         check_added_monitors!(nodes[1], 1);
1347
1348         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1349         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1350         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1351
1352         let events = nodes[0].node.get_and_clear_pending_msg_events();
1353         assert_eq!(events.len(), 1);
1354         match events[0] {
1355                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1356                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1357                 },
1358                 _ => panic!("Unexpected event"),
1359         }
1360
1361         let events = nodes[0].node.get_and_clear_pending_events();
1362         assert_eq!(events.len(), 1);
1363         match events[0] {
1364                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1365                         assert_eq!(payment_hash, payment_hash_2);
1366                         assert!(!rejected_by_dest);
1367                 },
1368                 _ => panic!("Unexpected event"),
1369         }
1370
1371         // Now forward all the pending HTLCs and claim them back
1372         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1373         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1374         check_added_monitors!(nodes[2], 1);
1375
1376         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1377         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1378         check_added_monitors!(nodes[1], 1);
1379         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1380
1381         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1384
1385         for ref update in as_updates.update_add_htlcs.iter() {
1386                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1387         }
1388         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1389         check_added_monitors!(nodes[2], 1);
1390         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1391         check_added_monitors!(nodes[2], 1);
1392         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1393
1394         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1395         check_added_monitors!(nodes[1], 1);
1396         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1397         check_added_monitors!(nodes[1], 1);
1398         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1399
1400         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1401         check_added_monitors!(nodes[2], 1);
1402
1403         expect_pending_htlcs_forwardable!(nodes[2]);
1404
1405         let events = nodes[2].node.get_and_clear_pending_events();
1406         assert_eq!(events.len(), payments.len());
1407         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1408                 match event {
1409                         &Event::PaymentReceived { ref payment_hash, .. } => {
1410                                 assert_eq!(*payment_hash, *hash);
1411                         },
1412                         _ => panic!("Unexpected event"),
1413                 };
1414         }
1415
1416         for (preimage, _) in payments.drain(..) {
1417                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1418         }
1419
1420         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1421 }
1422
1423 #[test]
1424 fn duplicate_htlc_test() {
1425         // Test that we accept duplicate payment_hash HTLCs across the network and that
1426         // claiming/failing them are all separate and don't affect each other
1427         let chanmon_cfgs = create_chanmon_cfgs(6);
1428         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1429         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1430         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1431
1432         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1433         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1434         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1435         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1436         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1437         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1438
1439         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1443
1444         *nodes[0].network_payment_count.borrow_mut() -= 1;
1445         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1446
1447         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1448         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1449         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1450 }
1451
1452 #[test]
1453 fn test_duplicate_htlc_different_direction_onchain() {
1454         // Test that ChannelMonitor doesn't generate 2 preimage txn
1455         // when we have 2 HTLCs with same preimage that go across a node
1456         // in opposite directions.
1457         let chanmon_cfgs = create_chanmon_cfgs(2);
1458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1461
1462         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1463
1464         // balancing
1465         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1466
1467         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1468
1469         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1470         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1471
1472         // Provide preimage to node 0 by claiming payment
1473         nodes[0].node.claim_funds(payment_preimage, 800_000);
1474         check_added_monitors!(nodes[0], 1);
1475
1476         // Broadcast node 1 commitment txn
1477         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478
1479         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1480         let mut has_both_htlcs = 0; // check htlcs match ones committed
1481         for outp in remote_txn[0].output.iter() {
1482                 if outp.value == 800_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 } else if outp.value == 900_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 }
1487         }
1488         assert_eq!(has_both_htlcs, 2);
1489
1490         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1491         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1492         check_added_monitors!(nodes[0], 1);
1493
1494         // Check we only broadcast 1 timeout tx
1495         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1496         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()) };
1497         assert_eq!(claim_txn.len(), 5);
1498         check_spends!(claim_txn[2], chan_1.3);
1499         check_spends!(claim_txn[3], claim_txn[2]);
1500         assert_eq!(htlc_pair.0.input.len(), 1);
1501         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1502         check_spends!(htlc_pair.0, remote_txn[0]);
1503         assert_eq!(htlc_pair.1.input.len(), 1);
1504         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1505         check_spends!(htlc_pair.1, remote_txn[0]);
1506
1507         let events = nodes[0].node.get_and_clear_pending_msg_events();
1508         assert_eq!(events.len(), 2);
1509         for e in events {
1510                 match e {
1511                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1512                         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, .. } } => {
1513                                 assert!(update_add_htlcs.is_empty());
1514                                 assert!(update_fail_htlcs.is_empty());
1515                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1516                                 assert!(update_fail_malformed_htlcs.is_empty());
1517                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1518                         },
1519                         _ => panic!("Unexpected event"),
1520                 }
1521         }
1522 }
1523
1524 fn do_channel_reserve_test(test_recv: bool) {
1525
1526         let chanmon_cfgs = create_chanmon_cfgs(3);
1527         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1528         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1529         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1530         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1531         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1532
1533         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1534         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1535
1536         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1537         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1538
1539         macro_rules! get_route_and_payment_hash {
1540                 ($recv_value: expr) => {{
1541                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1542                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1543                         (route, payment_hash, payment_preimage)
1544                 }}
1545         };
1546
1547         macro_rules! expect_forward {
1548                 ($node: expr) => {{
1549                         let mut events = $node.node.get_and_clear_pending_msg_events();
1550                         assert_eq!(events.len(), 1);
1551                         check_added_monitors!($node, 1);
1552                         let payment_event = SendEvent::from_event(events.remove(0));
1553                         payment_event
1554                 }}
1555         }
1556
1557         let feemsat = 239; // somehow we know?
1558         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1559
1560         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1561
1562         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1563         {
1564                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1565                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1566                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1567                 match err {
1568                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1569                         _ => panic!("Unknown error variants"),
1570                 }
1571                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1572                 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);
1573         }
1574
1575         let mut htlc_id = 0;
1576         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1577         // nodes[0]'s wealth
1578         loop {
1579                 let amt_msat = recv_value_0 + total_fee_msat;
1580                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1581                         break;
1582                 }
1583                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1584                 htlc_id += 1;
1585
1586                 let (stat01_, stat11_, stat12_, stat22_) = (
1587                         get_channel_value_stat!(nodes[0], chan_1.2),
1588                         get_channel_value_stat!(nodes[1], chan_1.2),
1589                         get_channel_value_stat!(nodes[1], chan_2.2),
1590                         get_channel_value_stat!(nodes[2], chan_2.2),
1591                 );
1592
1593                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1594                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1595                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1596                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1597                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1598         }
1599
1600         {
1601                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1602                 // attempt to get channel_reserve violation
1603                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1604                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1605                 match err {
1606                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1607                         _ => panic!("Unknown error variants"),
1608                 }
1609                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1610                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1611         }
1612
1613         // adding pending output
1614         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1615         let amt_msat_1 = recv_value_1 + total_fee_msat;
1616
1617         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1618         let payment_event_1 = {
1619                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1620                 check_added_monitors!(nodes[0], 1);
1621
1622                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1623                 assert_eq!(events.len(), 1);
1624                 SendEvent::from_event(events.remove(0))
1625         };
1626         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1627
1628         // channel reserve test with htlc pending output > 0
1629         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1630         {
1631                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1632                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1633                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1634                         _ => panic!("Unknown error variants"),
1635                 }
1636                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1637                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1638         }
1639
1640         {
1641                 // test channel_reserve test on nodes[1] side
1642                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1643
1644                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1645                 let secp_ctx = Secp256k1::new();
1646                 let session_priv = SecretKey::from_slice(&{
1647                         let mut session_key = [0; 32];
1648                         let mut rng = thread_rng();
1649                         rng.fill_bytes(&mut session_key);
1650                         session_key
1651                 }).expect("RNG is bad!");
1652
1653                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1654                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1655                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1656                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1657                 let msg = msgs::UpdateAddHTLC {
1658                         channel_id: chan_1.2,
1659                         htlc_id,
1660                         amount_msat: htlc_msat,
1661                         payment_hash: our_payment_hash,
1662                         cltv_expiry: htlc_cltv,
1663                         onion_routing_packet: onion_packet,
1664                 };
1665
1666                 if test_recv {
1667                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1668                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1669                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1670                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1671                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1672                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1673                         check_added_monitors!(nodes[1], 1);
1674                         return;
1675                 }
1676         }
1677
1678         // split the rest to test holding cell
1679         let recv_value_21 = recv_value_2/2;
1680         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1681         {
1682                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1683                 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);
1684         }
1685
1686         // now see if they go through on both sides
1687         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1688         // but this will stuck in the holding cell
1689         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1690         check_added_monitors!(nodes[0], 0);
1691         let events = nodes[0].node.get_and_clear_pending_events();
1692         assert_eq!(events.len(), 0);
1693
1694         // test with outbound holding cell amount > 0
1695         {
1696                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1697                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1698                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1699                         _ => panic!("Unknown error variants"),
1700                 }
1701                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1702                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1703         }
1704
1705         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1706         // this will also stuck in the holding cell
1707         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1708         check_added_monitors!(nodes[0], 0);
1709         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1710         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1711
1712         // flush the pending htlc
1713         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1714         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1715         check_added_monitors!(nodes[1], 1);
1716
1717         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1718         check_added_monitors!(nodes[0], 1);
1719         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1720
1721         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1722         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1723         // No commitment_signed so get_event_msg's assert(len == 1) passes
1724         check_added_monitors!(nodes[0], 1);
1725
1726         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1727         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1728         check_added_monitors!(nodes[1], 1);
1729
1730         expect_pending_htlcs_forwardable!(nodes[1]);
1731
1732         let ref payment_event_11 = expect_forward!(nodes[1]);
1733         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1734         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1735
1736         expect_pending_htlcs_forwardable!(nodes[2]);
1737         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1738
1739         // flush the htlcs in the holding cell
1740         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1741         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1742         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1743         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1744         expect_pending_htlcs_forwardable!(nodes[1]);
1745
1746         let ref payment_event_3 = expect_forward!(nodes[1]);
1747         assert_eq!(payment_event_3.msgs.len(), 2);
1748         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1749         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1750
1751         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1752         expect_pending_htlcs_forwardable!(nodes[2]);
1753
1754         let events = nodes[2].node.get_and_clear_pending_events();
1755         assert_eq!(events.len(), 2);
1756         match events[0] {
1757                 Event::PaymentReceived { ref payment_hash, amt } => {
1758                         assert_eq!(our_payment_hash_21, *payment_hash);
1759                         assert_eq!(recv_value_21, amt);
1760                 },
1761                 _ => panic!("Unexpected event"),
1762         }
1763         match events[1] {
1764                 Event::PaymentReceived { ref payment_hash, amt } => {
1765                         assert_eq!(our_payment_hash_22, *payment_hash);
1766                         assert_eq!(recv_value_22, amt);
1767                 },
1768                 _ => panic!("Unexpected event"),
1769         }
1770
1771         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1772         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1773         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1774
1775         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);
1776         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1777         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1778         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1779
1780         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1781         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1782 }
1783
1784 #[test]
1785 fn channel_reserve_test() {
1786         do_channel_reserve_test(false);
1787         do_channel_reserve_test(true);
1788 }
1789
1790 #[test]
1791 fn channel_reserve_in_flight_removes() {
1792         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1793         // can send to its counterparty, but due to update ordering, the other side may not yet have
1794         // considered those HTLCs fully removed.
1795         // This tests that we don't count HTLCs which will not be included in the next remote
1796         // commitment transaction towards the reserve value (as it implies no commitment transaction
1797         // will be generated which violates the remote reserve value).
1798         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1799         // To test this we:
1800         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1801         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1802         //    you only consider the value of the first HTLC, it may not),
1803         //  * start routing a third HTLC from A to B,
1804         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1805         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1806         //  * deliver the first fulfill from B
1807         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1808         //    claim,
1809         //  * deliver A's response CS and RAA.
1810         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1811         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1812         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1813         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1814         let chanmon_cfgs = create_chanmon_cfgs(2);
1815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1817         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1818         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1819
1820         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1821         // Route the first two HTLCs.
1822         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1823         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1824
1825         // Start routing the third HTLC (this is just used to get everyone in the right state).
1826         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1827         let send_1 = {
1828                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1829                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1830                 check_added_monitors!(nodes[0], 1);
1831                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1832                 assert_eq!(events.len(), 1);
1833                 SendEvent::from_event(events.remove(0))
1834         };
1835
1836         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1837         // initial fulfill/CS.
1838         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1839         check_added_monitors!(nodes[1], 1);
1840         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1841
1842         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1843         // remove the second HTLC when we send the HTLC back from B to A.
1844         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1845         check_added_monitors!(nodes[1], 1);
1846         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1847
1848         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1849         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1850         check_added_monitors!(nodes[0], 1);
1851         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1852         expect_payment_sent!(nodes[0], payment_preimage_1);
1853
1854         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1855         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1856         check_added_monitors!(nodes[1], 1);
1857         // B is already AwaitingRAA, so cant generate a CS here
1858         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1859
1860         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1861         check_added_monitors!(nodes[1], 1);
1862         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1863
1864         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1865         check_added_monitors!(nodes[0], 1);
1866         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1867
1868         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1869         check_added_monitors!(nodes[1], 1);
1870         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1871
1872         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1873         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1874         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1875         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1876         // on-chain as necessary).
1877         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1878         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1879         check_added_monitors!(nodes[0], 1);
1880         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1881         expect_payment_sent!(nodes[0], payment_preimage_2);
1882
1883         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1884         check_added_monitors!(nodes[1], 1);
1885         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1886
1887         expect_pending_htlcs_forwardable!(nodes[1]);
1888         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1889
1890         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1891         // resolve the second HTLC from A's point of view.
1892         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1893         check_added_monitors!(nodes[0], 1);
1894         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1895
1896         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1897         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1898         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1899         let send_2 = {
1900                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1901                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1902                 check_added_monitors!(nodes[1], 1);
1903                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1904                 assert_eq!(events.len(), 1);
1905                 SendEvent::from_event(events.remove(0))
1906         };
1907
1908         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1909         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1910         check_added_monitors!(nodes[0], 1);
1911         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1912
1913         // Now just resolve all the outstanding messages/HTLCs for completeness...
1914
1915         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1916         check_added_monitors!(nodes[1], 1);
1917         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1918
1919         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1920         check_added_monitors!(nodes[1], 1);
1921
1922         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1923         check_added_monitors!(nodes[0], 1);
1924         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1925
1926         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1927         check_added_monitors!(nodes[1], 1);
1928         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1929
1930         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1931         check_added_monitors!(nodes[0], 1);
1932
1933         expect_pending_htlcs_forwardable!(nodes[0]);
1934         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1935
1936         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1937         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1938 }
1939
1940 #[test]
1941 fn channel_monitor_network_test() {
1942         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1943         // tests that ChannelMonitor is able to recover from various states.
1944         let chanmon_cfgs = create_chanmon_cfgs(5);
1945         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1946         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1947         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1948
1949         // Create some initial channels
1950         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1951         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1952         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1953         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1954
1955         // Rebalance the network a bit by relaying one payment through all the channels...
1956         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1957         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1958         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1959         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1960
1961         // Simple case with no pending HTLCs:
1962         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1963         check_added_monitors!(nodes[1], 1);
1964         {
1965                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1966                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1967                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1968                 check_added_monitors!(nodes[0], 1);
1969                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1970         }
1971         get_announce_close_broadcast_events(&nodes, 0, 1);
1972         assert_eq!(nodes[0].node.list_channels().len(), 0);
1973         assert_eq!(nodes[1].node.list_channels().len(), 1);
1974
1975         // One pending HTLC is discarded by the force-close:
1976         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1977
1978         // Simple case of one pending HTLC to HTLC-Timeout
1979         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1980         check_added_monitors!(nodes[1], 1);
1981         {
1982                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1983                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1984                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1985                 check_added_monitors!(nodes[2], 1);
1986                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1987         }
1988         get_announce_close_broadcast_events(&nodes, 1, 2);
1989         assert_eq!(nodes[1].node.list_channels().len(), 0);
1990         assert_eq!(nodes[2].node.list_channels().len(), 1);
1991
1992         macro_rules! claim_funds {
1993                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1994                         {
1995                                 assert!($node.node.claim_funds($preimage, $amount));
1996                                 check_added_monitors!($node, 1);
1997
1998                                 let events = $node.node.get_and_clear_pending_msg_events();
1999                                 assert_eq!(events.len(), 1);
2000                                 match events[0] {
2001                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2002                                                 assert!(update_add_htlcs.is_empty());
2003                                                 assert!(update_fail_htlcs.is_empty());
2004                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2005                                         },
2006                                         _ => panic!("Unexpected event"),
2007                                 };
2008                         }
2009                 }
2010         }
2011
2012         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2013         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2014         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2015         check_added_monitors!(nodes[2], 1);
2016         let node2_commitment_txid;
2017         {
2018                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2019                 node2_commitment_txid = node_txn[0].txid();
2020
2021                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2022                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2023
2024                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2025                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2026                 check_added_monitors!(nodes[3], 1);
2027
2028                 check_preimage_claim(&nodes[3], &node_txn);
2029         }
2030         get_announce_close_broadcast_events(&nodes, 2, 3);
2031         assert_eq!(nodes[2].node.list_channels().len(), 0);
2032         assert_eq!(nodes[3].node.list_channels().len(), 1);
2033
2034         { // Cheat and reset nodes[4]'s height to 1
2035                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2036                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2037         }
2038
2039         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2040         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2041         // One pending HTLC to time out:
2042         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2043         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2044         // buffer space).
2045
2046         {
2047                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2048                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2049                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2050                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2051                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2052                 }
2053                 check_added_monitors!(nodes[3], 1);
2054
2055                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2056                 {
2057                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2058                         node_txn.retain(|tx| {
2059                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2060                                         false
2061                                 } else { true }
2062                         });
2063                 }
2064
2065                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2066
2067                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2068                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2069
2070                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2071
2072                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2073                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2074                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2075                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2076                 }
2077
2078                 check_added_monitors!(nodes[4], 1);
2079                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2080
2081                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2082                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2083
2084                 check_preimage_claim(&nodes[4], &node_txn);
2085         }
2086         get_announce_close_broadcast_events(&nodes, 3, 4);
2087         assert_eq!(nodes[3].node.list_channels().len(), 0);
2088         assert_eq!(nodes[4].node.list_channels().len(), 0);
2089 }
2090
2091 #[test]
2092 fn test_justice_tx() {
2093         // Test justice txn built on revoked HTLC-Success tx, against both sides
2094         let mut alice_config = UserConfig::default();
2095         alice_config.channel_options.announced_channel = true;
2096         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2097         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2098         let mut bob_config = UserConfig::default();
2099         bob_config.channel_options.announced_channel = true;
2100         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2101         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2102         let user_cfgs = [Some(alice_config), Some(bob_config)];
2103         let chanmon_cfgs = create_chanmon_cfgs(2);
2104         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2105         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2106         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2107         // Create some new channels:
2108         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2109
2110         // A pending HTLC which will be revoked:
2111         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2112         // Get the will-be-revoked local txn from nodes[0]
2113         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2114         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2115         assert_eq!(revoked_local_txn[0].input.len(), 1);
2116         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2117         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2118         assert_eq!(revoked_local_txn[1].input.len(), 1);
2119         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2120         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2121         // Revoke the old state
2122         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2123
2124         {
2125                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2126                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2127                 {
2128                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2129                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2130                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2131
2132                         check_spends!(node_txn[0], revoked_local_txn[0]);
2133                         node_txn.swap_remove(0);
2134                         node_txn.truncate(1);
2135                 }
2136                 check_added_monitors!(nodes[1], 1);
2137                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2138
2139                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2140                 // Verify broadcast of revoked HTLC-timeout
2141                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2142                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2143                 check_added_monitors!(nodes[0], 1);
2144                 // Broadcast revoked HTLC-timeout on node 1
2145                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2146                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2147         }
2148         get_announce_close_broadcast_events(&nodes, 0, 1);
2149
2150         assert_eq!(nodes[0].node.list_channels().len(), 0);
2151         assert_eq!(nodes[1].node.list_channels().len(), 0);
2152
2153         // We test justice_tx build by A on B's revoked HTLC-Success tx
2154         // Create some new channels:
2155         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2156         {
2157                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2158                 node_txn.clear();
2159         }
2160
2161         // A pending HTLC which will be revoked:
2162         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2163         // Get the will-be-revoked local txn from B
2164         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2165         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2166         assert_eq!(revoked_local_txn[0].input.len(), 1);
2167         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2168         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2169         // Revoke the old state
2170         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2171         {
2172                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2173                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2174                 {
2175                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2176                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2177                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2178
2179                         check_spends!(node_txn[0], revoked_local_txn[0]);
2180                         node_txn.swap_remove(0);
2181                 }
2182                 check_added_monitors!(nodes[0], 1);
2183                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2184
2185                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2186                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2187                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2188                 check_added_monitors!(nodes[1], 1);
2189                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2190                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2191         }
2192         get_announce_close_broadcast_events(&nodes, 0, 1);
2193         assert_eq!(nodes[0].node.list_channels().len(), 0);
2194         assert_eq!(nodes[1].node.list_channels().len(), 0);
2195 }
2196
2197 #[test]
2198 fn revoked_output_claim() {
2199         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2200         // transaction is broadcast by its counterparty
2201         let chanmon_cfgs = create_chanmon_cfgs(2);
2202         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2203         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2204         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2205         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2206         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2207         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2208         assert_eq!(revoked_local_txn.len(), 1);
2209         // Only output is the full channel value back to nodes[0]:
2210         assert_eq!(revoked_local_txn[0].output.len(), 1);
2211         // Send a payment through, updating everyone's latest commitment txn
2212         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2213
2214         // Inform nodes[1] that nodes[0] broadcast a stale tx
2215         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2216         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2217         check_added_monitors!(nodes[1], 1);
2218         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2219         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2220
2221         check_spends!(node_txn[0], revoked_local_txn[0]);
2222         check_spends!(node_txn[1], chan_1.3);
2223
2224         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2225         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2226         get_announce_close_broadcast_events(&nodes, 0, 1);
2227         check_added_monitors!(nodes[0], 1)
2228 }
2229
2230 #[test]
2231 fn claim_htlc_outputs_shared_tx() {
2232         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2233         let chanmon_cfgs = create_chanmon_cfgs(2);
2234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2236         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2237
2238         // Create some new channel:
2239         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2240
2241         // Rebalance the network to generate htlc in the two directions
2242         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2243         // 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
2244         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2245         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2246
2247         // Get the will-be-revoked local txn from node[0]
2248         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2249         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2250         assert_eq!(revoked_local_txn[0].input.len(), 1);
2251         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2252         assert_eq!(revoked_local_txn[1].input.len(), 1);
2253         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2254         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2255         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2256
2257         //Revoke the old state
2258         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2259
2260         {
2261                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2262                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2263                 check_added_monitors!(nodes[0], 1);
2264                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2265                 check_added_monitors!(nodes[1], 1);
2266                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2267
2268                 let events = nodes[1].node.get_and_clear_pending_events();
2269                 assert_eq!(events.len(), 1);
2270                 match events[0] {
2271                         Event::PaymentFailed { payment_hash, .. } => {
2272                                 assert_eq!(payment_hash, payment_hash_2);
2273                         },
2274                         _ => panic!("Unexpected event"),
2275                 }
2276
2277                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2278                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2279
2280                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2281                 check_spends!(node_txn[0], revoked_local_txn[0]);
2282
2283                 let mut witness_lens = BTreeSet::new();
2284                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2285                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2286                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2287                 assert_eq!(witness_lens.len(), 3);
2288                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2289                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2290                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2291
2292                 // Next nodes[1] broadcasts its current local tx state:
2293                 assert_eq!(node_txn[1].input.len(), 1);
2294                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2295
2296                 assert_eq!(node_txn[2].input.len(), 1);
2297                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2298                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2299                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2300                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2301                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2302         }
2303         get_announce_close_broadcast_events(&nodes, 0, 1);
2304         assert_eq!(nodes[0].node.list_channels().len(), 0);
2305         assert_eq!(nodes[1].node.list_channels().len(), 0);
2306 }
2307
2308 #[test]
2309 fn claim_htlc_outputs_single_tx() {
2310         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2311         let chanmon_cfgs = create_chanmon_cfgs(2);
2312         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2313         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2314         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2315
2316         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2317
2318         // Rebalance the network to generate htlc in the two directions
2319         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2320         // 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
2321         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2322         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2323         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2324
2325         // Get the will-be-revoked local txn from node[0]
2326         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2327
2328         //Revoke the old state
2329         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2330
2331         {
2332                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2333                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2334                 check_added_monitors!(nodes[0], 1);
2335                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2336                 check_added_monitors!(nodes[1], 1);
2337                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2338
2339                 let events = nodes[1].node.get_and_clear_pending_events();
2340                 assert_eq!(events.len(), 1);
2341                 match events[0] {
2342                         Event::PaymentFailed { payment_hash, .. } => {
2343                                 assert_eq!(payment_hash, payment_hash_2);
2344                         },
2345                         _ => panic!("Unexpected event"),
2346                 }
2347
2348                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2349                 assert_eq!(node_txn.len(), 21);
2350                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2351                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2352                 // ChannelMonitor: bumped justice tx (4), after one increase, bumps on HTLC aren't generated not being substantial anymore
2353                 // ChannelMonito r: local commitment + local HTLC-timeout (14)
2354
2355                 assert_eq!(node_txn[0], node_txn[5]);
2356                 assert_eq!(node_txn[0], node_txn[7]);
2357                 assert_eq!(node_txn[0], node_txn[9]);
2358                 assert_eq!(node_txn[0], node_txn[13]);
2359                 assert_eq!(node_txn[0], node_txn[15]);
2360                 assert_eq!(node_txn[0], node_txn[17]);
2361                 assert_eq!(node_txn[0], node_txn[19]);
2362
2363                 assert_eq!(node_txn[1], node_txn[6]);
2364                 assert_eq!(node_txn[1], node_txn[8]);
2365                 assert_eq!(node_txn[1], node_txn[10]);
2366                 assert_eq!(node_txn[1], node_txn[14]);
2367                 assert_eq!(node_txn[1], node_txn[16]);
2368                 assert_eq!(node_txn[1], node_txn[18]);
2369                 assert_eq!(node_txn[1], node_txn[20]);
2370
2371
2372                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration and present 8 times (rebroadcast at every block from 200 to 206)
2373                 assert_eq!(node_txn[0].input.len(), 1);
2374                 check_spends!(node_txn[0], chan_1.3);
2375                 assert_eq!(node_txn[1].input.len(), 1);
2376                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2377                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2378                 check_spends!(node_txn[1], node_txn[0]);
2379
2380                 // Justice transactions are indices 2-3-4
2381                 assert_eq!(node_txn[2].input.len(), 1);
2382                 assert_eq!(node_txn[3].input.len(), 1);
2383                 assert_eq!(node_txn[4].input.len(), 1);
2384                 check_spends!(node_txn[2], revoked_local_txn[0]);
2385                 check_spends!(node_txn[3], revoked_local_txn[0]);
2386                 check_spends!(node_txn[4], revoked_local_txn[0]);
2387
2388                 let mut witness_lens = BTreeSet::new();
2389                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2390                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2391                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2392                 assert_eq!(witness_lens.len(), 3);
2393                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2394                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2395                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2396         }
2397         get_announce_close_broadcast_events(&nodes, 0, 1);
2398         assert_eq!(nodes[0].node.list_channels().len(), 0);
2399         assert_eq!(nodes[1].node.list_channels().len(), 0);
2400 }
2401
2402 #[test]
2403 fn test_htlc_on_chain_success() {
2404         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2405         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2406         // broadcasting the right event to other nodes in payment path.
2407         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2408         // A --------------------> B ----------------------> C (preimage)
2409         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2410         // commitment transaction was broadcast.
2411         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2412         // towards B.
2413         // B should be able to claim via preimage if A then broadcasts its local tx.
2414         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2415         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2416         // PaymentSent event).
2417
2418         let chanmon_cfgs = create_chanmon_cfgs(3);
2419         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2420         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2421         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2422
2423         // Create some initial channels
2424         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2425         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2426
2427         // Rebalance the network a bit by relaying one payment through all the channels...
2428         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2429         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2430
2431         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2432         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2433         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2434
2435         // Broadcast legit commitment tx from C on B's chain
2436         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2437         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2438         assert_eq!(commitment_tx.len(), 1);
2439         check_spends!(commitment_tx[0], chan_2.3);
2440         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2441         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2442         check_added_monitors!(nodes[2], 2);
2443         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2444         assert!(updates.update_add_htlcs.is_empty());
2445         assert!(updates.update_fail_htlcs.is_empty());
2446         assert!(updates.update_fail_malformed_htlcs.is_empty());
2447         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2448
2449         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2450         check_closed_broadcast!(nodes[2], false);
2451         check_added_monitors!(nodes[2], 1);
2452         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)
2453         assert_eq!(node_txn.len(), 7);
2454         assert_eq!(node_txn[0], node_txn[3]);
2455         assert_eq!(node_txn[1], node_txn[4]);
2456         assert_eq!(node_txn[0], node_txn[5]);
2457         assert_eq!(node_txn[1], node_txn[6]);
2458         assert_eq!(node_txn[2], commitment_tx[0]);
2459         check_spends!(node_txn[0], commitment_tx[0]);
2460         check_spends!(node_txn[1], commitment_tx[0]);
2461         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2462         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2463         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2464         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2465         assert_eq!(node_txn[0].lock_time, 0);
2466         assert_eq!(node_txn[1].lock_time, 0);
2467
2468         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2469         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2470         {
2471                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2472                 assert_eq!(added_monitors.len(), 1);
2473                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2474                 added_monitors.clear();
2475         }
2476         let events = nodes[1].node.get_and_clear_pending_msg_events();
2477         {
2478                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2479                 assert_eq!(added_monitors.len(), 2);
2480                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2481                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2482                 added_monitors.clear();
2483         }
2484         assert_eq!(events.len(), 2);
2485         match events[0] {
2486                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2487                 _ => panic!("Unexpected event"),
2488         }
2489         match events[1] {
2490                 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, .. } } => {
2491                         assert!(update_add_htlcs.is_empty());
2492                         assert!(update_fail_htlcs.is_empty());
2493                         assert_eq!(update_fulfill_htlcs.len(), 1);
2494                         assert!(update_fail_malformed_htlcs.is_empty());
2495                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2496                 },
2497                 _ => panic!("Unexpected event"),
2498         };
2499         macro_rules! check_tx_local_broadcast {
2500                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2501                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2502                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2503                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2504                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2505                         check_spends!(node_txn[0], $commitment_tx);
2506                         check_spends!(node_txn[1], $commitment_tx);
2507                         if $htlc_offered {
2508                                 assert_eq!(node_txn[0], node_txn[5]);
2509                                 assert_eq!(node_txn[1], node_txn[6]);
2510                         }
2511                         assert_ne!(node_txn[0].lock_time, 0);
2512                         assert_ne!(node_txn[1].lock_time, 0);
2513                         if $htlc_offered {
2514                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2515                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2516                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2517                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2518                         } else {
2519                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2520                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2521                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2522                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2523                         }
2524                         check_spends!(node_txn[2], $chan_tx);
2525                         check_spends!(node_txn[3], node_txn[2]);
2526                         check_spends!(node_txn[4], node_txn[2]);
2527                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2528                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2529                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2530                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2531                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2532                         assert_ne!(node_txn[3].lock_time, 0);
2533                         assert_ne!(node_txn[4].lock_time, 0);
2534                         node_txn.clear();
2535                 } }
2536         }
2537         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2538         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2539         // timeout-claim of the output that nodes[2] just claimed via success.
2540         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2541
2542         // Broadcast legit commitment tx from A on B's chain
2543         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2544         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2545         check_spends!(commitment_tx[0], chan_1.3);
2546         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2547         check_closed_broadcast!(nodes[1], false);
2548         check_added_monitors!(nodes[1], 1);
2549         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2550         assert_eq!(node_txn.len(), 4);
2551         check_spends!(node_txn[0], commitment_tx[0]);
2552         assert_eq!(node_txn[0].input.len(), 2);
2553         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2554         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2555         assert_eq!(node_txn[0].lock_time, 0);
2556         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2557         check_spends!(node_txn[1], chan_1.3);
2558         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2559         check_spends!(node_txn[2], node_txn[1]);
2560         check_spends!(node_txn[3], node_txn[1]);
2561         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2562         // we already checked the same situation with A.
2563
2564         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2565         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2566         check_closed_broadcast!(nodes[0], false);
2567         check_added_monitors!(nodes[0], 1);
2568         let events = nodes[0].node.get_and_clear_pending_events();
2569         assert_eq!(events.len(), 2);
2570         let mut first_claimed = false;
2571         for event in events {
2572                 match event {
2573                         Event::PaymentSent { payment_preimage } => {
2574                                 if payment_preimage == our_payment_preimage {
2575                                         assert!(!first_claimed);
2576                                         first_claimed = true;
2577                                 } else {
2578                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2579                                 }
2580                         },
2581                         _ => panic!("Unexpected event"),
2582                 }
2583         }
2584         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2585 }
2586
2587 #[test]
2588 fn test_htlc_on_chain_timeout() {
2589         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2590         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2591         // broadcasting the right event to other nodes in payment path.
2592         // A ------------------> B ----------------------> C (timeout)
2593         //    B's commitment tx                 C's commitment tx
2594         //            \                                  \
2595         //         B's HTLC timeout tx               B's timeout tx
2596
2597         let chanmon_cfgs = create_chanmon_cfgs(3);
2598         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2599         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2600         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2601
2602         // Create some intial channels
2603         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2604         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2605
2606         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2607         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2608         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2609
2610         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2611         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2612
2613         // Broadcast legit commitment tx from C on B's chain
2614         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2615         check_spends!(commitment_tx[0], chan_2.3);
2616         nodes[2].node.fail_htlc_backwards(&payment_hash);
2617         check_added_monitors!(nodes[2], 0);
2618         expect_pending_htlcs_forwardable!(nodes[2]);
2619         check_added_monitors!(nodes[2], 1);
2620
2621         let events = nodes[2].node.get_and_clear_pending_msg_events();
2622         assert_eq!(events.len(), 1);
2623         match events[0] {
2624                 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, .. } } => {
2625                         assert!(update_add_htlcs.is_empty());
2626                         assert!(!update_fail_htlcs.is_empty());
2627                         assert!(update_fulfill_htlcs.is_empty());
2628                         assert!(update_fail_malformed_htlcs.is_empty());
2629                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2630                 },
2631                 _ => panic!("Unexpected event"),
2632         };
2633         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2634         check_closed_broadcast!(nodes[2], false);
2635         check_added_monitors!(nodes[2], 1);
2636         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2637         assert_eq!(node_txn.len(), 1);
2638         check_spends!(node_txn[0], chan_2.3);
2639         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2640
2641         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2642         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2643         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2644         let timeout_tx;
2645         {
2646                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2647                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2648                 assert_eq!(node_txn[0], node_txn[3]);
2649                 assert_eq!(node_txn[0], node_txn[5]);
2650                 assert_eq!(node_txn[1], node_txn[4]);
2651                 assert_eq!(node_txn[1], node_txn[6]);
2652
2653                 check_spends!(node_txn[2], commitment_tx[0]);
2654                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2655
2656                 check_spends!(node_txn[0], chan_2.3);
2657                 check_spends!(node_txn[1], node_txn[0]);
2658                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2659                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2660
2661                 timeout_tx = node_txn[2].clone();
2662                 node_txn.clear();
2663         }
2664
2665         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2666         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2667         check_added_monitors!(nodes[1], 1);
2668         check_closed_broadcast!(nodes[1], false);
2669
2670         expect_pending_htlcs_forwardable!(nodes[1]);
2671         check_added_monitors!(nodes[1], 1);
2672         let events = nodes[1].node.get_and_clear_pending_msg_events();
2673         assert_eq!(events.len(), 1);
2674         match events[0] {
2675                 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, .. } } => {
2676                         assert!(update_add_htlcs.is_empty());
2677                         assert!(!update_fail_htlcs.is_empty());
2678                         assert!(update_fulfill_htlcs.is_empty());
2679                         assert!(update_fail_malformed_htlcs.is_empty());
2680                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2681                 },
2682                 _ => panic!("Unexpected event"),
2683         };
2684         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
2685         assert_eq!(node_txn.len(), 0);
2686
2687         // Broadcast legit commitment tx from B on A's chain
2688         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2689         check_spends!(commitment_tx[0], chan_1.3);
2690
2691         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2692         check_closed_broadcast!(nodes[0], false);
2693         check_added_monitors!(nodes[0], 1);
2694         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2695         assert_eq!(node_txn.len(), 3);
2696         check_spends!(node_txn[0], commitment_tx[0]);
2697         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2698         check_spends!(node_txn[1], chan_1.3);
2699         check_spends!(node_txn[2], node_txn[1]);
2700         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2701         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2702 }
2703
2704 #[test]
2705 fn test_simple_commitment_revoked_fail_backward() {
2706         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2707         // and fail backward accordingly.
2708
2709         let chanmon_cfgs = create_chanmon_cfgs(3);
2710         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2711         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2712         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2713
2714         // Create some initial channels
2715         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2716         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2717
2718         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2719         // Get the will-be-revoked local txn from nodes[2]
2720         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2721         // Revoke the old state
2722         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2723
2724         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2725
2726         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2727         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2728         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2729         check_added_monitors!(nodes[1], 1);
2730         check_closed_broadcast!(nodes[1], false);
2731
2732         expect_pending_htlcs_forwardable!(nodes[1]);
2733         check_added_monitors!(nodes[1], 1);
2734         let events = nodes[1].node.get_and_clear_pending_msg_events();
2735         assert_eq!(events.len(), 1);
2736         match events[0] {
2737                 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, .. } } => {
2738                         assert!(update_add_htlcs.is_empty());
2739                         assert_eq!(update_fail_htlcs.len(), 1);
2740                         assert!(update_fulfill_htlcs.is_empty());
2741                         assert!(update_fail_malformed_htlcs.is_empty());
2742                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2743
2744                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2745                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2746
2747                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2748                         assert_eq!(events.len(), 1);
2749                         match events[0] {
2750                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2751                                 _ => panic!("Unexpected event"),
2752                         }
2753                         let events = nodes[0].node.get_and_clear_pending_events();
2754                         assert_eq!(events.len(), 1);
2755                         match events[0] {
2756                                 Event::PaymentFailed { .. } => {},
2757                                 _ => panic!("Unexpected event"),
2758                         }
2759                 },
2760                 _ => panic!("Unexpected event"),
2761         }
2762 }
2763
2764 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2765         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2766         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2767         // commitment transaction anymore.
2768         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2769         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2770         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2771         // technically disallowed and we should probably handle it reasonably.
2772         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2773         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2774         // transactions:
2775         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2776         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2777         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2778         //   and once they revoke the previous commitment transaction (allowing us to send a new
2779         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2780         let chanmon_cfgs = create_chanmon_cfgs(3);
2781         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2782         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2783         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2784
2785         // Create some initial channels
2786         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2787         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2788
2789         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2790         // Get the will-be-revoked local txn from nodes[2]
2791         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2792         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2793         // Revoke the old state
2794         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2795
2796         let value = if use_dust {
2797                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2798                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2799                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2800         } else { 3000000 };
2801
2802         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2803         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2804         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2805
2806         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2807         expect_pending_htlcs_forwardable!(nodes[2]);
2808         check_added_monitors!(nodes[2], 1);
2809         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2810         assert!(updates.update_add_htlcs.is_empty());
2811         assert!(updates.update_fulfill_htlcs.is_empty());
2812         assert!(updates.update_fail_malformed_htlcs.is_empty());
2813         assert_eq!(updates.update_fail_htlcs.len(), 1);
2814         assert!(updates.update_fee.is_none());
2815         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2816         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2817         // Drop the last RAA from 3 -> 2
2818
2819         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2820         expect_pending_htlcs_forwardable!(nodes[2]);
2821         check_added_monitors!(nodes[2], 1);
2822         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2823         assert!(updates.update_add_htlcs.is_empty());
2824         assert!(updates.update_fulfill_htlcs.is_empty());
2825         assert!(updates.update_fail_malformed_htlcs.is_empty());
2826         assert_eq!(updates.update_fail_htlcs.len(), 1);
2827         assert!(updates.update_fee.is_none());
2828         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2829         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2830         check_added_monitors!(nodes[1], 1);
2831         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2832         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2833         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2834         check_added_monitors!(nodes[2], 1);
2835
2836         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2837         expect_pending_htlcs_forwardable!(nodes[2]);
2838         check_added_monitors!(nodes[2], 1);
2839         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2840         assert!(updates.update_add_htlcs.is_empty());
2841         assert!(updates.update_fulfill_htlcs.is_empty());
2842         assert!(updates.update_fail_malformed_htlcs.is_empty());
2843         assert_eq!(updates.update_fail_htlcs.len(), 1);
2844         assert!(updates.update_fee.is_none());
2845         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2846         // At this point first_payment_hash has dropped out of the latest two commitment
2847         // transactions that nodes[1] is tracking...
2848         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2849         check_added_monitors!(nodes[1], 1);
2850         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2851         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2852         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2853         check_added_monitors!(nodes[2], 1);
2854
2855         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2856         // on nodes[2]'s RAA.
2857         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2858         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2859         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2860         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2861         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2862         check_added_monitors!(nodes[1], 0);
2863
2864         if deliver_bs_raa {
2865                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2866                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2867                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2868                 check_added_monitors!(nodes[1], 1);
2869                 let events = nodes[1].node.get_and_clear_pending_events();
2870                 assert_eq!(events.len(), 1);
2871                 match events[0] {
2872                         Event::PendingHTLCsForwardable { .. } => { },
2873                         _ => panic!("Unexpected event"),
2874                 };
2875                 // Deliberately don't process the pending fail-back so they all fail back at once after
2876                 // block connection just like the !deliver_bs_raa case
2877         }
2878
2879         let mut failed_htlcs = HashSet::new();
2880         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2881
2882         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2883         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2884         check_added_monitors!(nodes[1], 1);
2885         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2886
2887         let events = nodes[1].node.get_and_clear_pending_events();
2888         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2889         match events[0] {
2890                 Event::PaymentFailed { ref payment_hash, .. } => {
2891                         assert_eq!(*payment_hash, fourth_payment_hash);
2892                 },
2893                 _ => panic!("Unexpected event"),
2894         }
2895         if !deliver_bs_raa {
2896                 match events[1] {
2897                         Event::PendingHTLCsForwardable { .. } => { },
2898                         _ => panic!("Unexpected event"),
2899                 };
2900         }
2901         nodes[1].node.process_pending_htlc_forwards();
2902         check_added_monitors!(nodes[1], 1);
2903
2904         let events = nodes[1].node.get_and_clear_pending_msg_events();
2905         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2906         match events[if deliver_bs_raa { 1 } else { 0 }] {
2907                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2908                 _ => panic!("Unexpected event"),
2909         }
2910         if deliver_bs_raa {
2911                 match events[0] {
2912                         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, .. } } => {
2913                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2914                                 assert_eq!(update_add_htlcs.len(), 1);
2915                                 assert!(update_fulfill_htlcs.is_empty());
2916                                 assert!(update_fail_htlcs.is_empty());
2917                                 assert!(update_fail_malformed_htlcs.is_empty());
2918                         },
2919                         _ => panic!("Unexpected event"),
2920                 }
2921         }
2922         match events[if deliver_bs_raa { 2 } else { 1 }] {
2923                 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, .. } } => {
2924                         assert!(update_add_htlcs.is_empty());
2925                         assert_eq!(update_fail_htlcs.len(), 3);
2926                         assert!(update_fulfill_htlcs.is_empty());
2927                         assert!(update_fail_malformed_htlcs.is_empty());
2928                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2929
2930                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2931                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2932                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2933
2934                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2935
2936                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2937                         // If we delivered B's RAA we got an unknown preimage error, not something
2938                         // that we should update our routing table for.
2939                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2940                         for event in events {
2941                                 match event {
2942                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2943                                         _ => panic!("Unexpected event"),
2944                                 }
2945                         }
2946                         let events = nodes[0].node.get_and_clear_pending_events();
2947                         assert_eq!(events.len(), 3);
2948                         match events[0] {
2949                                 Event::PaymentFailed { ref payment_hash, .. } => {
2950                                         assert!(failed_htlcs.insert(payment_hash.0));
2951                                 },
2952                                 _ => panic!("Unexpected event"),
2953                         }
2954                         match events[1] {
2955                                 Event::PaymentFailed { ref payment_hash, .. } => {
2956                                         assert!(failed_htlcs.insert(payment_hash.0));
2957                                 },
2958                                 _ => panic!("Unexpected event"),
2959                         }
2960                         match events[2] {
2961                                 Event::PaymentFailed { ref payment_hash, .. } => {
2962                                         assert!(failed_htlcs.insert(payment_hash.0));
2963                                 },
2964                                 _ => panic!("Unexpected event"),
2965                         }
2966                 },
2967                 _ => panic!("Unexpected event"),
2968         }
2969
2970         assert!(failed_htlcs.contains(&first_payment_hash.0));
2971         assert!(failed_htlcs.contains(&second_payment_hash.0));
2972         assert!(failed_htlcs.contains(&third_payment_hash.0));
2973 }
2974
2975 #[test]
2976 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2977         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2978         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2979         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2980         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2981 }
2982
2983 #[test]
2984 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2985         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2986         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2987         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2988         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2989 }
2990
2991 #[test]
2992 fn test_htlc_ignore_latest_remote_commitment() {
2993         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2994         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2995         let chanmon_cfgs = create_chanmon_cfgs(2);
2996         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2997         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2998         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2999         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3000
3001         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3002         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3003         check_closed_broadcast!(nodes[0], false);
3004         check_added_monitors!(nodes[0], 1);
3005
3006         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3007         assert_eq!(node_txn.len(), 2);
3008
3009         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3010         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3011         check_closed_broadcast!(nodes[1], false);
3012         check_added_monitors!(nodes[1], 1);
3013
3014         // Duplicate the block_connected call since this may happen due to other listeners
3015         // registering new transactions
3016         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3017 }
3018
3019 #[test]
3020 fn test_force_close_fail_back() {
3021         // Check which HTLCs are failed-backwards on channel force-closure
3022         let chanmon_cfgs = create_chanmon_cfgs(3);
3023         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3024         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3025         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3026         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3027         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3028
3029         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3030
3031         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3032
3033         let mut payment_event = {
3034                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3035                 check_added_monitors!(nodes[0], 1);
3036
3037                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3038                 assert_eq!(events.len(), 1);
3039                 SendEvent::from_event(events.remove(0))
3040         };
3041
3042         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3043         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3044
3045         expect_pending_htlcs_forwardable!(nodes[1]);
3046
3047         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3048         assert_eq!(events_2.len(), 1);
3049         payment_event = SendEvent::from_event(events_2.remove(0));
3050         assert_eq!(payment_event.msgs.len(), 1);
3051
3052         check_added_monitors!(nodes[1], 1);
3053         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3054         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3055         check_added_monitors!(nodes[2], 1);
3056         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3057
3058         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3059         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3060         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3061
3062         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3063         check_closed_broadcast!(nodes[2], false);
3064         check_added_monitors!(nodes[2], 1);
3065         let tx = {
3066                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3067                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3068                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3069                 // back to nodes[1] upon timeout otherwise.
3070                 assert_eq!(node_txn.len(), 1);
3071                 node_txn.remove(0)
3072         };
3073
3074         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3075         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3076
3077         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3078         check_closed_broadcast!(nodes[1], false);
3079         check_added_monitors!(nodes[1], 1);
3080
3081         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3082         {
3083                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3084                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3085                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3086         }
3087         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3088         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3089         assert_eq!(node_txn.len(), 1);
3090         assert_eq!(node_txn[0].input.len(), 1);
3091         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3092         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3093         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3094
3095         check_spends!(node_txn[0], tx);
3096 }
3097
3098 #[test]
3099 fn test_unconf_chan() {
3100         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3101         let chanmon_cfgs = create_chanmon_cfgs(2);
3102         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3103         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3104         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3105         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3106
3107         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3108         assert_eq!(channel_state.by_id.len(), 1);
3109         assert_eq!(channel_state.short_to_id.len(), 1);
3110         mem::drop(channel_state);
3111
3112         let mut headers = Vec::new();
3113         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3114         headers.push(header.clone());
3115         for _i in 2..100 {
3116                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3117                 headers.push(header.clone());
3118         }
3119         let mut height = 99;
3120         while !headers.is_empty() {
3121                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3122                 height -= 1;
3123         }
3124         check_closed_broadcast!(nodes[0], false);
3125         check_added_monitors!(nodes[0], 1);
3126         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3127         assert_eq!(channel_state.by_id.len(), 0);
3128         assert_eq!(channel_state.short_to_id.len(), 0);
3129 }
3130
3131 #[test]
3132 fn test_simple_peer_disconnect() {
3133         // Test that we can reconnect when there are no lost messages
3134         let chanmon_cfgs = create_chanmon_cfgs(3);
3135         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3136         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3137         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3138         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3139         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3140
3141         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3142         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3143         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3144
3145         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3146         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3147         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3148         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3149
3150         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3151         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3152         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3153
3154         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3155         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3156         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3157         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3158
3159         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3160         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3161
3162         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3163         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3164
3165         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3166         {
3167                 let events = nodes[0].node.get_and_clear_pending_events();
3168                 assert_eq!(events.len(), 2);
3169                 match events[0] {
3170                         Event::PaymentSent { payment_preimage } => {
3171                                 assert_eq!(payment_preimage, payment_preimage_3);
3172                         },
3173                         _ => panic!("Unexpected event"),
3174                 }
3175                 match events[1] {
3176                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3177                                 assert_eq!(payment_hash, payment_hash_5);
3178                                 assert!(rejected_by_dest);
3179                         },
3180                         _ => panic!("Unexpected event"),
3181                 }
3182         }
3183
3184         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3185         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3186 }
3187
3188 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3189         // Test that we can reconnect when in-flight HTLC updates get dropped
3190         let chanmon_cfgs = create_chanmon_cfgs(2);
3191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3193         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3194         if messages_delivered == 0 {
3195                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3196                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3197         } else {
3198                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3199         }
3200
3201         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();
3202         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3203
3204         let payment_event = {
3205                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3206                 check_added_monitors!(nodes[0], 1);
3207
3208                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3209                 assert_eq!(events.len(), 1);
3210                 SendEvent::from_event(events.remove(0))
3211         };
3212         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3213
3214         if messages_delivered < 2 {
3215                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3216         } else {
3217                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3218                 if messages_delivered >= 3 {
3219                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3220                         check_added_monitors!(nodes[1], 1);
3221                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3222
3223                         if messages_delivered >= 4 {
3224                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3225                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3226                                 check_added_monitors!(nodes[0], 1);
3227
3228                                 if messages_delivered >= 5 {
3229                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3230                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3231                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3232                                         check_added_monitors!(nodes[0], 1);
3233
3234                                         if messages_delivered >= 6 {
3235                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3236                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3237                                                 check_added_monitors!(nodes[1], 1);
3238                                         }
3239                                 }
3240                         }
3241                 }
3242         }
3243
3244         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3245         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3246         if messages_delivered < 3 {
3247                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3248                 // received on either side, both sides will need to resend them.
3249                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3250         } else if messages_delivered == 3 {
3251                 // nodes[0] still wants its RAA + commitment_signed
3252                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3253         } else if messages_delivered == 4 {
3254                 // nodes[0] still wants its commitment_signed
3255                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3256         } else if messages_delivered == 5 {
3257                 // nodes[1] still wants its final RAA
3258                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3259         } else if messages_delivered == 6 {
3260                 // Everything was delivered...
3261                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3262         }
3263
3264         let events_1 = nodes[1].node.get_and_clear_pending_events();
3265         assert_eq!(events_1.len(), 1);
3266         match events_1[0] {
3267                 Event::PendingHTLCsForwardable { .. } => { },
3268                 _ => panic!("Unexpected event"),
3269         };
3270
3271         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3272         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3273         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3274
3275         nodes[1].node.process_pending_htlc_forwards();
3276
3277         let events_2 = nodes[1].node.get_and_clear_pending_events();
3278         assert_eq!(events_2.len(), 1);
3279         match events_2[0] {
3280                 Event::PaymentReceived { ref payment_hash, amt } => {
3281                         assert_eq!(payment_hash_1, *payment_hash);
3282                         assert_eq!(amt, 1000000);
3283                 },
3284                 _ => panic!("Unexpected event"),
3285         }
3286
3287         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3288         check_added_monitors!(nodes[1], 1);
3289
3290         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3291         assert_eq!(events_3.len(), 1);
3292         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3293                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3294                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3295                         assert!(updates.update_add_htlcs.is_empty());
3296                         assert!(updates.update_fail_htlcs.is_empty());
3297                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3298                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3299                         assert!(updates.update_fee.is_none());
3300                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3301                 },
3302                 _ => panic!("Unexpected event"),
3303         };
3304
3305         if messages_delivered >= 1 {
3306                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3307
3308                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3309                 assert_eq!(events_4.len(), 1);
3310                 match events_4[0] {
3311                         Event::PaymentSent { ref payment_preimage } => {
3312                                 assert_eq!(payment_preimage_1, *payment_preimage);
3313                         },
3314                         _ => panic!("Unexpected event"),
3315                 }
3316
3317                 if messages_delivered >= 2 {
3318                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3319                         check_added_monitors!(nodes[0], 1);
3320                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3321
3322                         if messages_delivered >= 3 {
3323                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3324                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3325                                 check_added_monitors!(nodes[1], 1);
3326
3327                                 if messages_delivered >= 4 {
3328                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3329                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3330                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3331                                         check_added_monitors!(nodes[1], 1);
3332
3333                                         if messages_delivered >= 5 {
3334                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3335                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3336                                                 check_added_monitors!(nodes[0], 1);
3337                                         }
3338                                 }
3339                         }
3340                 }
3341         }
3342
3343         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3344         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3345         if messages_delivered < 2 {
3346                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3347                 //TODO: Deduplicate PaymentSent events, then enable this if:
3348                 //if messages_delivered < 1 {
3349                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3350                         assert_eq!(events_4.len(), 1);
3351                         match events_4[0] {
3352                                 Event::PaymentSent { ref payment_preimage } => {
3353                                         assert_eq!(payment_preimage_1, *payment_preimage);
3354                                 },
3355                                 _ => panic!("Unexpected event"),
3356                         }
3357                 //}
3358         } else if messages_delivered == 2 {
3359                 // nodes[0] still wants its RAA + commitment_signed
3360                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3361         } else if messages_delivered == 3 {
3362                 // nodes[0] still wants its commitment_signed
3363                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3364         } else if messages_delivered == 4 {
3365                 // nodes[1] still wants its final RAA
3366                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3367         } else if messages_delivered == 5 {
3368                 // Everything was delivered...
3369                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3370         }
3371
3372         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3373         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3374         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3375
3376         // Channel should still work fine...
3377         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3378         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3379 }
3380
3381 #[test]
3382 fn test_drop_messages_peer_disconnect_a() {
3383         do_test_drop_messages_peer_disconnect(0);
3384         do_test_drop_messages_peer_disconnect(1);
3385         do_test_drop_messages_peer_disconnect(2);
3386         do_test_drop_messages_peer_disconnect(3);
3387 }
3388
3389 #[test]
3390 fn test_drop_messages_peer_disconnect_b() {
3391         do_test_drop_messages_peer_disconnect(4);
3392         do_test_drop_messages_peer_disconnect(5);
3393         do_test_drop_messages_peer_disconnect(6);
3394 }
3395
3396 #[test]
3397 fn test_funding_peer_disconnect() {
3398         // Test that we can lock in our funding tx while disconnected
3399         let chanmon_cfgs = create_chanmon_cfgs(2);
3400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3402         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3403         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3404
3405         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3406         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3407
3408         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3409         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3410         assert_eq!(events_1.len(), 1);
3411         match events_1[0] {
3412                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3413                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3414                 },
3415                 _ => panic!("Unexpected event"),
3416         }
3417
3418         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3419
3420         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3421         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3422
3423         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3424         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3425         assert_eq!(events_2.len(), 2);
3426         let funding_locked = match events_2[0] {
3427                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3428                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3429                         msg.clone()
3430                 },
3431                 _ => panic!("Unexpected event"),
3432         };
3433         let bs_announcement_sigs = match events_2[1] {
3434                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3435                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3436                         msg.clone()
3437                 },
3438                 _ => panic!("Unexpected event"),
3439         };
3440
3441         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3442
3443         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3444         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3445         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3446         assert_eq!(events_3.len(), 2);
3447         let as_announcement_sigs = match events_3[0] {
3448                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3449                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3450                         msg.clone()
3451                 },
3452                 _ => panic!("Unexpected event"),
3453         };
3454         let (as_announcement, as_update) = match events_3[1] {
3455                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3456                         (msg.clone(), update_msg.clone())
3457                 },
3458                 _ => panic!("Unexpected event"),
3459         };
3460
3461         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3462         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3463         assert_eq!(events_4.len(), 1);
3464         let (_, bs_update) = match events_4[0] {
3465                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3466                         (msg.clone(), update_msg.clone())
3467                 },
3468                 _ => panic!("Unexpected event"),
3469         };
3470
3471         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3472         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3473         nodes[0].router.handle_channel_update(&as_update).unwrap();
3474
3475         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3476         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3477         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3478 }
3479
3480 #[test]
3481 fn test_drop_messages_peer_disconnect_dual_htlc() {
3482         // Test that we can handle reconnecting when both sides of a channel have pending
3483         // commitment_updates when we disconnect.
3484         let chanmon_cfgs = create_chanmon_cfgs(2);
3485         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3486         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3487         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3488         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3489
3490         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3491
3492         // Now try to send a second payment which will fail to send
3493         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3494         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3495
3496         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3497         check_added_monitors!(nodes[0], 1);
3498
3499         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3500         assert_eq!(events_1.len(), 1);
3501         match events_1[0] {
3502                 MessageSendEvent::UpdateHTLCs { .. } => {},
3503                 _ => panic!("Unexpected event"),
3504         }
3505
3506         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3507         check_added_monitors!(nodes[1], 1);
3508
3509         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3510         assert_eq!(events_2.len(), 1);
3511         match events_2[0] {
3512                 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 } } => {
3513                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3514                         assert!(update_add_htlcs.is_empty());
3515                         assert_eq!(update_fulfill_htlcs.len(), 1);
3516                         assert!(update_fail_htlcs.is_empty());
3517                         assert!(update_fail_malformed_htlcs.is_empty());
3518                         assert!(update_fee.is_none());
3519
3520                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3521                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3522                         assert_eq!(events_3.len(), 1);
3523                         match events_3[0] {
3524                                 Event::PaymentSent { ref payment_preimage } => {
3525                                         assert_eq!(*payment_preimage, payment_preimage_1);
3526                                 },
3527                                 _ => panic!("Unexpected event"),
3528                         }
3529
3530                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3531                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3532                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3533                         check_added_monitors!(nodes[0], 1);
3534                 },
3535                 _ => panic!("Unexpected event"),
3536         }
3537
3538         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3539         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3540
3541         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3542         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3543         assert_eq!(reestablish_1.len(), 1);
3544         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3545         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3546         assert_eq!(reestablish_2.len(), 1);
3547
3548         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3549         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3550         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3551         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3552
3553         assert!(as_resp.0.is_none());
3554         assert!(bs_resp.0.is_none());
3555
3556         assert!(bs_resp.1.is_none());
3557         assert!(bs_resp.2.is_none());
3558
3559         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3560
3561         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3562         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3563         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3564         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3565         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3566         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3567         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3568         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3569         // No commitment_signed so get_event_msg's assert(len == 1) passes
3570         check_added_monitors!(nodes[1], 1);
3571
3572         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3573         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3574         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3575         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3576         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3577         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3578         assert!(bs_second_commitment_signed.update_fee.is_none());
3579         check_added_monitors!(nodes[1], 1);
3580
3581         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3582         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3583         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3584         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3585         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3586         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3587         assert!(as_commitment_signed.update_fee.is_none());
3588         check_added_monitors!(nodes[0], 1);
3589
3590         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3591         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3592         // No commitment_signed so get_event_msg's assert(len == 1) passes
3593         check_added_monitors!(nodes[0], 1);
3594
3595         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3596         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3597         // No commitment_signed so get_event_msg's assert(len == 1) passes
3598         check_added_monitors!(nodes[1], 1);
3599
3600         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3601         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3602         check_added_monitors!(nodes[1], 1);
3603
3604         expect_pending_htlcs_forwardable!(nodes[1]);
3605
3606         let events_5 = nodes[1].node.get_and_clear_pending_events();
3607         assert_eq!(events_5.len(), 1);
3608         match events_5[0] {
3609                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3610                         assert_eq!(payment_hash_2, *payment_hash);
3611                 },
3612                 _ => panic!("Unexpected event"),
3613         }
3614
3615         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3616         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3617         check_added_monitors!(nodes[0], 1);
3618
3619         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3620 }
3621
3622 #[test]
3623 fn test_invalid_channel_announcement() {
3624         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3625         let secp_ctx = Secp256k1::new();
3626         let chanmon_cfgs = create_chanmon_cfgs(2);
3627         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3628         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3629         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3630
3631         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3632
3633         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3634         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3635         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3636         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3637
3638         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3639
3640         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3641         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3642
3643         let as_network_key = nodes[0].node.get_our_node_id();
3644         let bs_network_key = nodes[1].node.get_our_node_id();
3645
3646         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3647
3648         let mut chan_announcement;
3649
3650         macro_rules! dummy_unsigned_msg {
3651                 () => {
3652                         msgs::UnsignedChannelAnnouncement {
3653                                 features: ChannelFeatures::supported(),
3654                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3655                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3656                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3657                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3658                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3659                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3660                                 excess_data: Vec::new(),
3661                         };
3662                 }
3663         }
3664
3665         macro_rules! sign_msg {
3666                 ($unsigned_msg: expr) => {
3667                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3668                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3669                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3670                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3671                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3672                         chan_announcement = msgs::ChannelAnnouncement {
3673                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3674                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3675                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3676                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3677                                 contents: $unsigned_msg
3678                         }
3679                 }
3680         }
3681
3682         let unsigned_msg = dummy_unsigned_msg!();
3683         sign_msg!(unsigned_msg);
3684         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3685         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 } );
3686
3687         // Configured with Network::Testnet
3688         let mut unsigned_msg = dummy_unsigned_msg!();
3689         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3690         sign_msg!(unsigned_msg);
3691         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3692
3693         let mut unsigned_msg = dummy_unsigned_msg!();
3694         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3695         sign_msg!(unsigned_msg);
3696         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3697 }
3698
3699 #[test]
3700 fn test_no_txn_manager_serialize_deserialize() {
3701         let chanmon_cfgs = create_chanmon_cfgs(2);
3702         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3703         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3704         let fee_estimator: test_utils::TestFeeEstimator;
3705         let new_chan_monitor: test_utils::TestChannelMonitor;
3706         let keys_manager: test_utils::TestKeysInterface;
3707         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3708         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3709
3710         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3711
3712         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3713
3714         let nodes_0_serialized = nodes[0].node.encode();
3715         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3716         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3717
3718         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3719         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3720         nodes[0].chan_monitor = &new_chan_monitor;
3721         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3722         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3723         assert!(chan_0_monitor_read.is_empty());
3724
3725         let mut nodes_0_read = &nodes_0_serialized[..];
3726         let config = UserConfig::default();
3727         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3728         let (_, nodes_0_deserialized_tmp) = {
3729                 let mut channel_monitors = HashMap::new();
3730                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3731                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3732                         default_config: config,
3733                         keys_manager: &keys_manager,
3734                         fee_estimator: &fee_estimator,
3735                         monitor: nodes[0].chan_monitor,
3736                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3737                         logger: Arc::new(test_utils::TestLogger::new()),
3738                         channel_monitors: &mut channel_monitors,
3739                 }).unwrap()
3740         };
3741         nodes_0_deserialized = nodes_0_deserialized_tmp;
3742         assert!(nodes_0_read.is_empty());
3743
3744         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3745         nodes[0].node = &nodes_0_deserialized;
3746         nodes[0].block_notifier.register_listener(nodes[0].node);
3747         assert_eq!(nodes[0].node.list_channels().len(), 1);
3748         check_added_monitors!(nodes[0], 1);
3749
3750         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3751         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3752         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3753         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3754
3755         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3756         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3757         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3758         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3759
3760         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3761         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3762         for node in nodes.iter() {
3763                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3764                 node.router.handle_channel_update(&as_update).unwrap();
3765                 node.router.handle_channel_update(&bs_update).unwrap();
3766         }
3767
3768         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3769 }
3770
3771 #[test]
3772 fn test_simple_manager_serialize_deserialize() {
3773         let chanmon_cfgs = create_chanmon_cfgs(2);
3774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3776         let fee_estimator: test_utils::TestFeeEstimator;
3777         let new_chan_monitor: test_utils::TestChannelMonitor;
3778         let keys_manager: test_utils::TestKeysInterface;
3779         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3781         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3782
3783         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3784         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3785
3786         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3787
3788         let nodes_0_serialized = nodes[0].node.encode();
3789         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3790         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3791
3792         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3793         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3794         nodes[0].chan_monitor = &new_chan_monitor;
3795         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3796         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3797         assert!(chan_0_monitor_read.is_empty());
3798
3799         let mut nodes_0_read = &nodes_0_serialized[..];
3800         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3801         let (_, nodes_0_deserialized_tmp) = {
3802                 let mut channel_monitors = HashMap::new();
3803                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3804                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3805                         default_config: UserConfig::default(),
3806                         keys_manager: &keys_manager,
3807                         fee_estimator: &fee_estimator,
3808                         monitor: nodes[0].chan_monitor,
3809                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3810                         logger: Arc::new(test_utils::TestLogger::new()),
3811                         channel_monitors: &mut channel_monitors,
3812                 }).unwrap()
3813         };
3814         nodes_0_deserialized = nodes_0_deserialized_tmp;
3815         assert!(nodes_0_read.is_empty());
3816
3817         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3818         nodes[0].node = &nodes_0_deserialized;
3819         check_added_monitors!(nodes[0], 1);
3820
3821         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3822
3823         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3824         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3825 }
3826
3827 #[test]
3828 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3829         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3830         let chanmon_cfgs = create_chanmon_cfgs(4);
3831         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3832         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3833         let fee_estimator: test_utils::TestFeeEstimator;
3834         let new_chan_monitor: test_utils::TestChannelMonitor;
3835         let keys_manager: test_utils::TestKeysInterface;
3836         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3837         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3838         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3839         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3840         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3841
3842         let mut node_0_stale_monitors_serialized = Vec::new();
3843         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3844                 let mut writer = test_utils::TestVecWriter(Vec::new());
3845                 monitor.1.write_for_disk(&mut writer).unwrap();
3846                 node_0_stale_monitors_serialized.push(writer.0);
3847         }
3848
3849         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3850
3851         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3852         let nodes_0_serialized = nodes[0].node.encode();
3853
3854         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3855         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3856         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3857         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3858
3859         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3860         // nodes[3])
3861         let mut node_0_monitors_serialized = Vec::new();
3862         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3863                 let mut writer = test_utils::TestVecWriter(Vec::new());
3864                 monitor.1.write_for_disk(&mut writer).unwrap();
3865                 node_0_monitors_serialized.push(writer.0);
3866         }
3867
3868         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3869         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3870         nodes[0].chan_monitor = &new_chan_monitor;
3871
3872         let mut node_0_stale_monitors = Vec::new();
3873         for serialized in node_0_stale_monitors_serialized.iter() {
3874                 let mut read = &serialized[..];
3875                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3876                 assert!(read.is_empty());
3877                 node_0_stale_monitors.push(monitor);
3878         }
3879
3880         let mut node_0_monitors = Vec::new();
3881         for serialized in node_0_monitors_serialized.iter() {
3882                 let mut read = &serialized[..];
3883                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3884                 assert!(read.is_empty());
3885                 node_0_monitors.push(monitor);
3886         }
3887
3888         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3889
3890         let mut nodes_0_read = &nodes_0_serialized[..];
3891         if let Err(msgs::DecodeError::InvalidValue) =
3892                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3893                 default_config: UserConfig::default(),
3894                 keys_manager: &keys_manager,
3895                 fee_estimator: &fee_estimator,
3896                 monitor: nodes[0].chan_monitor,
3897                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3898                 logger: Arc::new(test_utils::TestLogger::new()),
3899                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3900         }) { } else {
3901                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3902         };
3903
3904         let mut nodes_0_read = &nodes_0_serialized[..];
3905         let (_, nodes_0_deserialized_tmp) =
3906                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3907                 default_config: UserConfig::default(),
3908                 keys_manager: &keys_manager,
3909                 fee_estimator: &fee_estimator,
3910                 monitor: nodes[0].chan_monitor,
3911                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3912                 logger: Arc::new(test_utils::TestLogger::new()),
3913                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3914         }).unwrap();
3915         nodes_0_deserialized = nodes_0_deserialized_tmp;
3916         assert!(nodes_0_read.is_empty());
3917
3918         { // Channel close should result in a commitment tx and an HTLC tx
3919                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3920                 assert_eq!(txn.len(), 2);
3921                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3922                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3923         }
3924
3925         for monitor in node_0_monitors.drain(..) {
3926                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3927                 check_added_monitors!(nodes[0], 1);
3928         }
3929         nodes[0].node = &nodes_0_deserialized;
3930
3931         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3932         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3933         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3934         //... and we can even still claim the payment!
3935         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3936
3937         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3938         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3939         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3940         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3941         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3942         assert_eq!(msg_events.len(), 1);
3943         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3944                 match action {
3945                         &ErrorAction::SendErrorMessage { ref msg } => {
3946                                 assert_eq!(msg.channel_id, channel_id);
3947                         },
3948                         _ => panic!("Unexpected event!"),
3949                 }
3950         }
3951 }
3952
3953 macro_rules! check_spendable_outputs {
3954         ($node: expr, $der_idx: expr) => {
3955                 {
3956                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3957                         let mut txn = Vec::new();
3958                         for event in events {
3959                                 match event {
3960                                         Event::SpendableOutputs { ref outputs } => {
3961                                                 for outp in outputs {
3962                                                         match *outp {
3963                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3964                                                                         let input = TxIn {
3965                                                                                 previous_output: outpoint.clone(),
3966                                                                                 script_sig: Script::new(),
3967                                                                                 sequence: 0,
3968                                                                                 witness: Vec::new(),
3969                                                                         };
3970                                                                         let outp = TxOut {
3971                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3972                                                                                 value: output.value,
3973                                                                         };
3974                                                                         let mut spend_tx = Transaction {
3975                                                                                 version: 2,
3976                                                                                 lock_time: 0,
3977                                                                                 input: vec![input],
3978                                                                                 output: vec![outp],
3979                                                                         };
3980                                                                         let secp_ctx = Secp256k1::new();
3981                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3982                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3983                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3984                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3985                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3986                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3987                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3988                                                                         txn.push(spend_tx);
3989                                                                 },
3990                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3991                                                                         let input = TxIn {
3992                                                                                 previous_output: outpoint.clone(),
3993                                                                                 script_sig: Script::new(),
3994                                                                                 sequence: *to_self_delay as u32,
3995                                                                                 witness: Vec::new(),
3996                                                                         };
3997                                                                         let outp = TxOut {
3998                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3999                                                                                 value: output.value,
4000                                                                         };
4001                                                                         let mut spend_tx = Transaction {
4002                                                                                 version: 2,
4003                                                                                 lock_time: 0,
4004                                                                                 input: vec![input],
4005                                                                                 output: vec![outp],
4006                                                                         };
4007                                                                         let secp_ctx = Secp256k1::new();
4008                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4009                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4010                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4011                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4012                                                                         spend_tx.input[0].witness.push(vec!());
4013                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4014                                                                         txn.push(spend_tx);
4015                                                                 },
4016                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4017                                                                         let secp_ctx = Secp256k1::new();
4018                                                                         let input = TxIn {
4019                                                                                 previous_output: outpoint.clone(),
4020                                                                                 script_sig: Script::new(),
4021                                                                                 sequence: 0,
4022                                                                                 witness: Vec::new(),
4023                                                                         };
4024                                                                         let outp = TxOut {
4025                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4026                                                                                 value: output.value,
4027                                                                         };
4028                                                                         let mut spend_tx = Transaction {
4029                                                                                 version: 2,
4030                                                                                 lock_time: 0,
4031                                                                                 input: vec![input],
4032                                                                                 output: vec![outp.clone()],
4033                                                                         };
4034                                                                         let secret = {
4035                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4036                                                                                         Ok(master_key) => {
4037                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4038                                                                                                         Ok(key) => key,
4039                                                                                                         Err(_) => panic!("Your RNG is busted"),
4040                                                                                                 }
4041                                                                                         }
4042                                                                                         Err(_) => panic!("Your rng is busted"),
4043                                                                                 }
4044                                                                         };
4045                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4046                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4047                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4048                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4049                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4050                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4051                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4052                                                                         txn.push(spend_tx);
4053                                                                 },
4054                                                         }
4055                                                 }
4056                                         },
4057                                         _ => panic!("Unexpected event"),
4058                                 };
4059                         }
4060                         txn
4061                 }
4062         }
4063 }
4064
4065 #[test]
4066 fn test_claim_sizeable_push_msat() {
4067         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4068         let chanmon_cfgs = create_chanmon_cfgs(2);
4069         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4070         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4071         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4072
4073         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4074         nodes[1].node.force_close_channel(&chan.2);
4075         check_closed_broadcast!(nodes[1], false);
4076         check_added_monitors!(nodes[1], 1);
4077         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4078         assert_eq!(node_txn.len(), 1);
4079         check_spends!(node_txn[0], chan.3);
4080         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
4081
4082         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4083         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4084         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4085
4086         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4087         assert_eq!(spend_txn.len(), 1);
4088         check_spends!(spend_txn[0], node_txn[0]);
4089 }
4090
4091 #[test]
4092 fn test_claim_on_remote_sizeable_push_msat() {
4093         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4094         // to_remote output is encumbered by a P2WPKH
4095         let chanmon_cfgs = create_chanmon_cfgs(2);
4096         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4097         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4098         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4099
4100         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4101         nodes[0].node.force_close_channel(&chan.2);
4102         check_closed_broadcast!(nodes[0], false);
4103         check_added_monitors!(nodes[0], 1);
4104
4105         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4106         assert_eq!(node_txn.len(), 1);
4107         check_spends!(node_txn[0], chan.3);
4108         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
4109
4110         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4111         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4112         check_closed_broadcast!(nodes[1], false);
4113         check_added_monitors!(nodes[1], 1);
4114         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4115
4116         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4117         assert_eq!(spend_txn.len(), 2);
4118         assert_eq!(spend_txn[0], spend_txn[1]);
4119         check_spends!(spend_txn[0], node_txn[0]);
4120 }
4121
4122 #[test]
4123 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4124         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4125         // to_remote output is encumbered by a P2WPKH
4126
4127         let chanmon_cfgs = create_chanmon_cfgs(2);
4128         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4129         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4130         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4131
4132         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4133         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4134         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4135         assert_eq!(revoked_local_txn[0].input.len(), 1);
4136         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4137
4138         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4139         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4140         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4141         check_closed_broadcast!(nodes[1], false);
4142         check_added_monitors!(nodes[1], 1);
4143
4144         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4145         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4146         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4147         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4148
4149         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4150         assert_eq!(spend_txn.len(), 3);
4151         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4152         check_spends!(spend_txn[0], revoked_local_txn[0]);
4153         check_spends!(spend_txn[2], node_txn[0]);
4154 }
4155
4156 #[test]
4157 fn test_static_spendable_outputs_preimage_tx() {
4158         let chanmon_cfgs = create_chanmon_cfgs(2);
4159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4161         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4162
4163         // Create some initial channels
4164         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4165
4166         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4167
4168         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4169         assert_eq!(commitment_tx[0].input.len(), 1);
4170         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4171
4172         // Settle A's commitment tx on B's chain
4173         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4174         assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
4175         check_added_monitors!(nodes[1], 1);
4176         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4177         check_added_monitors!(nodes[1], 1);
4178         let events = nodes[1].node.get_and_clear_pending_msg_events();
4179         match events[0] {
4180                 MessageSendEvent::UpdateHTLCs { .. } => {},
4181                 _ => panic!("Unexpected event"),
4182         }
4183         match events[1] {
4184                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4185                 _ => panic!("Unexepected event"),
4186         }
4187
4188         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4189         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4190         assert_eq!(node_txn.len(), 3);
4191         check_spends!(node_txn[0], commitment_tx[0]);
4192         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4193         check_spends!(node_txn[1], chan_1.3);
4194         check_spends!(node_txn[2], node_txn[1]);
4195
4196         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4197         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4198         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4199
4200         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4201         assert_eq!(spend_txn.len(), 1);
4202         check_spends!(spend_txn[0], node_txn[0]);
4203 }
4204
4205 #[test]
4206 fn test_static_spendable_outputs_timeout_tx() {
4207         let chanmon_cfgs = create_chanmon_cfgs(2);
4208         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4209         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4210         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4211
4212         // Create some initial channels
4213         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4214
4215         // Rebalance the network a bit by relaying one payment through all the channels ...
4216         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4217
4218         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4219
4220         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4221         assert_eq!(commitment_tx[0].input.len(), 1);
4222         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4223
4224         // Settle A's commitment tx on B' chain
4225         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4226         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4227         check_added_monitors!(nodes[1], 1);
4228         let events = nodes[1].node.get_and_clear_pending_msg_events();
4229         match events[0] {
4230                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4231                 _ => panic!("Unexpected event"),
4232         }
4233
4234         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4235         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4236         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4237         check_spends!(node_txn[0],  commitment_tx[0].clone());
4238         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4239         check_spends!(node_txn[1], chan_1.3.clone());
4240         check_spends!(node_txn[2], node_txn[1]);
4241
4242         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4243         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4244         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4245         let events = nodes[1].node.get_and_clear_pending_events();
4246         assert_eq!(events.len(), 1);
4247         match events[0] {
4248                 Event::PaymentFailed { payment_hash, .. } => {
4249                         assert_eq!(payment_hash, our_payment_hash);
4250                 },
4251                 _ => panic!("Unexpected event"),
4252         }
4253
4254         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4255         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4256         check_spends!(spend_txn[2], node_txn[0].clone());
4257 }
4258
4259 #[test]
4260 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4261         let chanmon_cfgs = create_chanmon_cfgs(2);
4262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4264         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4265
4266         // Create some initial channels
4267         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4268
4269         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4270         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4271         assert_eq!(revoked_local_txn[0].input.len(), 1);
4272         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4273
4274         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4275
4276         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4277         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4278         check_closed_broadcast!(nodes[1], false);
4279         check_added_monitors!(nodes[1], 1);
4280
4281         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4282         assert_eq!(node_txn.len(), 2);
4283         assert_eq!(node_txn[0].input.len(), 2);
4284         check_spends!(node_txn[0], revoked_local_txn[0]);
4285
4286         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4287         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4288         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4289
4290         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4291         assert_eq!(spend_txn.len(), 1);
4292         check_spends!(spend_txn[0], node_txn[0]);
4293 }
4294
4295 #[test]
4296 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4297         let chanmon_cfgs = create_chanmon_cfgs(2);
4298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4301
4302         // Create some initial channels
4303         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4304
4305         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4306         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4307         assert_eq!(revoked_local_txn[0].input.len(), 1);
4308         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4309
4310         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4311
4312         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4313         // A will generate HTLC-Timeout from revoked commitment tx
4314         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4315         check_closed_broadcast!(nodes[0], false);
4316         check_added_monitors!(nodes[0], 1);
4317
4318         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4319         assert_eq!(revoked_htlc_txn.len(), 3);
4320         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4321         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4322         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4323         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4324         check_spends!(revoked_htlc_txn[1], chan_1.3);
4325
4326         // B will generate justice tx from A's revoked commitment/HTLC tx
4327         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4328         check_closed_broadcast!(nodes[1], false);
4329         check_added_monitors!(nodes[1], 1);
4330
4331         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4332         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4333         assert_eq!(node_txn[0].input.len(), 2);
4334         check_spends!(node_txn[0], revoked_local_txn[0]);
4335         check_spends!(node_txn[1], chan_1.3);
4336         assert_eq!(node_txn[2].input.len(), 1);
4337         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4338         assert_eq!(node_txn[3].input.len(), 1);
4339         check_spends!(node_txn[3], revoked_local_txn[0]);
4340
4341         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4342         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4343         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4344
4345         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4346         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4347         assert_eq!(spend_txn.len(), 2);
4348         check_spends!(spend_txn[0], node_txn[0]);
4349         check_spends!(spend_txn[1], node_txn[2]);
4350 }
4351
4352 #[test]
4353 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4354         let chanmon_cfgs = create_chanmon_cfgs(2);
4355         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4356         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4357         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4358
4359         // Create some initial channels
4360         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4361
4362         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4363         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4364         assert_eq!(revoked_local_txn[0].input.len(), 1);
4365         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4366
4367         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4368
4369         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4370         // B will generate HTLC-Success from revoked commitment tx
4371         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4372         check_closed_broadcast!(nodes[1], false);
4373         check_added_monitors!(nodes[1], 1);
4374         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4375
4376         assert_eq!(revoked_htlc_txn.len(), 3);
4377         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4378         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4379         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4380         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4381
4382         // A will generate justice tx from B's revoked commitment/HTLC tx
4383         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4384         check_closed_broadcast!(nodes[0], false);
4385         check_added_monitors!(nodes[0], 1);
4386
4387         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4388         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4389         assert_eq!(node_txn[2].input.len(), 1);
4390         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4391
4392         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4393         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4394         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4395
4396         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4397         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4398         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4399         assert_eq!(spend_txn[0], spend_txn[1]);
4400         assert_eq!(spend_txn[0], spend_txn[2]);
4401         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4402         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4403         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4404 }
4405
4406 #[test]
4407 fn test_onchain_to_onchain_claim() {
4408         // Test that in case of channel closure, we detect the state of output thanks to
4409         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4410         // First, have C claim an HTLC against its own latest commitment transaction.
4411         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4412         // channel.
4413         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4414         // gets broadcast.
4415
4416         let chanmon_cfgs = create_chanmon_cfgs(3);
4417         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4418         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4419         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4420
4421         // Create some initial channels
4422         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4423         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4424
4425         // Rebalance the network a bit by relaying one payment through all the channels ...
4426         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4427         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4428
4429         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4430         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4431         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4432         check_spends!(commitment_tx[0], chan_2.3);
4433         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4434         check_added_monitors!(nodes[2], 1);
4435         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4436         assert!(updates.update_add_htlcs.is_empty());
4437         assert!(updates.update_fail_htlcs.is_empty());
4438         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4439         assert!(updates.update_fail_malformed_htlcs.is_empty());
4440
4441         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4442         check_closed_broadcast!(nodes[2], false);
4443         check_added_monitors!(nodes[2], 1);
4444
4445         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4446         assert_eq!(c_txn.len(), 4);
4447         assert_eq!(c_txn[0], c_txn[2]);
4448         assert_eq!(c_txn[0], c_txn[3]);
4449         assert_eq!(commitment_tx[0], c_txn[1]);
4450         check_spends!(c_txn[1], chan_2.3);
4451         check_spends!(c_txn[2], c_txn[1]);
4452         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4453         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4454         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4455         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4456
4457         // 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
4458         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4459         {
4460                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4461                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4462                 assert_eq!(b_txn.len(), 3);
4463                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4464                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4465                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4466                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4467                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4468                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4469                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4470                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4471                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4472                 b_txn.clear();
4473         }
4474         check_added_monitors!(nodes[1], 1);
4475         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4476         check_added_monitors!(nodes[1], 1);
4477         match msg_events[0] {
4478                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4479                 _ => panic!("Unexpected event"),
4480         }
4481         match msg_events[1] {
4482                 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, .. } } => {
4483                         assert!(update_add_htlcs.is_empty());
4484                         assert!(update_fail_htlcs.is_empty());
4485                         assert_eq!(update_fulfill_htlcs.len(), 1);
4486                         assert!(update_fail_malformed_htlcs.is_empty());
4487                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4488                 },
4489                 _ => panic!("Unexpected event"),
4490         };
4491         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4492         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4493         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4494         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4495         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4496         assert_eq!(b_txn.len(), 3);
4497         check_spends!(b_txn[1], chan_1.3);
4498         check_spends!(b_txn[2], b_txn[1]);
4499         check_spends!(b_txn[0], commitment_tx[0]);
4500         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4501         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4502         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4503
4504         check_closed_broadcast!(nodes[1], false);
4505         check_added_monitors!(nodes[1], 1);
4506 }
4507
4508 #[test]
4509 fn test_duplicate_payment_hash_one_failure_one_success() {
4510         // Topology : A --> B --> C
4511         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4512         let chanmon_cfgs = create_chanmon_cfgs(3);
4513         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4514         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4515         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4516
4517         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4518         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4519
4520         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4521         *nodes[0].network_payment_count.borrow_mut() -= 1;
4522         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4523
4524         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4525         assert_eq!(commitment_txn[0].input.len(), 1);
4526         check_spends!(commitment_txn[0], chan_2.3);
4527
4528         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4529         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4530         check_closed_broadcast!(nodes[1], false);
4531         check_added_monitors!(nodes[1], 1);
4532
4533         let htlc_timeout_tx;
4534         { // Extract one of the two HTLC-Timeout transaction
4535                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4536                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4537                 assert_eq!(node_txn.len(), 5);
4538                 check_spends!(node_txn[0], commitment_txn[0]);
4539                 assert_eq!(node_txn[0].input.len(), 1);
4540                 check_spends!(node_txn[1], commitment_txn[0]);
4541                 assert_eq!(node_txn[1].input.len(), 1);
4542                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4543                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4544                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4545                 check_spends!(node_txn[2], chan_2.3);
4546                 check_spends!(node_txn[3], node_txn[2]);
4547                 check_spends!(node_txn[4], node_txn[2]);
4548                 htlc_timeout_tx = node_txn[1].clone();
4549         }
4550
4551         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4552         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4553         check_added_monitors!(nodes[2], 3);
4554         let events = nodes[2].node.get_and_clear_pending_msg_events();
4555         match events[0] {
4556                 MessageSendEvent::UpdateHTLCs { .. } => {},
4557                 _ => panic!("Unexpected event"),
4558         }
4559         match events[1] {
4560                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4561                 _ => panic!("Unexepected event"),
4562         }
4563         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4564         assert_eq!(htlc_success_txn.len(), 7);
4565         check_spends!(htlc_success_txn[2], chan_2.3);
4566         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4567         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4568         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4569         assert_eq!(htlc_success_txn[0].input.len(), 1);
4570         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4571         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4572         assert_eq!(htlc_success_txn[1].input.len(), 1);
4573         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4574         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4575         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4576         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4577
4578         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4579         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4580         expect_pending_htlcs_forwardable!(nodes[1]);
4581         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4582         assert!(htlc_updates.update_add_htlcs.is_empty());
4583         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4584         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4585         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4586         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4587         check_added_monitors!(nodes[1], 1);
4588
4589         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4590         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4591         {
4592                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4593                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4594                 assert_eq!(events.len(), 1);
4595                 match events[0] {
4596                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4597                         },
4598                         _ => { panic!("Unexpected event"); }
4599                 }
4600         }
4601         let events = nodes[0].node.get_and_clear_pending_events();
4602         match events[0] {
4603                 Event::PaymentFailed { ref payment_hash, .. } => {
4604                         assert_eq!(*payment_hash, duplicate_payment_hash);
4605                 }
4606                 _ => panic!("Unexpected event"),
4607         }
4608
4609         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4610         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4611         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4612         assert!(updates.update_add_htlcs.is_empty());
4613         assert!(updates.update_fail_htlcs.is_empty());
4614         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4615         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4616         assert!(updates.update_fail_malformed_htlcs.is_empty());
4617         check_added_monitors!(nodes[1], 1);
4618
4619         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4620         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4621
4622         let events = nodes[0].node.get_and_clear_pending_events();
4623         match events[0] {
4624                 Event::PaymentSent { ref payment_preimage } => {
4625                         assert_eq!(*payment_preimage, our_payment_preimage);
4626                 }
4627                 _ => panic!("Unexpected event"),
4628         }
4629 }
4630
4631 #[test]
4632 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4633         let chanmon_cfgs = create_chanmon_cfgs(2);
4634         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4635         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4636         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4637
4638         // Create some initial channels
4639         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4640
4641         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4642         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4643         assert_eq!(local_txn[0].input.len(), 1);
4644         check_spends!(local_txn[0], chan_1.3);
4645
4646         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4647         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4648         check_added_monitors!(nodes[1], 1);
4649         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4650         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4651         check_added_monitors!(nodes[1], 1);
4652         let events = nodes[1].node.get_and_clear_pending_msg_events();
4653         match events[0] {
4654                 MessageSendEvent::UpdateHTLCs { .. } => {},
4655                 _ => panic!("Unexpected event"),
4656         }
4657         match events[1] {
4658                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4659                 _ => panic!("Unexepected event"),
4660         }
4661         let node_txn = {
4662                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4663                 assert_eq!(node_txn[0].input.len(), 1);
4664                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4665                 check_spends!(node_txn[0], local_txn[0]);
4666                 vec![node_txn[0].clone(), node_txn[2].clone()]
4667         };
4668
4669         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4670         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4671         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4672
4673         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4674         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4675         assert_eq!(spend_txn.len(), 2);
4676         check_spends!(spend_txn[0], node_txn[0]);
4677         check_spends!(spend_txn[1], node_txn[1]);
4678 }
4679
4680 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4681         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4682         // unrevoked commitment transaction.
4683         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4684         // a remote RAA before they could be failed backwards (and combinations thereof).
4685         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4686         // use the same payment hashes.
4687         // Thus, we use a six-node network:
4688         //
4689         // A \         / E
4690         //    - C - D -
4691         // B /         \ F
4692         // And test where C fails back to A/B when D announces its latest commitment transaction
4693         let chanmon_cfgs = create_chanmon_cfgs(6);
4694         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4695         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4696         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4697
4698         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4699         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4700         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4701         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4702         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4703
4704         // Rebalance and check output sanity...
4705         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4706         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4707         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4708
4709         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4710         // 0th HTLC:
4711         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
4712         // 1st HTLC:
4713         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
4714         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();
4715         // 2nd HTLC:
4716         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
4717         // 3rd HTLC:
4718         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
4719         // 4th HTLC:
4720         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4721         // 5th HTLC:
4722         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4723         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4724         // 6th HTLC:
4725         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4726         // 7th HTLC:
4727         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4728
4729         // 8th HTLC:
4730         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4731         // 9th HTLC:
4732         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();
4733         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
4734
4735         // 10th HTLC:
4736         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
4737         // 11th HTLC:
4738         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4739         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4740
4741         // Double-check that six of the new HTLC were added
4742         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4743         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4744         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4745         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4746
4747         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4748         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4749         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4750         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4751         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4752         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4753         check_added_monitors!(nodes[4], 0);
4754         expect_pending_htlcs_forwardable!(nodes[4]);
4755         check_added_monitors!(nodes[4], 1);
4756
4757         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4758         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4759         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4760         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4761         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4762         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4763
4764         // Fail 3rd below-dust and 7th above-dust HTLCs
4765         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4766         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4767         check_added_monitors!(nodes[5], 0);
4768         expect_pending_htlcs_forwardable!(nodes[5]);
4769         check_added_monitors!(nodes[5], 1);
4770
4771         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4772         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4773         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4774         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4775
4776         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4777
4778         expect_pending_htlcs_forwardable!(nodes[3]);
4779         check_added_monitors!(nodes[3], 1);
4780         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4781         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4782         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4783         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4784         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4785         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4786         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4787         if deliver_last_raa {
4788                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4789         } else {
4790                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4791         }
4792
4793         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4794         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4795         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4796         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4797         //
4798         // We now broadcast the latest commitment transaction, which *should* result in failures for
4799         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4800         // the non-broadcast above-dust HTLCs.
4801         //
4802         // Alternatively, we may broadcast the previous commitment transaction, which should only
4803         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4804         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4805
4806         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4807         if announce_latest {
4808                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4809         } else {
4810                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4811         }
4812         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4813         check_closed_broadcast!(nodes[2], false);
4814         expect_pending_htlcs_forwardable!(nodes[2]);
4815         check_added_monitors!(nodes[2], 3);
4816
4817         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4818         assert_eq!(cs_msgs.len(), 2);
4819         let mut a_done = false;
4820         for msg in cs_msgs {
4821                 match msg {
4822                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4823                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4824                                 // should be failed-backwards here.
4825                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4826                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4827                                         for htlc in &updates.update_fail_htlcs {
4828                                                 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 });
4829                                         }
4830                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4831                                         assert!(!a_done);
4832                                         a_done = true;
4833                                         &nodes[0]
4834                                 } else {
4835                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4836                                         for htlc in &updates.update_fail_htlcs {
4837                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4838                                         }
4839                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4840                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4841                                         &nodes[1]
4842                                 };
4843                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4844                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4845                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4846                                 if announce_latest {
4847                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4848                                         if *node_id == nodes[0].node.get_our_node_id() {
4849                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4850                                         }
4851                                 }
4852                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4853                         },
4854                         _ => panic!("Unexpected event"),
4855                 }
4856         }
4857
4858         let as_events = nodes[0].node.get_and_clear_pending_events();
4859         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4860         let mut as_failds = HashSet::new();
4861         for event in as_events.iter() {
4862                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4863                         assert!(as_failds.insert(*payment_hash));
4864                         if *payment_hash != payment_hash_2 {
4865                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4866                         } else {
4867                                 assert!(!rejected_by_dest);
4868                         }
4869                 } else { panic!("Unexpected event"); }
4870         }
4871         assert!(as_failds.contains(&payment_hash_1));
4872         assert!(as_failds.contains(&payment_hash_2));
4873         if announce_latest {
4874                 assert!(as_failds.contains(&payment_hash_3));
4875                 assert!(as_failds.contains(&payment_hash_5));
4876         }
4877         assert!(as_failds.contains(&payment_hash_6));
4878
4879         let bs_events = nodes[1].node.get_and_clear_pending_events();
4880         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4881         let mut bs_failds = HashSet::new();
4882         for event in bs_events.iter() {
4883                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4884                         assert!(bs_failds.insert(*payment_hash));
4885                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4886                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4887                         } else {
4888                                 assert!(!rejected_by_dest);
4889                         }
4890                 } else { panic!("Unexpected event"); }
4891         }
4892         assert!(bs_failds.contains(&payment_hash_1));
4893         assert!(bs_failds.contains(&payment_hash_2));
4894         if announce_latest {
4895                 assert!(bs_failds.contains(&payment_hash_4));
4896         }
4897         assert!(bs_failds.contains(&payment_hash_5));
4898
4899         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4900         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4901         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4902         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4903         // PaymentFailureNetworkUpdates.
4904         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4905         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4906         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4907         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4908         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4909                 match event {
4910                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4911                         _ => panic!("Unexpected event"),
4912                 }
4913         }
4914 }
4915
4916 #[test]
4917 fn test_fail_backwards_latest_remote_announce_a() {
4918         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4919 }
4920
4921 #[test]
4922 fn test_fail_backwards_latest_remote_announce_b() {
4923         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4924 }
4925
4926 #[test]
4927 fn test_fail_backwards_previous_remote_announce() {
4928         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4929         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4930         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4931 }
4932
4933 #[test]
4934 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4935         let chanmon_cfgs = create_chanmon_cfgs(2);
4936         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4937         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4938         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4939
4940         // Create some initial channels
4941         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4942
4943         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
4944         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4945         assert_eq!(local_txn[0].input.len(), 1);
4946         check_spends!(local_txn[0], chan_1.3);
4947
4948         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4949         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4950         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4951         check_closed_broadcast!(nodes[0], false);
4952         check_added_monitors!(nodes[0], 1);
4953
4954         let htlc_timeout = {
4955                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4956                 assert_eq!(node_txn[0].input.len(), 1);
4957                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4958                 check_spends!(node_txn[0], local_txn[0]);
4959                 node_txn[0].clone()
4960         };
4961
4962         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4963         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
4964         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4965         let events = nodes[0].node.get_and_clear_pending_events();
4966         assert_eq!(events.len(), 1);
4967         match events[0] {
4968                 Event::PaymentFailed { payment_hash, .. } => {
4969                         assert_eq!(payment_hash, our_payment_hash);
4970                 },
4971                 _ => panic!("Unexpected event"),
4972         }
4973
4974         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4975         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4976         assert_eq!(spend_txn.len(), 3);
4977         assert_eq!(spend_txn[0], spend_txn[1]);
4978         check_spends!(spend_txn[0], local_txn[0]);
4979         check_spends!(spend_txn[2], htlc_timeout);
4980 }
4981
4982 #[test]
4983 fn test_static_output_closing_tx() {
4984         let chanmon_cfgs = create_chanmon_cfgs(2);
4985         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4986         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4987         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4988
4989         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4990
4991         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4992         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4993
4994         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4995         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
4996         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
4997
4998         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4999         assert_eq!(spend_txn.len(), 1);
5000         check_spends!(spend_txn[0], closing_tx);
5001
5002         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5003         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5004
5005         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5006         assert_eq!(spend_txn.len(), 1);
5007         check_spends!(spend_txn[0], closing_tx);
5008 }
5009
5010 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5011         let chanmon_cfgs = create_chanmon_cfgs(2);
5012         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5013         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5014         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5015         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5016
5017         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5018
5019         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5020         // present in B's local commitment transaction, but none of A's commitment transactions.
5021         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
5022         check_added_monitors!(nodes[1], 1);
5023
5024         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5025         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5026         let events = nodes[0].node.get_and_clear_pending_events();
5027         assert_eq!(events.len(), 1);
5028         match events[0] {
5029                 Event::PaymentSent { payment_preimage } => {
5030                         assert_eq!(payment_preimage, our_payment_preimage);
5031                 },
5032                 _ => panic!("Unexpected event"),
5033         }
5034
5035         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5036         check_added_monitors!(nodes[0], 1);
5037         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5038         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5039         check_added_monitors!(nodes[1], 1);
5040
5041         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5042         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5043                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5044                 header.prev_blockhash = header.bitcoin_hash();
5045         }
5046         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5047         check_closed_broadcast!(nodes[1], false);
5048         check_added_monitors!(nodes[1], 1);
5049 }
5050
5051 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5052         let chanmon_cfgs = create_chanmon_cfgs(2);
5053         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5054         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5055         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5056         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5057
5058         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();
5059         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5060         nodes[0].node.send_payment(route, payment_hash).unwrap();
5061         check_added_monitors!(nodes[0], 1);
5062
5063         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5064
5065         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5066         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5067         // to "time out" the HTLC.
5068
5069         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5070
5071         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5072                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5073                 header.prev_blockhash = header.bitcoin_hash();
5074         }
5075         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5076         check_closed_broadcast!(nodes[0], false);
5077         check_added_monitors!(nodes[0], 1);
5078 }
5079
5080 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5081         let chanmon_cfgs = create_chanmon_cfgs(3);
5082         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5083         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5084         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5085         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5086
5087         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5088         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5089         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5090         // actually revoked.
5091         let htlc_value = if use_dust { 50000 } else { 3000000 };
5092         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5093         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5094         expect_pending_htlcs_forwardable!(nodes[1]);
5095         check_added_monitors!(nodes[1], 1);
5096
5097         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5098         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5099         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5100         check_added_monitors!(nodes[0], 1);
5101         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5102         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5103         check_added_monitors!(nodes[1], 1);
5104         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5105         check_added_monitors!(nodes[1], 1);
5106         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5107
5108         if check_revoke_no_close {
5109                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5110                 check_added_monitors!(nodes[0], 1);
5111         }
5112
5113         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5114         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5115                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5116                 header.prev_blockhash = header.bitcoin_hash();
5117         }
5118         if !check_revoke_no_close {
5119                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5120                 check_closed_broadcast!(nodes[0], false);
5121                 check_added_monitors!(nodes[0], 1);
5122         } else {
5123                 let events = nodes[0].node.get_and_clear_pending_events();
5124                 assert_eq!(events.len(), 1);
5125                 match events[0] {
5126                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5127                                 assert_eq!(payment_hash, our_payment_hash);
5128                                 assert!(rejected_by_dest);
5129                         },
5130                         _ => panic!("Unexpected event"),
5131                 }
5132         }
5133 }
5134
5135 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5136 // There are only a few cases to test here:
5137 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5138 //    broadcastable commitment transactions result in channel closure,
5139 //  * its included in an unrevoked-but-previous remote commitment transaction,
5140 //  * its included in the latest remote or local commitment transactions.
5141 // We test each of the three possible commitment transactions individually and use both dust and
5142 // non-dust HTLCs.
5143 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5144 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5145 // tested for at least one of the cases in other tests.
5146 #[test]
5147 fn htlc_claim_single_commitment_only_a() {
5148         do_htlc_claim_local_commitment_only(true);
5149         do_htlc_claim_local_commitment_only(false);
5150
5151         do_htlc_claim_current_remote_commitment_only(true);
5152         do_htlc_claim_current_remote_commitment_only(false);
5153 }
5154
5155 #[test]
5156 fn htlc_claim_single_commitment_only_b() {
5157         do_htlc_claim_previous_remote_commitment_only(true, false);
5158         do_htlc_claim_previous_remote_commitment_only(false, false);
5159         do_htlc_claim_previous_remote_commitment_only(true, true);
5160         do_htlc_claim_previous_remote_commitment_only(false, true);
5161 }
5162
5163 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>)
5164         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5165                                 F2: FnMut(),
5166 {
5167         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);
5168 }
5169
5170 // test_case
5171 // 0: node1 fails backward
5172 // 1: final node fails backward
5173 // 2: payment completed but the user rejects the payment
5174 // 3: final node fails backward (but tamper onion payloads from node0)
5175 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5176 // 200: trigger error in the final node and tamper returning fail_htlc
5177 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>)
5178         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5179                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5180                                 F3: FnMut(),
5181 {
5182
5183         // reset block height
5184         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5185         for ix in 0..nodes.len() {
5186                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5187         }
5188
5189         macro_rules! expect_event {
5190                 ($node: expr, $event_type: path) => {{
5191                         let events = $node.node.get_and_clear_pending_events();
5192                         assert_eq!(events.len(), 1);
5193                         match events[0] {
5194                                 $event_type { .. } => {},
5195                                 _ => panic!("Unexpected event"),
5196                         }
5197                 }}
5198         }
5199
5200         macro_rules! expect_htlc_forward {
5201                 ($node: expr) => {{
5202                         expect_event!($node, Event::PendingHTLCsForwardable);
5203                         $node.node.process_pending_htlc_forwards();
5204                 }}
5205         }
5206
5207         // 0 ~~> 2 send payment
5208         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
5209         check_added_monitors!(nodes[0], 1);
5210         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5211         // temper update_add (0 => 1)
5212         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5213         if test_case == 0 || test_case == 3 || test_case == 100 {
5214                 callback_msg(&mut update_add_0);
5215                 callback_node();
5216         }
5217         // 0 => 1 update_add & CS
5218         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5219         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5220
5221         let update_1_0 = match test_case {
5222                 0|100 => { // intermediate node failure; fail backward to 0
5223                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5224                         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));
5225                         update_1_0
5226                 },
5227                 1|2|3|200 => { // final node failure; forwarding to 2
5228                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5229                         // forwarding on 1
5230                         if test_case != 200 {
5231                                 callback_node();
5232                         }
5233                         expect_htlc_forward!(&nodes[1]);
5234
5235                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5236                         check_added_monitors!(&nodes[1], 1);
5237                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5238                         // tamper update_add (1 => 2)
5239                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5240                         if test_case != 3 && test_case != 200 {
5241                                 callback_msg(&mut update_add_1);
5242                         }
5243
5244                         // 1 => 2
5245                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5246                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5247
5248                         if test_case == 2 || test_case == 200 {
5249                                 expect_htlc_forward!(&nodes[2]);
5250                                 expect_event!(&nodes[2], Event::PaymentReceived);
5251                                 callback_node();
5252                                 expect_pending_htlcs_forwardable!(nodes[2]);
5253                         }
5254
5255                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5256                         if test_case == 2 || test_case == 200 {
5257                                 check_added_monitors!(&nodes[2], 1);
5258                         }
5259                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5260
5261                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5262                         if test_case == 200 {
5263                                 callback_fail(&mut fail_msg);
5264                         }
5265
5266                         // 2 => 1
5267                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5268                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5269
5270                         // backward fail on 1
5271                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5272                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5273                         update_1_0
5274                 },
5275                 _ => unreachable!(),
5276         };
5277
5278         // 1 => 0 commitment_signed_dance
5279         if update_1_0.update_fail_htlcs.len() > 0 {
5280                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5281                 if test_case == 100 {
5282                         callback_fail(&mut fail_msg);
5283                 }
5284                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5285         } else {
5286                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5287         };
5288
5289         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5290
5291         let events = nodes[0].node.get_and_clear_pending_events();
5292         assert_eq!(events.len(), 1);
5293         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5294                 assert_eq!(*rejected_by_dest, !expected_retryable);
5295                 assert_eq!(*error_code, expected_error_code);
5296         } else {
5297                 panic!("Uexpected event");
5298         }
5299
5300         let events = nodes[0].node.get_and_clear_pending_msg_events();
5301         if expected_channel_update.is_some() {
5302                 assert_eq!(events.len(), 1);
5303                 match events[0] {
5304                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5305                                 match update {
5306                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5307                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5308                                                         panic!("channel_update not found!");
5309                                                 }
5310                                         },
5311                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5312                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5313                                                         assert!(*short_channel_id == *expected_short_channel_id);
5314                                                         assert!(*is_permanent == *expected_is_permanent);
5315                                                 } else {
5316                                                         panic!("Unexpected message event");
5317                                                 }
5318                                         },
5319                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5320                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5321                                                         assert!(*node_id == *expected_node_id);
5322                                                         assert!(*is_permanent == *expected_is_permanent);
5323                                                 } else {
5324                                                         panic!("Unexpected message event");
5325                                                 }
5326                                         },
5327                                 }
5328                         },
5329                         _ => panic!("Unexpected message event"),
5330                 }
5331         } else {
5332                 assert_eq!(events.len(), 0);
5333         }
5334 }
5335
5336 impl msgs::ChannelUpdate {
5337         fn dummy() -> msgs::ChannelUpdate {
5338                 use secp256k1::ffi::Signature as FFISignature;
5339                 use secp256k1::Signature;
5340                 msgs::ChannelUpdate {
5341                         signature: Signature::from(FFISignature::new()),
5342                         contents: msgs::UnsignedChannelUpdate {
5343                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5344                                 short_channel_id: 0,
5345                                 timestamp: 0,
5346                                 flags: 0,
5347                                 cltv_expiry_delta: 0,
5348                                 htlc_minimum_msat: 0,
5349                                 fee_base_msat: 0,
5350                                 fee_proportional_millionths: 0,
5351                                 excess_data: vec![],
5352                         }
5353                 }
5354         }
5355 }
5356
5357 struct BogusOnionHopData {
5358         data: Vec<u8>
5359 }
5360 impl BogusOnionHopData {
5361         fn new(orig: msgs::OnionHopData) -> Self {
5362                 Self { data: orig.encode() }
5363         }
5364 }
5365 impl Writeable for BogusOnionHopData {
5366         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5367                 writer.write_all(&self.data[..])
5368         }
5369 }
5370
5371 #[test]
5372 fn test_onion_failure() {
5373         use ln::msgs::ChannelUpdate;
5374         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5375         use secp256k1;
5376
5377         const BADONION: u16 = 0x8000;
5378         const PERM: u16 = 0x4000;
5379         const NODE: u16 = 0x2000;
5380         const UPDATE: u16 = 0x1000;
5381
5382         let chanmon_cfgs = create_chanmon_cfgs(3);
5383         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5384         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5385         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5386         for node in nodes.iter() {
5387                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5388         }
5389         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())];
5390         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5391         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5392         // positve case
5393         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5394
5395         // intermediate node failure
5396         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5397                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5398                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5399                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5400                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5401                 let mut new_payloads = Vec::new();
5402                 for payload in onion_payloads.drain(..) {
5403                         new_payloads.push(BogusOnionHopData::new(payload));
5404                 }
5405                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5406                 // describing a length-1 TLV payload, which is obviously bogus.
5407                 new_payloads[0].data[0] = 1;
5408                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5409         }, ||{}, 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
5410
5411         // final node failure
5412         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5413                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5414                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5415                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5416                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5417                 let mut new_payloads = Vec::new();
5418                 for payload in onion_payloads.drain(..) {
5419                         new_payloads.push(BogusOnionHopData::new(payload));
5420                 }
5421                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5422                 // length-1 TLV payload, which is obviously bogus.
5423                 new_payloads[1].data[0] = 1;
5424                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5425         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5426
5427         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5428         // receiving simulated fail messages
5429         // intermediate node failure
5430         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5431                 // trigger error
5432                 msg.amount_msat -= 1;
5433         }, |msg| {
5434                 // and tamper returning error message
5435                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5436                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5437                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5438         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5439
5440         // final node failure
5441         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5442                 // and tamper returning error message
5443                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5444                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5445                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5446         }, ||{
5447                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5448         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5449
5450         // intermediate node failure
5451         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5452                 msg.amount_msat -= 1;
5453         }, |msg| {
5454                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5455                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5456                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5457         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5458
5459         // final node failure
5460         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5461                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5462                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5463                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5464         }, ||{
5465                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5466         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5467
5468         // intermediate node failure
5469         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5470                 msg.amount_msat -= 1;
5471         }, |msg| {
5472                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5473                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5474                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5475         }, ||{
5476                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5477         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5478
5479         // final node failure
5480         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5481                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5482                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5483                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5484         }, ||{
5485                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5486         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5487
5488         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5489                 Some(BADONION|PERM|4), None);
5490
5491         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5492                 Some(BADONION|PERM|5), None);
5493
5494         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5495                 Some(BADONION|PERM|6), None);
5496
5497         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5498                 msg.amount_msat -= 1;
5499         }, |msg| {
5500                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5501                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5502                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5503         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5504
5505         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5506                 msg.amount_msat -= 1;
5507         }, |msg| {
5508                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5509                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5510                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5511                 // short_channel_id from the processing node
5512         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5513
5514         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5515                 msg.amount_msat -= 1;
5516         }, |msg| {
5517                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5518                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5519                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5520                 // short_channel_id from the processing node
5521         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5522
5523         let mut bogus_route = route.clone();
5524         bogus_route.hops[1].short_channel_id -= 1;
5525         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5526           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5527
5528         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5529         let mut bogus_route = route.clone();
5530         let route_len = bogus_route.hops.len();
5531         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5532         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5533
5534         //TODO: with new config API, we will be able to generate both valid and
5535         //invalid channel_update cases.
5536         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5537                 msg.amount_msat -= 1;
5538         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5539
5540         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5541                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5542                 msg.cltv_expiry -= 1;
5543         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5544
5545         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5546                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5547                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5548
5549                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5550         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5551
5552         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5553                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5554         }, false, Some(PERM|15), None);
5555
5556         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5557                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5558                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5559
5560                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5561         }, || {}, true, Some(17), None);
5562
5563         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5564                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5565                         for f in pending_forwards.iter_mut() {
5566                                 match f {
5567                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5568                                                 forward_info.outgoing_cltv_value += 1,
5569                                         _ => {},
5570                                 }
5571                         }
5572                 }
5573         }, true, Some(18), None);
5574
5575         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5576                 // violate amt_to_forward > msg.amount_msat
5577                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5578                         for f in pending_forwards.iter_mut() {
5579                                 match f {
5580                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5581                                                 forward_info.amt_to_forward -= 1,
5582                                         _ => {},
5583                                 }
5584                         }
5585                 }
5586         }, true, Some(19), None);
5587
5588         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5589                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5590                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5591                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5592         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5593         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5594
5595         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5596                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5597                 let mut route = route.clone();
5598                 let height = 1;
5599                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5600                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5601                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5602                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5603                 msg.cltv_expiry = htlc_cltv;
5604                 msg.onion_routing_packet = onion_packet;
5605         }, ||{}, true, Some(21), None);
5606 }
5607
5608 #[test]
5609 #[should_panic]
5610 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5611         let chanmon_cfgs = create_chanmon_cfgs(2);
5612         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5613         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5614         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5615         //Force duplicate channel ids
5616         for node in nodes.iter() {
5617                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5618         }
5619
5620         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5621         let channel_value_satoshis=10000;
5622         let push_msat=10001;
5623         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5624         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5625         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5626
5627         //Create a second channel with a channel_id collision
5628         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5629 }
5630
5631 #[test]
5632 fn bolt2_open_channel_sending_node_checks_part2() {
5633         let chanmon_cfgs = create_chanmon_cfgs(2);
5634         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5635         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5636         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5637
5638         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5639         let channel_value_satoshis=2^24;
5640         let push_msat=10001;
5641         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5642
5643         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5644         let channel_value_satoshis=10000;
5645         // Test when push_msat is equal to 1000 * funding_satoshis.
5646         let push_msat=1000*channel_value_satoshis+1;
5647         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5648
5649         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5650         let channel_value_satoshis=10000;
5651         let push_msat=10001;
5652         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_ok()); //Create a valid channel
5653         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5654         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5655
5656         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5657         // 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
5658         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5659
5660         // 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.
5661         assert!(BREAKDOWN_TIMEOUT>0);
5662         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5663
5664         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5665         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5666         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5667
5668         // 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.
5669         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5670         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5671         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5672         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5673         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5674 }
5675
5676 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5677 // 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.
5678 //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.
5679
5680 #[test]
5681 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5682         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5683         let chanmon_cfgs = create_chanmon_cfgs(2);
5684         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5685         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5686         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5687         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5688         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5689         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5690
5691         route.hops[0].fee_msat = 100;
5692
5693         let err = nodes[0].node.send_payment(route, our_payment_hash);
5694
5695         if let Err(APIError::ChannelUnavailable{err}) = err {
5696                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5697         } else {
5698                 assert!(false);
5699         }
5700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5701         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5702 }
5703
5704 #[test]
5705 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5706         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5707         let chanmon_cfgs = create_chanmon_cfgs(2);
5708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5710         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5711         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5712         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5713         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5714
5715         route.hops[0].fee_msat = 0;
5716
5717         let err = nodes[0].node.send_payment(route, our_payment_hash);
5718
5719         if let Err(APIError::ChannelUnavailable{err}) = err {
5720                 assert_eq!(err, "Cannot send 0-msat HTLC");
5721         } else {
5722                 assert!(false);
5723         }
5724         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5725         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5726 }
5727
5728 #[test]
5729 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5730         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5731         let chanmon_cfgs = create_chanmon_cfgs(2);
5732         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5733         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5734         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5735         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5736         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5737         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5738
5739         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5740         check_added_monitors!(nodes[0], 1);
5741         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5742         updates.update_add_htlcs[0].amount_msat = 0;
5743
5744         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5745         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5746         check_closed_broadcast!(nodes[1], true).unwrap();
5747         check_added_monitors!(nodes[1], 1);
5748 }
5749
5750 #[test]
5751 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5752         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5753         //It is enforced when constructing a route.
5754         let chanmon_cfgs = create_chanmon_cfgs(2);
5755         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5756         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5757         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5758         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5759         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5760         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5761
5762         let err = nodes[0].node.send_payment(route, our_payment_hash);
5763
5764         if let Err(APIError::RouteError{err}) = err {
5765                 assert_eq!(err, "Channel CLTV overflowed?!");
5766         } else {
5767                 assert!(false);
5768         }
5769 }
5770
5771 #[test]
5772 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5773         //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.
5774         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5775         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5776         let chanmon_cfgs = create_chanmon_cfgs(2);
5777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5779         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5780         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5781         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5782
5783         for i in 0..max_accepted_htlcs {
5784                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5785                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5786                 let payment_event = {
5787                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5788                         check_added_monitors!(nodes[0], 1);
5789
5790                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5791                         assert_eq!(events.len(), 1);
5792                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5793                                 assert_eq!(htlcs[0].htlc_id, i);
5794                         } else {
5795                                 assert!(false);
5796                         }
5797                         SendEvent::from_event(events.remove(0))
5798                 };
5799                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5800                 check_added_monitors!(nodes[1], 0);
5801                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5802
5803                 expect_pending_htlcs_forwardable!(nodes[1]);
5804                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5805         }
5806         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5807         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5808         let err = nodes[0].node.send_payment(route, our_payment_hash);
5809
5810         if let Err(APIError::ChannelUnavailable{err}) = err {
5811                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5812         } else {
5813                 assert!(false);
5814         }
5815         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5816         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5817 }
5818
5819 #[test]
5820 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5821         //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.
5822         let chanmon_cfgs = create_chanmon_cfgs(2);
5823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5825         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5826         let channel_value = 100000;
5827         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5828         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5829
5830         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5831
5832         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5833         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5834         let err = nodes[0].node.send_payment(route, our_payment_hash);
5835
5836         if let Err(APIError::ChannelUnavailable{err}) = err {
5837                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5838         } else {
5839                 assert!(false);
5840         }
5841         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5842         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);
5843
5844         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5845 }
5846
5847 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5848 #[test]
5849 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5850         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5851         let chanmon_cfgs = create_chanmon_cfgs(2);
5852         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5853         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5854         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5855         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5856         let htlc_minimum_msat: u64;
5857         {
5858                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5859                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5860                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5861         }
5862         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5863         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5864         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5865         check_added_monitors!(nodes[0], 1);
5866         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5867         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5868         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5869         assert!(nodes[1].node.list_channels().is_empty());
5870         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5871         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5872         check_added_monitors!(nodes[1], 1);
5873 }
5874
5875 #[test]
5876 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5877         //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
5878         let chanmon_cfgs = create_chanmon_cfgs(2);
5879         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5880         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5881         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5882         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5883
5884         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5885
5886         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5887         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5888         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5889         check_added_monitors!(nodes[0], 1);
5890         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5891
5892         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5893         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5894
5895         assert!(nodes[1].node.list_channels().is_empty());
5896         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5897         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5898         check_added_monitors!(nodes[1], 1);
5899 }
5900
5901 #[test]
5902 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5903         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5904         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5905         let chanmon_cfgs = create_chanmon_cfgs(2);
5906         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5907         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5908         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5909         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5910         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5911         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5912
5913         let session_priv = SecretKey::from_slice(&{
5914                 let mut session_key = [0; 32];
5915                 let mut rng = thread_rng();
5916                 rng.fill_bytes(&mut session_key);
5917                 session_key
5918         }).expect("RNG is bad!");
5919
5920         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5921         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5922         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5923         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5924
5925         let mut msg = msgs::UpdateAddHTLC {
5926                 channel_id: chan.2,
5927                 htlc_id: 0,
5928                 amount_msat: 1000,
5929                 payment_hash: our_payment_hash,
5930                 cltv_expiry: htlc_cltv,
5931                 onion_routing_packet: onion_packet.clone(),
5932         };
5933
5934         for i in 0..super::channel::OUR_MAX_HTLCS {
5935                 msg.htlc_id = i as u64;
5936                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5937         }
5938         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5939         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5940
5941         assert!(nodes[1].node.list_channels().is_empty());
5942         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5943         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5944         check_added_monitors!(nodes[1], 1);
5945 }
5946
5947 #[test]
5948 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5949         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5950         let chanmon_cfgs = create_chanmon_cfgs(2);
5951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5953         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5954         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5955         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5956         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5957         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5958         check_added_monitors!(nodes[0], 1);
5959         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5960         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5961         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5962
5963         assert!(nodes[1].node.list_channels().is_empty());
5964         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5965         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5966         check_added_monitors!(nodes[1], 1);
5967 }
5968
5969 #[test]
5970 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5971         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5972         let chanmon_cfgs = create_chanmon_cfgs(2);
5973         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5974         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5975         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5976         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5977         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5978         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5979         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5980         check_added_monitors!(nodes[0], 1);
5981         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5982         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5983         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5984
5985         assert!(nodes[1].node.list_channels().is_empty());
5986         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5987         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5988         check_added_monitors!(nodes[1], 1);
5989 }
5990
5991 #[test]
5992 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5993         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5994         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5995         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5996         let chanmon_cfgs = create_chanmon_cfgs(2);
5997         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5998         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5999         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6000         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6001         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6002         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6003         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6004         check_added_monitors!(nodes[0], 1);
6005         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6006         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6007
6008         //Disconnect and Reconnect
6009         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6010         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6011         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6012         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6013         assert_eq!(reestablish_1.len(), 1);
6014         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6015         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6016         assert_eq!(reestablish_2.len(), 1);
6017         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6018         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6019         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6020         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6021
6022         //Resend HTLC
6023         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6024         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6025         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6026         check_added_monitors!(nodes[1], 1);
6027         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6028
6029         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6030
6031         assert!(nodes[1].node.list_channels().is_empty());
6032         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6033         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6034         check_added_monitors!(nodes[1], 1);
6035 }
6036
6037 #[test]
6038 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6039         //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.
6040
6041         let chanmon_cfgs = create_chanmon_cfgs(2);
6042         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6043         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6044         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6045         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6046
6047         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6048         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6049         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6050         check_added_monitors!(nodes[0], 1);
6051         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6052         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6053
6054         let update_msg = msgs::UpdateFulfillHTLC{
6055                 channel_id: chan.2,
6056                 htlc_id: 0,
6057                 payment_preimage: our_payment_preimage,
6058         };
6059
6060         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6061
6062         assert!(nodes[0].node.list_channels().is_empty());
6063         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6064         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6065         check_added_monitors!(nodes[0], 1);
6066 }
6067
6068 #[test]
6069 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6070         //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.
6071
6072         let chanmon_cfgs = create_chanmon_cfgs(2);
6073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6075         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6076         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6077
6078         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6079         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6080         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6081         check_added_monitors!(nodes[0], 1);
6082         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6083         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6084
6085         let update_msg = msgs::UpdateFailHTLC{
6086                 channel_id: chan.2,
6087                 htlc_id: 0,
6088                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6089         };
6090
6091         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6092
6093         assert!(nodes[0].node.list_channels().is_empty());
6094         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6095         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6096         check_added_monitors!(nodes[0], 1);
6097 }
6098
6099 #[test]
6100 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6101         //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.
6102
6103         let chanmon_cfgs = create_chanmon_cfgs(2);
6104         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6105         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6106         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6107         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6108
6109         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6110         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6111         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6112         check_added_monitors!(nodes[0], 1);
6113         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6114         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6115
6116         let update_msg = msgs::UpdateFailMalformedHTLC{
6117                 channel_id: chan.2,
6118                 htlc_id: 0,
6119                 sha256_of_onion: [1; 32],
6120                 failure_code: 0x8000,
6121         };
6122
6123         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6124
6125         assert!(nodes[0].node.list_channels().is_empty());
6126         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6127         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6128         check_added_monitors!(nodes[0], 1);
6129 }
6130
6131 #[test]
6132 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6133         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6134
6135         let chanmon_cfgs = create_chanmon_cfgs(2);
6136         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6137         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6138         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6139         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6140
6141         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6142
6143         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
6144         check_added_monitors!(nodes[1], 1);
6145
6146         let events = nodes[1].node.get_and_clear_pending_msg_events();
6147         assert_eq!(events.len(), 1);
6148         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6149                 match events[0] {
6150                         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, .. } } => {
6151                                 assert!(update_add_htlcs.is_empty());
6152                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6153                                 assert!(update_fail_htlcs.is_empty());
6154                                 assert!(update_fail_malformed_htlcs.is_empty());
6155                                 assert!(update_fee.is_none());
6156                                 update_fulfill_htlcs[0].clone()
6157                         },
6158                         _ => panic!("Unexpected event"),
6159                 }
6160         };
6161
6162         update_fulfill_msg.htlc_id = 1;
6163
6164         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6165
6166         assert!(nodes[0].node.list_channels().is_empty());
6167         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6168         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6169         check_added_monitors!(nodes[0], 1);
6170 }
6171
6172 #[test]
6173 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6174         //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.
6175
6176         let chanmon_cfgs = create_chanmon_cfgs(2);
6177         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6178         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6179         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6180         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6181
6182         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6183
6184         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
6185         check_added_monitors!(nodes[1], 1);
6186
6187         let events = nodes[1].node.get_and_clear_pending_msg_events();
6188         assert_eq!(events.len(), 1);
6189         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6190                 match events[0] {
6191                         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, .. } } => {
6192                                 assert!(update_add_htlcs.is_empty());
6193                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6194                                 assert!(update_fail_htlcs.is_empty());
6195                                 assert!(update_fail_malformed_htlcs.is_empty());
6196                                 assert!(update_fee.is_none());
6197                                 update_fulfill_htlcs[0].clone()
6198                         },
6199                         _ => panic!("Unexpected event"),
6200                 }
6201         };
6202
6203         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6204
6205         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6206
6207         assert!(nodes[0].node.list_channels().is_empty());
6208         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6209         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6210         check_added_monitors!(nodes[0], 1);
6211 }
6212
6213 #[test]
6214 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6215         //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.
6216
6217         let chanmon_cfgs = create_chanmon_cfgs(2);
6218         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6219         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6220         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6221         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6222         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6223         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6224         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6225         check_added_monitors!(nodes[0], 1);
6226
6227         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6228         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6229
6230         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6231         check_added_monitors!(nodes[1], 0);
6232         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6233
6234         let events = nodes[1].node.get_and_clear_pending_msg_events();
6235
6236         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6237                 match events[0] {
6238                         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, .. } } => {
6239                                 assert!(update_add_htlcs.is_empty());
6240                                 assert!(update_fulfill_htlcs.is_empty());
6241                                 assert!(update_fail_htlcs.is_empty());
6242                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6243                                 assert!(update_fee.is_none());
6244                                 update_fail_malformed_htlcs[0].clone()
6245                         },
6246                         _ => panic!("Unexpected event"),
6247                 }
6248         };
6249         update_msg.failure_code &= !0x8000;
6250         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6251
6252         assert!(nodes[0].node.list_channels().is_empty());
6253         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6254         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6255         check_added_monitors!(nodes[0], 1);
6256 }
6257
6258 #[test]
6259 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6260         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6261         //    * 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.
6262
6263         let chanmon_cfgs = create_chanmon_cfgs(3);
6264         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6265         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6266         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6267         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6268         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6269
6270         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6271         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6272
6273         //First hop
6274         let mut payment_event = {
6275                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6276                 check_added_monitors!(nodes[0], 1);
6277                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6278                 assert_eq!(events.len(), 1);
6279                 SendEvent::from_event(events.remove(0))
6280         };
6281         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6282         check_added_monitors!(nodes[1], 0);
6283         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6284         expect_pending_htlcs_forwardable!(nodes[1]);
6285         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6286         assert_eq!(events_2.len(), 1);
6287         check_added_monitors!(nodes[1], 1);
6288         payment_event = SendEvent::from_event(events_2.remove(0));
6289         assert_eq!(payment_event.msgs.len(), 1);
6290
6291         //Second Hop
6292         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6293         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6294         check_added_monitors!(nodes[2], 0);
6295         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6296
6297         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6298         assert_eq!(events_3.len(), 1);
6299         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6300                 match events_3[0] {
6301                         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 } } => {
6302                                 assert!(update_add_htlcs.is_empty());
6303                                 assert!(update_fulfill_htlcs.is_empty());
6304                                 assert!(update_fail_htlcs.is_empty());
6305                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6306                                 assert!(update_fee.is_none());
6307                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6308                         },
6309                         _ => panic!("Unexpected event"),
6310                 }
6311         };
6312
6313         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6314
6315         check_added_monitors!(nodes[1], 0);
6316         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6317         expect_pending_htlcs_forwardable!(nodes[1]);
6318         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6319         assert_eq!(events_4.len(), 1);
6320
6321         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6322         match events_4[0] {
6323                 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, .. } } => {
6324                         assert!(update_add_htlcs.is_empty());
6325                         assert!(update_fulfill_htlcs.is_empty());
6326                         assert_eq!(update_fail_htlcs.len(), 1);
6327                         assert!(update_fail_malformed_htlcs.is_empty());
6328                         assert!(update_fee.is_none());
6329                 },
6330                 _ => panic!("Unexpected event"),
6331         };
6332
6333         check_added_monitors!(nodes[1], 1);
6334 }
6335
6336 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6337         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6338         // 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
6339         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6340
6341         let chanmon_cfgs = create_chanmon_cfgs(2);
6342         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6343         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6344         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6345         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6346
6347         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6348
6349         // We route 2 dust-HTLCs between A and B
6350         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6351         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6352         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6353
6354         // Cache one local commitment tx as previous
6355         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6356
6357         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6358         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6359         check_added_monitors!(nodes[1], 0);
6360         expect_pending_htlcs_forwardable!(nodes[1]);
6361         check_added_monitors!(nodes[1], 1);
6362
6363         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6364         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6365         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6366         check_added_monitors!(nodes[0], 1);
6367
6368         // Cache one local commitment tx as lastest
6369         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6370
6371         let events = nodes[0].node.get_and_clear_pending_msg_events();
6372         match events[0] {
6373                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6374                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6375                 },
6376                 _ => panic!("Unexpected event"),
6377         }
6378         match events[1] {
6379                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6380                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6381                 },
6382                 _ => panic!("Unexpected event"),
6383         }
6384
6385         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6386         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6387         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6388
6389         if announce_latest {
6390                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6391         } else {
6392                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6393         }
6394
6395         check_closed_broadcast!(nodes[0], false);
6396         check_added_monitors!(nodes[0], 1);
6397
6398         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6399         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6400         let events = nodes[0].node.get_and_clear_pending_events();
6401         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6402         assert_eq!(events.len(), 2);
6403         let mut first_failed = false;
6404         for event in events {
6405                 match event {
6406                         Event::PaymentFailed { payment_hash, .. } => {
6407                                 if payment_hash == payment_hash_1 {
6408                                         assert!(!first_failed);
6409                                         first_failed = true;
6410                                 } else {
6411                                         assert_eq!(payment_hash, payment_hash_2);
6412                                 }
6413                         }
6414                         _ => panic!("Unexpected event"),
6415                 }
6416         }
6417 }
6418
6419 #[test]
6420 fn test_failure_delay_dust_htlc_local_commitment() {
6421         do_test_failure_delay_dust_htlc_local_commitment(true);
6422         do_test_failure_delay_dust_htlc_local_commitment(false);
6423 }
6424
6425 #[test]
6426 fn test_no_failure_dust_htlc_local_commitment() {
6427         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6428         // prone to error, we test here that a dummy transaction don't fail them.
6429
6430         let chanmon_cfgs = create_chanmon_cfgs(2);
6431         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6432         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6433         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6434         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6435
6436         // Rebalance a bit
6437         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6438
6439         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6440         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6441
6442         // We route 2 dust-HTLCs between A and B
6443         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6444         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6445
6446         // Build a dummy invalid transaction trying to spend a commitment tx
6447         let input = TxIn {
6448                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6449                 script_sig: Script::new(),
6450                 sequence: 0,
6451                 witness: Vec::new(),
6452         };
6453
6454         let outp = TxOut {
6455                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6456                 value: 10000,
6457         };
6458
6459         let dummy_tx = Transaction {
6460                 version: 2,
6461                 lock_time: 0,
6462                 input: vec![input],
6463                 output: vec![outp]
6464         };
6465
6466         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6467         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6468         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6469         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6470         // We broadcast a few more block to check everything is all right
6471         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6472         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6473         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6474
6475         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6476         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6477 }
6478
6479 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6480         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6481         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6482         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6483         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6484         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6485         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6486
6487         let chanmon_cfgs = create_chanmon_cfgs(3);
6488         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6489         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6490         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6491         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6492
6493         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6494
6495         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6496         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6497
6498         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6499         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6500
6501         // We revoked bs_commitment_tx
6502         if revoked {
6503                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6504                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6505         }
6506
6507         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6508         let mut timeout_tx = Vec::new();
6509         if local {
6510                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6511                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6512                 check_closed_broadcast!(nodes[0], false);
6513                 check_added_monitors!(nodes[0], 1);
6514                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6515                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6516                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6517                 let events = nodes[0].node.get_and_clear_pending_events();
6518                 assert_eq!(events.len(), 1);
6519                 match events[0] {
6520                         Event::PaymentFailed { payment_hash, .. } => {
6521                                 assert_eq!(payment_hash, dust_hash);
6522                         },
6523                         _ => panic!("Unexpected event"),
6524                 }
6525                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6526                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6527                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6528                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6529                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6530                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6531                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6532                 let events = nodes[0].node.get_and_clear_pending_events();
6533                 assert_eq!(events.len(), 1);
6534                 match events[0] {
6535                         Event::PaymentFailed { payment_hash, .. } => {
6536                                 assert_eq!(payment_hash, non_dust_hash);
6537                         },
6538                         _ => panic!("Unexpected event"),
6539                 }
6540         } else {
6541                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6542                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6543                 check_closed_broadcast!(nodes[0], false);
6544                 check_added_monitors!(nodes[0], 1);
6545                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6546                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6547                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6548                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6549                 if !revoked {
6550                         let events = nodes[0].node.get_and_clear_pending_events();
6551                         assert_eq!(events.len(), 1);
6552                         match events[0] {
6553                                 Event::PaymentFailed { payment_hash, .. } => {
6554                                         assert_eq!(payment_hash, dust_hash);
6555                                 },
6556                                 _ => panic!("Unexpected event"),
6557                         }
6558                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6559                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6560                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6561                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6562                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6563                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6564                         let events = nodes[0].node.get_and_clear_pending_events();
6565                         assert_eq!(events.len(), 1);
6566                         match events[0] {
6567                                 Event::PaymentFailed { payment_hash, .. } => {
6568                                         assert_eq!(payment_hash, non_dust_hash);
6569                                 },
6570                                 _ => panic!("Unexpected event"),
6571                         }
6572                 } else {
6573                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6574                         // commitment tx
6575                         let events = nodes[0].node.get_and_clear_pending_events();
6576                         assert_eq!(events.len(), 2);
6577                         let first;
6578                         match events[0] {
6579                                 Event::PaymentFailed { payment_hash, .. } => {
6580                                         if payment_hash == dust_hash { first = true; }
6581                                         else { first = false; }
6582                                 },
6583                                 _ => panic!("Unexpected event"),
6584                         }
6585                         match events[1] {
6586                                 Event::PaymentFailed { payment_hash, .. } => {
6587                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6588                                         else { assert_eq!(payment_hash, dust_hash); }
6589                                 },
6590                                 _ => panic!("Unexpected event"),
6591                         }
6592                 }
6593         }
6594 }
6595
6596 #[test]
6597 fn test_sweep_outbound_htlc_failure_update() {
6598         do_test_sweep_outbound_htlc_failure_update(false, true);
6599         do_test_sweep_outbound_htlc_failure_update(false, false);
6600         do_test_sweep_outbound_htlc_failure_update(true, false);
6601 }
6602
6603 #[test]
6604 fn test_upfront_shutdown_script() {
6605         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6606         // enforce it at shutdown message
6607
6608         let mut config = UserConfig::default();
6609         config.channel_options.announced_channel = true;
6610         config.peer_channel_config_limits.force_announced_channel_preference = false;
6611         config.channel_options.commit_upfront_shutdown_pubkey = false;
6612         let user_cfgs = [None, Some(config), None];
6613         let chanmon_cfgs = create_chanmon_cfgs(3);
6614         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6615         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6616         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6617
6618         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6619         let flags = InitFeatures::supported();
6620         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6621         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6622         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6623         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6624         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6625         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6626         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6627         check_added_monitors!(nodes[2], 1);
6628
6629         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6630         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6631         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6632         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6633         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6634         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6635         let events = nodes[2].node.get_and_clear_pending_msg_events();
6636         assert_eq!(events.len(), 1);
6637         match events[0] {
6638                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6639                 _ => panic!("Unexpected event"),
6640         }
6641
6642         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6643         let mut flags_no = InitFeatures::supported();
6644         flags_no.unset_upfront_shutdown_script();
6645         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6646         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6647         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6648         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6649         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6650         let events = nodes[1].node.get_and_clear_pending_msg_events();
6651         assert_eq!(events.len(), 1);
6652         match events[0] {
6653                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6654                 _ => panic!("Unexpected event"),
6655         }
6656
6657         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6658         // channel smoothly, opt-out is from channel initiator here
6659         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6660         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6661         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6662         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6663         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6664         let events = nodes[0].node.get_and_clear_pending_msg_events();
6665         assert_eq!(events.len(), 1);
6666         match events[0] {
6667                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6668                 _ => panic!("Unexpected event"),
6669         }
6670
6671         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6672         //// channel smoothly
6673         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6674         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6675         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6676         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6677         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6678         let events = nodes[0].node.get_and_clear_pending_msg_events();
6679         assert_eq!(events.len(), 2);
6680         match events[0] {
6681                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6682                 _ => panic!("Unexpected event"),
6683         }
6684         match events[1] {
6685                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6686                 _ => panic!("Unexpected event"),
6687         }
6688 }
6689
6690 #[test]
6691 fn test_user_configurable_csv_delay() {
6692         // We test our channel constructors yield errors when we pass them absurd csv delay
6693
6694         let mut low_our_to_self_config = UserConfig::default();
6695         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6696         let mut high_their_to_self_config = UserConfig::default();
6697         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6698         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6699         let chanmon_cfgs = create_chanmon_cfgs(2);
6700         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6701         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6702         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6703
6704         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6705         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())));
6706         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) {
6707                 match error {
6708                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6709                         _ => panic!("Unexpected event"),
6710                 }
6711         } else { assert!(false) }
6712
6713         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6714         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6715         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6716         open_channel.to_self_delay = 200;
6717         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) {
6718                 match error {
6719                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6720                         _ => panic!("Unexpected event"),
6721                 }
6722         } else { assert!(false); }
6723
6724         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6725         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6726         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()));
6727         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6728         accept_channel.to_self_delay = 200;
6729         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6730         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6731                 match action {
6732                         &ErrorAction::SendErrorMessage { ref msg } => {
6733                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6734                         },
6735                         _ => { assert!(false); }
6736                 }
6737         } else { assert!(false); }
6738
6739         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6740         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6741         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6742         open_channel.to_self_delay = 200;
6743         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) {
6744                 match error {
6745                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6746                         _ => panic!("Unexpected event"),
6747                 }
6748         } else { assert!(false); }
6749 }
6750
6751 #[test]
6752 fn test_data_loss_protect() {
6753         // We want to be sure that :
6754         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6755         // * we close channel in case of detecting other being fallen behind
6756         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6757         let keys_manager;
6758         let fee_estimator;
6759         let tx_broadcaster;
6760         let monitor;
6761         let node_state_0;
6762         let chanmon_cfgs = create_chanmon_cfgs(2);
6763         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6764         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6765         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6766
6767         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6768
6769         // Cache node A state before any channel update
6770         let previous_node_state = nodes[0].node.encode();
6771         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6772         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6773
6774         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6775         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6776
6777         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6778         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6779
6780         // Restore node A from previous state
6781         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6782         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6783         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6784         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6785         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6786         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6787         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6788         node_state_0 = {
6789                 let mut channel_monitors = HashMap::new();
6790                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6791                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6792                         keys_manager: &keys_manager,
6793                         fee_estimator: &fee_estimator,
6794                         monitor: &monitor,
6795                         logger: Arc::clone(&logger),
6796                         tx_broadcaster: &tx_broadcaster,
6797                         default_config: UserConfig::default(),
6798                         channel_monitors: &mut channel_monitors,
6799                 }).unwrap().1
6800         };
6801         nodes[0].node = &node_state_0;
6802         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6803         nodes[0].chan_monitor = &monitor;
6804         nodes[0].chain_monitor = chain_monitor;
6805
6806         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6807         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6808         nodes[0].block_notifier.register_listener(nodes[0].node);
6809
6810         check_added_monitors!(nodes[0], 1);
6811
6812         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6813         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6814
6815         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6816
6817         // Check we update monitor following learning of per_commitment_point from B
6818         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6819         check_added_monitors!(nodes[0], 2);
6820
6821         {
6822                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6823                 assert_eq!(node_txn.len(), 0);
6824         }
6825
6826         let mut reestablish_1 = Vec::with_capacity(1);
6827         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6828                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6829                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6830                         reestablish_1.push(msg.clone());
6831                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6832                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6833                         match action {
6834                                 &ErrorAction::SendErrorMessage { ref msg } => {
6835                                         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");
6836                                 },
6837                                 _ => panic!("Unexpected event!"),
6838                         }
6839                 } else {
6840                         panic!("Unexpected event")
6841                 }
6842         }
6843
6844         // Check we close channel detecting A is fallen-behind
6845         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6846         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6847         check_added_monitors!(nodes[1], 1);
6848
6849
6850         // Check A is able to claim to_remote output
6851         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6852         assert_eq!(node_txn.len(), 1);
6853         check_spends!(node_txn[0], chan.3);
6854         assert_eq!(node_txn[0].output.len(), 2);
6855         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6856         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6857         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6858         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6859         assert_eq!(spend_txn.len(), 1);
6860         check_spends!(spend_txn[0], node_txn[0]);
6861 }
6862
6863 #[test]
6864 fn test_check_htlc_underpaying() {
6865         // Send payment through A -> B but A is maliciously
6866         // sending a probe payment (i.e less than expected value0
6867         // to B, B should refuse payment.
6868
6869         let chanmon_cfgs = create_chanmon_cfgs(2);
6870         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6871         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6872         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6873
6874         // Create some initial channels
6875         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6876
6877         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6878
6879         // Node 3 is expecting payment of 100_000 but receive 10_000,
6880         // fail htlc like we didn't know the preimage.
6881         nodes[1].node.claim_funds(payment_preimage, 100_000);
6882         nodes[1].node.process_pending_htlc_forwards();
6883
6884         let events = nodes[1].node.get_and_clear_pending_msg_events();
6885         assert_eq!(events.len(), 1);
6886         let (update_fail_htlc, commitment_signed) = match events[0] {
6887                 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 } } => {
6888                         assert!(update_add_htlcs.is_empty());
6889                         assert!(update_fulfill_htlcs.is_empty());
6890                         assert_eq!(update_fail_htlcs.len(), 1);
6891                         assert!(update_fail_malformed_htlcs.is_empty());
6892                         assert!(update_fee.is_none());
6893                         (update_fail_htlcs[0].clone(), commitment_signed)
6894                 },
6895                 _ => panic!("Unexpected event"),
6896         };
6897         check_added_monitors!(nodes[1], 1);
6898
6899         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6900         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6901
6902         let events = nodes[0].node.get_and_clear_pending_events();
6903         assert_eq!(events.len(), 1);
6904         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6905                 assert_eq!(*rejected_by_dest, true);
6906                 assert_eq!(error_code.unwrap(), 0x4000|15);
6907         } else {
6908                 panic!("Unexpected event");
6909         }
6910         nodes[1].node.get_and_clear_pending_events();
6911 }
6912
6913 #[test]
6914 fn test_announce_disable_channels() {
6915         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6916         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6917
6918         let chanmon_cfgs = create_chanmon_cfgs(2);
6919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6921         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6922
6923         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6924         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6925         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6926
6927         // Disconnect peers
6928         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6929         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6930
6931         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6932         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6933         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6934         assert_eq!(msg_events.len(), 3);
6935         for e in msg_events {
6936                 match e {
6937                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6938                                 let short_id = msg.contents.short_channel_id;
6939                                 // Check generated channel_update match list in PendingChannelUpdate
6940                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6941                                         panic!("Generated ChannelUpdate for wrong chan!");
6942                                 }
6943                         },
6944                         _ => panic!("Unexpected event"),
6945                 }
6946         }
6947         // Reconnect peers
6948         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6949         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6950         assert_eq!(reestablish_1.len(), 3);
6951         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6952         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6953         assert_eq!(reestablish_2.len(), 3);
6954
6955         // Reestablish chan_1
6956         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6957         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6958         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6959         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6960         // Reestablish chan_2
6961         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6962         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6963         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6964         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6965         // Reestablish chan_3
6966         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6967         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6968         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6969         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6970
6971         nodes[0].node.timer_chan_freshness_every_min();
6972         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6973 }
6974
6975 #[test]
6976 fn test_bump_penalty_txn_on_revoked_commitment() {
6977         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6978         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6979
6980         let chanmon_cfgs = create_chanmon_cfgs(2);
6981         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6982         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6983         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6984
6985         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6986         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6987         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6988         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
6989
6990         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
6991         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
6992         assert_eq!(revoked_txn[0].output.len(), 4);
6993         assert_eq!(revoked_txn[0].input.len(), 1);
6994         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
6995         let revoked_txid = revoked_txn[0].txid();
6996
6997         let mut penalty_sum = 0;
6998         for outp in revoked_txn[0].output.iter() {
6999                 if outp.script_pubkey.is_v0_p2wsh() {
7000                         penalty_sum += outp.value;
7001                 }
7002         }
7003
7004         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7005         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7006
7007         // Actually revoke tx by claiming a HTLC
7008         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7009         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7010         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7011         check_added_monitors!(nodes[1], 1);
7012
7013         // One or more justice tx should have been broadcast, check it
7014         let penalty_1;
7015         let feerate_1;
7016         {
7017                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7018                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7019                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7020                 assert_eq!(node_txn[0].output.len(), 1);
7021                 check_spends!(node_txn[0], revoked_txn[0]);
7022                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7023                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7024                 penalty_1 = node_txn[0].txid();
7025                 node_txn.clear();
7026         };
7027
7028         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7029         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7030         let mut penalty_2 = penalty_1;
7031         let mut feerate_2 = 0;
7032         {
7033                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7034                 assert_eq!(node_txn.len(), 1);
7035                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7036                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7037                         assert_eq!(node_txn[0].output.len(), 1);
7038                         check_spends!(node_txn[0], revoked_txn[0]);
7039                         penalty_2 = node_txn[0].txid();
7040                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7041                         assert_ne!(penalty_2, penalty_1);
7042                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7043                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7044                         // Verify 25% bump heuristic
7045                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7046                         node_txn.clear();
7047                 }
7048         }
7049         assert_ne!(feerate_2, 0);
7050
7051         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7052         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7053         let penalty_3;
7054         let mut feerate_3 = 0;
7055         {
7056                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7057                 assert_eq!(node_txn.len(), 1);
7058                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7059                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7060                         assert_eq!(node_txn[0].output.len(), 1);
7061                         check_spends!(node_txn[0], revoked_txn[0]);
7062                         penalty_3 = node_txn[0].txid();
7063                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7064                         assert_ne!(penalty_3, penalty_2);
7065                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7066                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7067                         // Verify 25% bump heuristic
7068                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7069                         node_txn.clear();
7070                 }
7071         }
7072         assert_ne!(feerate_3, 0);
7073
7074         nodes[1].node.get_and_clear_pending_events();
7075         nodes[1].node.get_and_clear_pending_msg_events();
7076 }
7077
7078 #[test]
7079 fn test_bump_penalty_txn_on_revoked_htlcs() {
7080         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7081         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7082
7083         let chanmon_cfgs = create_chanmon_cfgs(2);
7084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7086         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7087
7088         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7089         // Lock HTLC in both directions
7090         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7091         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7092
7093         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7094         assert_eq!(revoked_local_txn[0].input.len(), 1);
7095         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7096
7097         // Revoke local commitment tx
7098         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7099
7100         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7101         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7102         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7103         check_closed_broadcast!(nodes[1], false);
7104         check_added_monitors!(nodes[1], 1);
7105
7106         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7107         assert_eq!(revoked_htlc_txn.len(), 6);
7108         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7109                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7110                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7111                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7112                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7113                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7114         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7115                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7116                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7117                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7118                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7119                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7120         }
7121
7122         // Broadcast set of revoked txn on A
7123         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7124         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7125         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);
7126         let first;
7127         let feerate_1;
7128         let penalty_txn;
7129         {
7130                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7131                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7132                 // Verify claim tx are spending revoked HTLC txn
7133                 assert_eq!(node_txn[4].input.len(), 2);
7134                 assert_eq!(node_txn[4].output.len(), 1);
7135                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7136                 first = node_txn[4].txid();
7137                 // Store both feerates for later comparison
7138                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7139                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7140                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7141                 node_txn.clear();
7142         }
7143
7144         // Connect three more block to see if bumped penalty are issued for HTLC txn
7145         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7146         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7147         {
7148                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7149                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7150
7151                 check_spends!(node_txn[0], revoked_local_txn[0]);
7152                 check_spends!(node_txn[1], revoked_local_txn[0]);
7153
7154                 node_txn.clear();
7155         };
7156
7157         // Few more blocks to confirm penalty txn
7158         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7159         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7160         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7161         let node_txn = {
7162                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7163                 assert_eq!(node_txn.len(), 1);
7164
7165                 assert_eq!(node_txn[0].input.len(), 2);
7166                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7167                 // Verify bumped tx is different and 25% bump heuristic
7168                 assert_ne!(first, node_txn[0].txid());
7169                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7170                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7171                 assert!(feerate_2 * 100 > feerate_1 * 125);
7172                 let txn = vec![node_txn[0].clone()];
7173                 node_txn.clear();
7174                 txn
7175         };
7176         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7177         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7178         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7179         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7180         {
7181                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7182                 // We verify than no new transaction has been broadcast because previously
7183                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7184                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7185                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7186                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7187                 // up bumped justice generation.
7188                 assert_eq!(node_txn.len(), 0);
7189                 node_txn.clear();
7190         }
7191         check_closed_broadcast!(nodes[0], false);
7192         check_added_monitors!(nodes[0], 1);
7193 }
7194
7195 #[test]
7196 fn test_bump_penalty_txn_on_remote_commitment() {
7197         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7198         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7199
7200         // Create 2 HTLCs
7201         // Provide preimage for one
7202         // Check aggregation
7203
7204         let chanmon_cfgs = create_chanmon_cfgs(2);
7205         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7206         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7207         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7208
7209         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7210         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7211         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7212
7213         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7214         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7215         assert_eq!(remote_txn[0].output.len(), 4);
7216         assert_eq!(remote_txn[0].input.len(), 1);
7217         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7218
7219         // Claim a HTLC without revocation (provide B monitor with preimage)
7220         nodes[1].node.claim_funds(payment_preimage, 3_000_000);
7221         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7222         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7223         check_added_monitors!(nodes[1], 2);
7224
7225         // One or more claim tx should have been broadcast, check it
7226         let timeout;
7227         let preimage;
7228         let feerate_timeout;
7229         let feerate_preimage;
7230         {
7231                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7232                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7233                 assert_eq!(node_txn[0].input.len(), 1);
7234                 assert_eq!(node_txn[1].input.len(), 1);
7235                 check_spends!(node_txn[0], remote_txn[0]);
7236                 check_spends!(node_txn[1], remote_txn[0]);
7237                 check_spends!(node_txn[2], chan.3);
7238                 check_spends!(node_txn[3], node_txn[2]);
7239                 check_spends!(node_txn[4], node_txn[2]);
7240                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7241                         timeout = node_txn[0].txid();
7242                         let index = node_txn[0].input[0].previous_output.vout;
7243                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7244                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7245
7246                         preimage = node_txn[1].txid();
7247                         let index = node_txn[1].input[0].previous_output.vout;
7248                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7249                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7250                 } else {
7251                         timeout = node_txn[1].txid();
7252                         let index = node_txn[1].input[0].previous_output.vout;
7253                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7254                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7255
7256                         preimage = node_txn[0].txid();
7257                         let index = node_txn[0].input[0].previous_output.vout;
7258                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7259                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7260                 }
7261                 node_txn.clear();
7262         };
7263         assert_ne!(feerate_timeout, 0);
7264         assert_ne!(feerate_preimage, 0);
7265
7266         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7267         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7268         {
7269                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7270                 assert_eq!(node_txn.len(), 2);
7271                 assert_eq!(node_txn[0].input.len(), 1);
7272                 assert_eq!(node_txn[1].input.len(), 1);
7273                 check_spends!(node_txn[0], remote_txn[0]);
7274                 check_spends!(node_txn[1], remote_txn[0]);
7275                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7276                         let index = node_txn[0].input[0].previous_output.vout;
7277                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7278                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7279                         assert!(new_feerate * 100 > feerate_timeout * 125);
7280                         assert_ne!(timeout, node_txn[0].txid());
7281
7282                         let index = node_txn[1].input[0].previous_output.vout;
7283                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7284                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7285                         assert!(new_feerate * 100 > feerate_preimage * 125);
7286                         assert_ne!(preimage, node_txn[1].txid());
7287                 } else {
7288                         let index = node_txn[1].input[0].previous_output.vout;
7289                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7290                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7291                         assert!(new_feerate * 100 > feerate_timeout * 125);
7292                         assert_ne!(timeout, node_txn[1].txid());
7293
7294                         let index = node_txn[0].input[0].previous_output.vout;
7295                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7296                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7297                         assert!(new_feerate * 100 > feerate_preimage * 125);
7298                         assert_ne!(preimage, node_txn[0].txid());
7299                 }
7300                 node_txn.clear();
7301         }
7302
7303         nodes[1].node.get_and_clear_pending_events();
7304         nodes[1].node.get_and_clear_pending_msg_events();
7305 }
7306
7307 #[test]
7308 fn test_set_outpoints_partial_claiming() {
7309         // - remote party claim tx, new bump tx
7310         // - disconnect remote claiming tx, new bump
7311         // - disconnect tx, see no tx anymore
7312         let chanmon_cfgs = create_chanmon_cfgs(2);
7313         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7314         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7315         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7316
7317         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7318         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7319         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7320
7321         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7322         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7323         assert_eq!(remote_txn.len(), 3);
7324         assert_eq!(remote_txn[0].output.len(), 4);
7325         assert_eq!(remote_txn[0].input.len(), 1);
7326         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7327         check_spends!(remote_txn[1], remote_txn[0]);
7328         check_spends!(remote_txn[2], remote_txn[0]);
7329
7330         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7331         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7332         // Provide node A with both preimage
7333         nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
7334         nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
7335         check_added_monitors!(nodes[0], 2);
7336         nodes[0].node.get_and_clear_pending_events();
7337         nodes[0].node.get_and_clear_pending_msg_events();
7338
7339         // Connect blocks on node A commitment transaction
7340         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7341         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7342         check_closed_broadcast!(nodes[0], false);
7343         check_added_monitors!(nodes[0], 1);
7344         // Verify node A broadcast tx claiming both HTLCs
7345         {
7346                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7347                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7348                 assert_eq!(node_txn.len(), 4);
7349                 check_spends!(node_txn[0], remote_txn[0]);
7350                 check_spends!(node_txn[1], chan.3);
7351                 check_spends!(node_txn[2], node_txn[1]);
7352                 check_spends!(node_txn[3], node_txn[1]);
7353                 assert_eq!(node_txn[0].input.len(), 2);
7354                 node_txn.clear();
7355         }
7356
7357         // Connect blocks on node B
7358         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7359         check_closed_broadcast!(nodes[1], false);
7360         check_added_monitors!(nodes[1], 1);
7361         // Verify node B broadcast 2 HTLC-timeout txn
7362         let partial_claim_tx = {
7363                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7364                 assert_eq!(node_txn.len(), 3);
7365                 check_spends!(node_txn[1], node_txn[0]);
7366                 check_spends!(node_txn[2], node_txn[0]);
7367                 assert_eq!(node_txn[1].input.len(), 1);
7368                 assert_eq!(node_txn[2].input.len(), 1);
7369                 node_txn[1].clone()
7370         };
7371
7372         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7373         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7374         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7375         {
7376                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7377                 assert_eq!(node_txn.len(), 1);
7378                 check_spends!(node_txn[0], remote_txn[0]);
7379                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7380                 node_txn.clear();
7381         }
7382         nodes[0].node.get_and_clear_pending_msg_events();
7383
7384         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7385         nodes[0].block_notifier.block_disconnected(&header, 102);
7386         {
7387                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7388                 assert_eq!(node_txn.len(), 1);
7389                 check_spends!(node_txn[0], remote_txn[0]);
7390                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7391                 node_txn.clear();
7392         }
7393
7394         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7395         nodes[0].block_notifier.block_disconnected(&header, 101);
7396         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7397         {
7398                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7399                 assert_eq!(node_txn.len(), 0);
7400                 node_txn.clear();
7401         }
7402 }
7403
7404 #[test]
7405 fn test_counterparty_raa_skip_no_crash() {
7406         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7407         // commitment transaction, we would have happily carried on and provided them the next
7408         // commitment transaction based on one RAA forward. This would probably eventually have led to
7409         // channel closure, but it would not have resulted in funds loss. Still, our
7410         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7411         // check simply that the channel is closed in response to such an RAA, but don't check whether
7412         // we decide to punish our counterparty for revoking their funds (as we don't currently
7413         // implement that).
7414         let chanmon_cfgs = create_chanmon_cfgs(2);
7415         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7416         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7417         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7418         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7419
7420         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7421         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7422         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7423                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7424         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7425
7426         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7427                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7428         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7429         check_added_monitors!(nodes[1], 1);
7430 }
7431
7432 #[test]
7433 fn test_bump_txn_sanitize_tracking_maps() {
7434         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7435         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7436
7437         let chanmon_cfgs = create_chanmon_cfgs(2);
7438         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7439         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7440         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7441
7442         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7443         // Lock HTLC in both directions
7444         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7445         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7446
7447         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7448         assert_eq!(revoked_local_txn[0].input.len(), 1);
7449         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7450
7451         // Revoke local commitment tx
7452         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7453
7454         // Broadcast set of revoked txn on A
7455         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7456         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7457         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7458         check_closed_broadcast!(nodes[0], false);
7459         check_added_monitors!(nodes[0], 1);
7460         let penalty_txn = {
7461                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7462                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7463                 check_spends!(node_txn[0], revoked_local_txn[0]);
7464                 check_spends!(node_txn[1], revoked_local_txn[0]);
7465                 check_spends!(node_txn[2], revoked_local_txn[0]);
7466                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7467                 node_txn.clear();
7468                 penalty_txn
7469         };
7470         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7471         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7472         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7473         {
7474                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7475                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7476                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7477                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7478                 }
7479         }
7480 }
7481
7482 #[test]
7483 fn test_override_channel_config() {
7484         let chanmon_cfgs = create_chanmon_cfgs(2);
7485         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7486         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7487         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7488
7489         // Node0 initiates a channel to node1 using the override config.
7490         let mut override_config = UserConfig::default();
7491         override_config.own_channel_config.our_to_self_delay = 200;
7492
7493         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7494
7495         // Assert the channel created by node0 is using the override config.
7496         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7497         assert_eq!(res.channel_flags, 0);
7498         assert_eq!(res.to_self_delay, 200);
7499 }
7500
7501 #[test]
7502 fn test_override_0msat_htlc_minimum() {
7503         let mut zero_config = UserConfig::default();
7504         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7505         let chanmon_cfgs = create_chanmon_cfgs(2);
7506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7508         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7509
7510         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7511         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7512         assert_eq!(res.htlc_minimum_msat, 1);
7513
7514         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7515         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7516         assert_eq!(res.htlc_minimum_msat, 1);
7517 }