_ 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, PaymentSecret, 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, &None).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, &None).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, &None).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, &None) {}
 865         else { panic!("New sends should fail!") };
 866         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash, &None) {}
 867         else { panic!("New sends should fail!") };
 868
 869         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 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, &None).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, &None, 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, &None).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, &None).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, &None).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, &None, 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, &None).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, &None).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, &None).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, &None).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, &None, 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, &None).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, &None).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, &None).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, ref payment_secret, amt } => {
1758                         assert_eq!(our_payment_hash_21, *payment_hash);
1759                         assert_eq!(*payment_secret, None);
1760                         assert_eq!(recv_value_21, amt);
1761                 },
1762                 _ => panic!("Unexpected event"),
1763         }
1764         match events[1] {
1765                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1766                         assert_eq!(our_payment_hash_22, *payment_hash);
1767                         assert_eq!(None, *payment_secret);
1768                         assert_eq!(recv_value_22, amt);
1769                 },
1770                 _ => panic!("Unexpected event"),
1771         }
1772
1773         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1774         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1775         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1776
1777         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);
1778         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1779         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1780         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1781
1782         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1783         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1784 }
1785
1786 #[test]
1787 fn channel_reserve_test() {
1788         do_channel_reserve_test(false);
1789         do_channel_reserve_test(true);
1790 }
1791
1792 #[test]
1793 fn channel_reserve_in_flight_removes() {
1794         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1795         // can send to its counterparty, but due to update ordering, the other side may not yet have
1796         // considered those HTLCs fully removed.
1797         // This tests that we don't count HTLCs which will not be included in the next remote
1798         // commitment transaction towards the reserve value (as it implies no commitment transaction
1799         // will be generated which violates the remote reserve value).
1800         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1801         // To test this we:
1802         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1803         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1804         //    you only consider the value of the first HTLC, it may not),
1805         //  * start routing a third HTLC from A to B,
1806         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1807         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1808         //  * deliver the first fulfill from B
1809         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1810         //    claim,
1811         //  * deliver A's response CS and RAA.
1812         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1813         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1814         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1815         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1816         let chanmon_cfgs = create_chanmon_cfgs(2);
1817         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1818         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1819         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1820         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1821
1822         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1823         // Route the first two HTLCs.
1824         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1825         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1826
1827         // Start routing the third HTLC (this is just used to get everyone in the right state).
1828         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1829         let send_1 = {
1830                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1831                 nodes[0].node.send_payment(route, payment_hash_3, &None).unwrap();
1832                 check_added_monitors!(nodes[0], 1);
1833                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1834                 assert_eq!(events.len(), 1);
1835                 SendEvent::from_event(events.remove(0))
1836         };
1837
1838         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1839         // initial fulfill/CS.
1840         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1841         check_added_monitors!(nodes[1], 1);
1842         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1843
1844         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1845         // remove the second HTLC when we send the HTLC back from B to A.
1846         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1847         check_added_monitors!(nodes[1], 1);
1848         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1849
1850         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1851         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1852         check_added_monitors!(nodes[0], 1);
1853         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1854         expect_payment_sent!(nodes[0], payment_preimage_1);
1855
1856         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1857         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1858         check_added_monitors!(nodes[1], 1);
1859         // B is already AwaitingRAA, so cant generate a CS here
1860         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1861
1862         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1863         check_added_monitors!(nodes[1], 1);
1864         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1865
1866         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1867         check_added_monitors!(nodes[0], 1);
1868         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1869
1870         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1871         check_added_monitors!(nodes[1], 1);
1872         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1873
1874         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1875         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1876         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1877         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1878         // on-chain as necessary).
1879         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1880         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1881         check_added_monitors!(nodes[0], 1);
1882         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1883         expect_payment_sent!(nodes[0], payment_preimage_2);
1884
1885         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1886         check_added_monitors!(nodes[1], 1);
1887         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1888
1889         expect_pending_htlcs_forwardable!(nodes[1]);
1890         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1891
1892         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1893         // resolve the second HTLC from A's point of view.
1894         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1895         check_added_monitors!(nodes[0], 1);
1896         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1897
1898         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1899         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1900         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1901         let send_2 = {
1902                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1903                 nodes[1].node.send_payment(route, payment_hash_4, &None).unwrap();
1904                 check_added_monitors!(nodes[1], 1);
1905                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1906                 assert_eq!(events.len(), 1);
1907                 SendEvent::from_event(events.remove(0))
1908         };
1909
1910         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1911         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1912         check_added_monitors!(nodes[0], 1);
1913         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1914
1915         // Now just resolve all the outstanding messages/HTLCs for completeness...
1916
1917         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1918         check_added_monitors!(nodes[1], 1);
1919         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1920
1921         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1922         check_added_monitors!(nodes[1], 1);
1923
1924         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1925         check_added_monitors!(nodes[0], 1);
1926         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1927
1928         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1929         check_added_monitors!(nodes[1], 1);
1930         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1931
1932         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1933         check_added_monitors!(nodes[0], 1);
1934
1935         expect_pending_htlcs_forwardable!(nodes[0]);
1936         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1937
1938         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1939         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1940 }
1941
1942 #[test]
1943 fn channel_monitor_network_test() {
1944         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1945         // tests that ChannelMonitor is able to recover from various states.
1946         let chanmon_cfgs = create_chanmon_cfgs(5);
1947         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1948         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1949         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1950
1951         // Create some initial channels
1952         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1953         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1954         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1955         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1956
1957         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1961         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1962
1963         // Simple case with no pending HTLCs:
1964         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1965         check_added_monitors!(nodes[1], 1);
1966         {
1967                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1968                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1969                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1970                 check_added_monitors!(nodes[0], 1);
1971                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1972         }
1973         get_announce_close_broadcast_events(&nodes, 0, 1);
1974         assert_eq!(nodes[0].node.list_channels().len(), 0);
1975         assert_eq!(nodes[1].node.list_channels().len(), 1);
1976
1977         // One pending HTLC is discarded by the force-close:
1978         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1979
1980         // Simple case of one pending HTLC to HTLC-Timeout
1981         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1982         check_added_monitors!(nodes[1], 1);
1983         {
1984                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1985                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1986                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1987                 check_added_monitors!(nodes[2], 1);
1988                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1989         }
1990         get_announce_close_broadcast_events(&nodes, 1, 2);
1991         assert_eq!(nodes[1].node.list_channels().len(), 0);
1992         assert_eq!(nodes[2].node.list_channels().len(), 1);
1993
1994         macro_rules! claim_funds {
1995                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1996                         {
1997                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1998                                 check_added_monitors!($node, 1);
1999
2000                                 let events = $node.node.get_and_clear_pending_msg_events();
2001                                 assert_eq!(events.len(), 1);
2002                                 match events[0] {
2003                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2004                                                 assert!(update_add_htlcs.is_empty());
2005                                                 assert!(update_fail_htlcs.is_empty());
2006                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2007                                         },
2008                                         _ => panic!("Unexpected event"),
2009                                 };
2010                         }
2011                 }
2012         }
2013
2014         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2015         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2016         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2017         check_added_monitors!(nodes[2], 1);
2018         let node2_commitment_txid;
2019         {
2020                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2021                 node2_commitment_txid = node_txn[0].txid();
2022
2023                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2024                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2025
2026                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2027                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2028                 check_added_monitors!(nodes[3], 1);
2029
2030                 check_preimage_claim(&nodes[3], &node_txn);
2031         }
2032         get_announce_close_broadcast_events(&nodes, 2, 3);
2033         assert_eq!(nodes[2].node.list_channels().len(), 0);
2034         assert_eq!(nodes[3].node.list_channels().len(), 1);
2035
2036         { // Cheat and reset nodes[4]'s height to 1
2037                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2038                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2039         }
2040
2041         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2042         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2043         // One pending HTLC to time out:
2044         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2045         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2046         // buffer space).
2047
2048         {
2049                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2050                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2051                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2052                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2053                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2054                 }
2055                 check_added_monitors!(nodes[3], 1);
2056
2057                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2058                 {
2059                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2060                         node_txn.retain(|tx| {
2061                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2062                                         false
2063                                 } else { true }
2064                         });
2065                 }
2066
2067                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2068
2069                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2070                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2071
2072                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2073
2074                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2075                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2076                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2077                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2078                 }
2079
2080                 check_added_monitors!(nodes[4], 1);
2081                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2082
2083                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2084                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2085
2086                 check_preimage_claim(&nodes[4], &node_txn);
2087         }
2088         get_announce_close_broadcast_events(&nodes, 3, 4);
2089         assert_eq!(nodes[3].node.list_channels().len(), 0);
2090         assert_eq!(nodes[4].node.list_channels().len(), 0);
2091 }
2092
2093 #[test]
2094 fn test_justice_tx() {
2095         // Test justice txn built on revoked HTLC-Success tx, against both sides
2096         let mut alice_config = UserConfig::default();
2097         alice_config.channel_options.announced_channel = true;
2098         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2099         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2100         let mut bob_config = UserConfig::default();
2101         bob_config.channel_options.announced_channel = true;
2102         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2103         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2104         let user_cfgs = [Some(alice_config), Some(bob_config)];
2105         let chanmon_cfgs = create_chanmon_cfgs(2);
2106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2108         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2109         // Create some new channels:
2110         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2111
2112         // A pending HTLC which will be revoked:
2113         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2114         // Get the will-be-revoked local txn from nodes[0]
2115         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2116         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2117         assert_eq!(revoked_local_txn[0].input.len(), 1);
2118         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2119         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2120         assert_eq!(revoked_local_txn[1].input.len(), 1);
2121         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2122         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2123         // Revoke the old state
2124         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2125
2126         {
2127                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2128                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2129                 {
2130                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2131                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2132                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2133
2134                         check_spends!(node_txn[0], revoked_local_txn[0]);
2135                         node_txn.swap_remove(0);
2136                         node_txn.truncate(1);
2137                 }
2138                 check_added_monitors!(nodes[1], 1);
2139                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2140
2141                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2142                 // Verify broadcast of revoked HTLC-timeout
2143                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2144                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2145                 check_added_monitors!(nodes[0], 1);
2146                 // Broadcast revoked HTLC-timeout on node 1
2147                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2148                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2149         }
2150         get_announce_close_broadcast_events(&nodes, 0, 1);
2151
2152         assert_eq!(nodes[0].node.list_channels().len(), 0);
2153         assert_eq!(nodes[1].node.list_channels().len(), 0);
2154
2155         // We test justice_tx build by A on B's revoked HTLC-Success tx
2156         // Create some new channels:
2157         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2158         {
2159                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2160                 node_txn.clear();
2161         }
2162
2163         // A pending HTLC which will be revoked:
2164         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2165         // Get the will-be-revoked local txn from B
2166         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2167         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2168         assert_eq!(revoked_local_txn[0].input.len(), 1);
2169         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2170         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2171         // Revoke the old state
2172         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2173         {
2174                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2175                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2176                 {
2177                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2178                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2179                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2180
2181                         check_spends!(node_txn[0], revoked_local_txn[0]);
2182                         node_txn.swap_remove(0);
2183                 }
2184                 check_added_monitors!(nodes[0], 1);
2185                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2186
2187                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2188                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2189                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2190                 check_added_monitors!(nodes[1], 1);
2191                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2192                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2193         }
2194         get_announce_close_broadcast_events(&nodes, 0, 1);
2195         assert_eq!(nodes[0].node.list_channels().len(), 0);
2196         assert_eq!(nodes[1].node.list_channels().len(), 0);
2197 }
2198
2199 #[test]
2200 fn revoked_output_claim() {
2201         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2202         // transaction is broadcast by its counterparty
2203         let chanmon_cfgs = create_chanmon_cfgs(2);
2204         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2205         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2206         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2207         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2208         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2209         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2210         assert_eq!(revoked_local_txn.len(), 1);
2211         // Only output is the full channel value back to nodes[0]:
2212         assert_eq!(revoked_local_txn[0].output.len(), 1);
2213         // Send a payment through, updating everyone's latest commitment txn
2214         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2215
2216         // Inform nodes[1] that nodes[0] broadcast a stale tx
2217         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2218         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2219         check_added_monitors!(nodes[1], 1);
2220         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2221         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2222
2223         check_spends!(node_txn[0], revoked_local_txn[0]);
2224         check_spends!(node_txn[1], chan_1.3);
2225
2226         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2227         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2228         get_announce_close_broadcast_events(&nodes, 0, 1);
2229         check_added_monitors!(nodes[0], 1)
2230 }
2231
2232 #[test]
2233 fn claim_htlc_outputs_shared_tx() {
2234         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2235         let chanmon_cfgs = create_chanmon_cfgs(2);
2236         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2237         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2238         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2239
2240         // Create some new channel:
2241         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2242
2243         // Rebalance the network to generate htlc in the two directions
2244         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2245         // 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
2246         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2247         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2248
2249         // Get the will-be-revoked local txn from node[0]
2250         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2251         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2252         assert_eq!(revoked_local_txn[0].input.len(), 1);
2253         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2254         assert_eq!(revoked_local_txn[1].input.len(), 1);
2255         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2256         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2257         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2258
2259         //Revoke the old state
2260         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2261
2262         {
2263                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2264                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2265                 check_added_monitors!(nodes[0], 1);
2266                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2267                 check_added_monitors!(nodes[1], 1);
2268                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2269
2270                 let events = nodes[1].node.get_and_clear_pending_events();
2271                 assert_eq!(events.len(), 1);
2272                 match events[0] {
2273                         Event::PaymentFailed { payment_hash, .. } => {
2274                                 assert_eq!(payment_hash, payment_hash_2);
2275                         },
2276                         _ => panic!("Unexpected event"),
2277                 }
2278
2279                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2280                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2281
2282                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2283                 check_spends!(node_txn[0], revoked_local_txn[0]);
2284
2285                 let mut witness_lens = BTreeSet::new();
2286                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2287                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2288                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2289                 assert_eq!(witness_lens.len(), 3);
2290                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2291                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2292                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2293
2294                 // Next nodes[1] broadcasts its current local tx state:
2295                 assert_eq!(node_txn[1].input.len(), 1);
2296                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2297
2298                 assert_eq!(node_txn[2].input.len(), 1);
2299                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2300                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2301                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2302                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2303                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2304         }
2305         get_announce_close_broadcast_events(&nodes, 0, 1);
2306         assert_eq!(nodes[0].node.list_channels().len(), 0);
2307         assert_eq!(nodes[1].node.list_channels().len(), 0);
2308 }
2309
2310 #[test]
2311 fn claim_htlc_outputs_single_tx() {
2312         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2313         let chanmon_cfgs = create_chanmon_cfgs(2);
2314         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2315         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2316         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2317
2318         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2319
2320         // Rebalance the network to generate htlc in the two directions
2321         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2322         // 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
2323         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2324         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2325         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2326
2327         // Get the will-be-revoked local txn from node[0]
2328         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2329
2330         //Revoke the old state
2331         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2332
2333         {
2334                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2335                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2336                 check_added_monitors!(nodes[0], 1);
2337                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2338                 check_added_monitors!(nodes[1], 1);
2339                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2340
2341                 let events = nodes[1].node.get_and_clear_pending_events();
2342                 assert_eq!(events.len(), 1);
2343                 match events[0] {
2344                         Event::PaymentFailed { payment_hash, .. } => {
2345                                 assert_eq!(payment_hash, payment_hash_2);
2346                         },
2347                         _ => panic!("Unexpected event"),
2348                 }
2349
2350                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2351                 assert_eq!(node_txn.len(), 21);
2352                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2353                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2354                 // ChannelMonitor: bumped justice tx (4), after one increase, bumps on HTLC aren't generated not being substantial anymore
2355                 // ChannelMonito r: local commitment + local HTLC-timeout (14)
2356
2357                 assert_eq!(node_txn[0], node_txn[5]);
2358                 assert_eq!(node_txn[0], node_txn[7]);
2359                 assert_eq!(node_txn[0], node_txn[9]);
2360                 assert_eq!(node_txn[0], node_txn[13]);
2361                 assert_eq!(node_txn[0], node_txn[15]);
2362                 assert_eq!(node_txn[0], node_txn[17]);
2363                 assert_eq!(node_txn[0], node_txn[19]);
2364
2365                 assert_eq!(node_txn[1], node_txn[6]);
2366                 assert_eq!(node_txn[1], node_txn[8]);
2367                 assert_eq!(node_txn[1], node_txn[10]);
2368                 assert_eq!(node_txn[1], node_txn[14]);
2369                 assert_eq!(node_txn[1], node_txn[16]);
2370                 assert_eq!(node_txn[1], node_txn[18]);
2371                 assert_eq!(node_txn[1], node_txn[20]);
2372
2373
2374                 // 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)
2375                 assert_eq!(node_txn[0].input.len(), 1);
2376                 check_spends!(node_txn[0], chan_1.3);
2377                 assert_eq!(node_txn[1].input.len(), 1);
2378                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2379                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2380                 check_spends!(node_txn[1], node_txn[0]);
2381
2382                 // Justice transactions are indices 2-3-4
2383                 assert_eq!(node_txn[2].input.len(), 1);
2384                 assert_eq!(node_txn[3].input.len(), 1);
2385                 assert_eq!(node_txn[4].input.len(), 1);
2386                 check_spends!(node_txn[2], revoked_local_txn[0]);
2387                 check_spends!(node_txn[3], revoked_local_txn[0]);
2388                 check_spends!(node_txn[4], revoked_local_txn[0]);
2389
2390                 let mut witness_lens = BTreeSet::new();
2391                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2392                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2393                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2394                 assert_eq!(witness_lens.len(), 3);
2395                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2396                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2397                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2398         }
2399         get_announce_close_broadcast_events(&nodes, 0, 1);
2400         assert_eq!(nodes[0].node.list_channels().len(), 0);
2401         assert_eq!(nodes[1].node.list_channels().len(), 0);
2402 }
2403
2404 #[test]
2405 fn test_htlc_on_chain_success() {
2406         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2407         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2408         // broadcasting the right event to other nodes in payment path.
2409         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2410         // A --------------------> B ----------------------> C (preimage)
2411         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2412         // commitment transaction was broadcast.
2413         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2414         // towards B.
2415         // B should be able to claim via preimage if A then broadcasts its local tx.
2416         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2417         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2418         // PaymentSent event).
2419
2420         let chanmon_cfgs = create_chanmon_cfgs(3);
2421         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2422         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2423         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2424
2425         // Create some initial channels
2426         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2427         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2428
2429         // Rebalance the network a bit by relaying one payment through all the channels...
2430         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2431         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2432
2433         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2434         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2435         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2436
2437         // Broadcast legit commitment tx from C on B's chain
2438         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2439         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2440         assert_eq!(commitment_tx.len(), 1);
2441         check_spends!(commitment_tx[0], chan_2.3);
2442         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2443         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2444         check_added_monitors!(nodes[2], 2);
2445         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2446         assert!(updates.update_add_htlcs.is_empty());
2447         assert!(updates.update_fail_htlcs.is_empty());
2448         assert!(updates.update_fail_malformed_htlcs.is_empty());
2449         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2450
2451         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2452         check_closed_broadcast!(nodes[2], false);
2453         check_added_monitors!(nodes[2], 1);
2454         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)
2455         assert_eq!(node_txn.len(), 7);
2456         assert_eq!(node_txn[0], node_txn[3]);
2457         assert_eq!(node_txn[1], node_txn[4]);
2458         assert_eq!(node_txn[0], node_txn[5]);
2459         assert_eq!(node_txn[1], node_txn[6]);
2460         assert_eq!(node_txn[2], commitment_tx[0]);
2461         check_spends!(node_txn[0], commitment_tx[0]);
2462         check_spends!(node_txn[1], commitment_tx[0]);
2463         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2464         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2465         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2466         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2467         assert_eq!(node_txn[0].lock_time, 0);
2468         assert_eq!(node_txn[1].lock_time, 0);
2469
2470         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2471         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2472         {
2473                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2474                 assert_eq!(added_monitors.len(), 1);
2475                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2476                 added_monitors.clear();
2477         }
2478         let events = nodes[1].node.get_and_clear_pending_msg_events();
2479         {
2480                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2481                 assert_eq!(added_monitors.len(), 2);
2482                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2483                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2484                 added_monitors.clear();
2485         }
2486         assert_eq!(events.len(), 2);
2487         match events[0] {
2488                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2489                 _ => panic!("Unexpected event"),
2490         }
2491         match events[1] {
2492                 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, .. } } => {
2493                         assert!(update_add_htlcs.is_empty());
2494                         assert!(update_fail_htlcs.is_empty());
2495                         assert_eq!(update_fulfill_htlcs.len(), 1);
2496                         assert!(update_fail_malformed_htlcs.is_empty());
2497                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2498                 },
2499                 _ => panic!("Unexpected event"),
2500         };
2501         macro_rules! check_tx_local_broadcast {
2502                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2503                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2504                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2505                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2506                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2507                         check_spends!(node_txn[0], $commitment_tx);
2508                         check_spends!(node_txn[1], $commitment_tx);
2509                         if $htlc_offered {
2510                                 assert_eq!(node_txn[0], node_txn[5]);
2511                                 assert_eq!(node_txn[1], node_txn[6]);
2512                         }
2513                         assert_ne!(node_txn[0].lock_time, 0);
2514                         assert_ne!(node_txn[1].lock_time, 0);
2515                         if $htlc_offered {
2516                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2517                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2518                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2519                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2520                         } else {
2521                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2522                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2523                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2524                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2525                         }
2526                         check_spends!(node_txn[2], $chan_tx);
2527                         check_spends!(node_txn[3], node_txn[2]);
2528                         check_spends!(node_txn[4], node_txn[2]);
2529                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2530                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2531                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2532                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2533                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2534                         assert_ne!(node_txn[3].lock_time, 0);
2535                         assert_ne!(node_txn[4].lock_time, 0);
2536                         node_txn.clear();
2537                 } }
2538         }
2539         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2540         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2541         // timeout-claim of the output that nodes[2] just claimed via success.
2542         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2543
2544         // Broadcast legit commitment tx from A on B's chain
2545         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2546         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2547         check_spends!(commitment_tx[0], chan_1.3);
2548         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2549         check_closed_broadcast!(nodes[1], false);
2550         check_added_monitors!(nodes[1], 1);
2551         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2552         assert_eq!(node_txn.len(), 4);
2553         check_spends!(node_txn[0], commitment_tx[0]);
2554         assert_eq!(node_txn[0].input.len(), 2);
2555         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2556         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2557         assert_eq!(node_txn[0].lock_time, 0);
2558         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2559         check_spends!(node_txn[1], chan_1.3);
2560         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2561         check_spends!(node_txn[2], node_txn[1]);
2562         check_spends!(node_txn[3], node_txn[1]);
2563         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2564         // we already checked the same situation with A.
2565
2566         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2567         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2568         check_closed_broadcast!(nodes[0], false);
2569         check_added_monitors!(nodes[0], 1);
2570         let events = nodes[0].node.get_and_clear_pending_events();
2571         assert_eq!(events.len(), 2);
2572         let mut first_claimed = false;
2573         for event in events {
2574                 match event {
2575                         Event::PaymentSent { payment_preimage } => {
2576                                 if payment_preimage == our_payment_preimage {
2577                                         assert!(!first_claimed);
2578                                         first_claimed = true;
2579                                 } else {
2580                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2581                                 }
2582                         },
2583                         _ => panic!("Unexpected event"),
2584                 }
2585         }
2586         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2587 }
2588
2589 #[test]
2590 fn test_htlc_on_chain_timeout() {
2591         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2592         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2593         // broadcasting the right event to other nodes in payment path.
2594         // A ------------------> B ----------------------> C (timeout)
2595         //    B's commitment tx                 C's commitment tx
2596         //            \                                  \
2597         //         B's HTLC timeout tx               B's timeout tx
2598
2599         let chanmon_cfgs = create_chanmon_cfgs(3);
2600         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2601         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2602         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2603
2604         // Create some intial channels
2605         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2606         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2607
2608         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2609         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2610         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2611
2612         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2613         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2614
2615         // Broadcast legit commitment tx from C on B's chain
2616         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2617         check_spends!(commitment_tx[0], chan_2.3);
2618         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2619         check_added_monitors!(nodes[2], 0);
2620         expect_pending_htlcs_forwardable!(nodes[2]);
2621         check_added_monitors!(nodes[2], 1);
2622
2623         let events = nodes[2].node.get_and_clear_pending_msg_events();
2624         assert_eq!(events.len(), 1);
2625         match events[0] {
2626                 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, .. } } => {
2627                         assert!(update_add_htlcs.is_empty());
2628                         assert!(!update_fail_htlcs.is_empty());
2629                         assert!(update_fulfill_htlcs.is_empty());
2630                         assert!(update_fail_malformed_htlcs.is_empty());
2631                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2632                 },
2633                 _ => panic!("Unexpected event"),
2634         };
2635         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2636         check_closed_broadcast!(nodes[2], false);
2637         check_added_monitors!(nodes[2], 1);
2638         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2639         assert_eq!(node_txn.len(), 1);
2640         check_spends!(node_txn[0], chan_2.3);
2641         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2642
2643         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2644         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2645         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2646         let timeout_tx;
2647         {
2648                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2649                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2650                 assert_eq!(node_txn[0], node_txn[3]);
2651                 assert_eq!(node_txn[0], node_txn[5]);
2652                 assert_eq!(node_txn[1], node_txn[4]);
2653                 assert_eq!(node_txn[1], node_txn[6]);
2654
2655                 check_spends!(node_txn[2], commitment_tx[0]);
2656                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2657
2658                 check_spends!(node_txn[0], chan_2.3);
2659                 check_spends!(node_txn[1], node_txn[0]);
2660                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2661                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2662
2663                 timeout_tx = node_txn[2].clone();
2664                 node_txn.clear();
2665         }
2666
2667         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2668         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2669         check_added_monitors!(nodes[1], 1);
2670         check_closed_broadcast!(nodes[1], false);
2671
2672         expect_pending_htlcs_forwardable!(nodes[1]);
2673         check_added_monitors!(nodes[1], 1);
2674         let events = nodes[1].node.get_and_clear_pending_msg_events();
2675         assert_eq!(events.len(), 1);
2676         match events[0] {
2677                 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, .. } } => {
2678                         assert!(update_add_htlcs.is_empty());
2679                         assert!(!update_fail_htlcs.is_empty());
2680                         assert!(update_fulfill_htlcs.is_empty());
2681                         assert!(update_fail_malformed_htlcs.is_empty());
2682                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2683                 },
2684                 _ => panic!("Unexpected event"),
2685         };
2686         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
2687         assert_eq!(node_txn.len(), 0);
2688
2689         // Broadcast legit commitment tx from B on A's chain
2690         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2691         check_spends!(commitment_tx[0], chan_1.3);
2692
2693         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2694         check_closed_broadcast!(nodes[0], false);
2695         check_added_monitors!(nodes[0], 1);
2696         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2697         assert_eq!(node_txn.len(), 3);
2698         check_spends!(node_txn[0], commitment_tx[0]);
2699         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2700         check_spends!(node_txn[1], chan_1.3);
2701         check_spends!(node_txn[2], node_txn[1]);
2702         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2703         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2704 }
2705
2706 #[test]
2707 fn test_simple_commitment_revoked_fail_backward() {
2708         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2709         // and fail backward accordingly.
2710
2711         let chanmon_cfgs = create_chanmon_cfgs(3);
2712         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2713         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2714         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2715
2716         // Create some initial channels
2717         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2718         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2719
2720         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2721         // Get the will-be-revoked local txn from nodes[2]
2722         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2723         // Revoke the old state
2724         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2725
2726         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2727
2728         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2729         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2730         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2731         check_added_monitors!(nodes[1], 1);
2732         check_closed_broadcast!(nodes[1], false);
2733
2734         expect_pending_htlcs_forwardable!(nodes[1]);
2735         check_added_monitors!(nodes[1], 1);
2736         let events = nodes[1].node.get_and_clear_pending_msg_events();
2737         assert_eq!(events.len(), 1);
2738         match events[0] {
2739                 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, .. } } => {
2740                         assert!(update_add_htlcs.is_empty());
2741                         assert_eq!(update_fail_htlcs.len(), 1);
2742                         assert!(update_fulfill_htlcs.is_empty());
2743                         assert!(update_fail_malformed_htlcs.is_empty());
2744                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2745
2746                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2747                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2748
2749                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2750                         assert_eq!(events.len(), 1);
2751                         match events[0] {
2752                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2753                                 _ => panic!("Unexpected event"),
2754                         }
2755                         let events = nodes[0].node.get_and_clear_pending_events();
2756                         assert_eq!(events.len(), 1);
2757                         match events[0] {
2758                                 Event::PaymentFailed { .. } => {},
2759                                 _ => panic!("Unexpected event"),
2760                         }
2761                 },
2762                 _ => panic!("Unexpected event"),
2763         }
2764 }
2765
2766 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2767         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2768         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2769         // commitment transaction anymore.
2770         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2771         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2772         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2773         // technically disallowed and we should probably handle it reasonably.
2774         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2775         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2776         // transactions:
2777         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2778         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2779         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2780         //   and once they revoke the previous commitment transaction (allowing us to send a new
2781         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2782         let chanmon_cfgs = create_chanmon_cfgs(3);
2783         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2784         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2785         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2786
2787         // Create some initial channels
2788         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2789         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2790
2791         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2792         // Get the will-be-revoked local txn from nodes[2]
2793         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2794         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2795         // Revoke the old state
2796         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2797
2798         let value = if use_dust {
2799                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2800                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2801                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2802         } else { 3000000 };
2803
2804         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2805         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2806         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2807
2808         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2809         expect_pending_htlcs_forwardable!(nodes[2]);
2810         check_added_monitors!(nodes[2], 1);
2811         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2812         assert!(updates.update_add_htlcs.is_empty());
2813         assert!(updates.update_fulfill_htlcs.is_empty());
2814         assert!(updates.update_fail_malformed_htlcs.is_empty());
2815         assert_eq!(updates.update_fail_htlcs.len(), 1);
2816         assert!(updates.update_fee.is_none());
2817         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2818         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2819         // Drop the last RAA from 3 -> 2
2820
2821         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2822         expect_pending_htlcs_forwardable!(nodes[2]);
2823         check_added_monitors!(nodes[2], 1);
2824         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2825         assert!(updates.update_add_htlcs.is_empty());
2826         assert!(updates.update_fulfill_htlcs.is_empty());
2827         assert!(updates.update_fail_malformed_htlcs.is_empty());
2828         assert_eq!(updates.update_fail_htlcs.len(), 1);
2829         assert!(updates.update_fee.is_none());
2830         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2831         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2832         check_added_monitors!(nodes[1], 1);
2833         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2834         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2835         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2836         check_added_monitors!(nodes[2], 1);
2837
2838         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2839         expect_pending_htlcs_forwardable!(nodes[2]);
2840         check_added_monitors!(nodes[2], 1);
2841         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2842         assert!(updates.update_add_htlcs.is_empty());
2843         assert!(updates.update_fulfill_htlcs.is_empty());
2844         assert!(updates.update_fail_malformed_htlcs.is_empty());
2845         assert_eq!(updates.update_fail_htlcs.len(), 1);
2846         assert!(updates.update_fee.is_none());
2847         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2848         // At this point first_payment_hash has dropped out of the latest two commitment
2849         // transactions that nodes[1] is tracking...
2850         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2851         check_added_monitors!(nodes[1], 1);
2852         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2853         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2854         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2855         check_added_monitors!(nodes[2], 1);
2856
2857         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2858         // on nodes[2]'s RAA.
2859         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2860         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2861         nodes[1].node.send_payment(route, fourth_payment_hash, &None).unwrap();
2862         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2863         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2864         check_added_monitors!(nodes[1], 0);
2865
2866         if deliver_bs_raa {
2867                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2868                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2869                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2870                 check_added_monitors!(nodes[1], 1);
2871                 let events = nodes[1].node.get_and_clear_pending_events();
2872                 assert_eq!(events.len(), 1);
2873                 match events[0] {
2874                         Event::PendingHTLCsForwardable { .. } => { },
2875                         _ => panic!("Unexpected event"),
2876                 };
2877                 // Deliberately don't process the pending fail-back so they all fail back at once after
2878                 // block connection just like the !deliver_bs_raa case
2879         }
2880
2881         let mut failed_htlcs = HashSet::new();
2882         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2883
2884         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2885         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2886         check_added_monitors!(nodes[1], 1);
2887         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2888
2889         let events = nodes[1].node.get_and_clear_pending_events();
2890         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2891         match events[0] {
2892                 Event::PaymentFailed { ref payment_hash, .. } => {
2893                         assert_eq!(*payment_hash, fourth_payment_hash);
2894                 },
2895                 _ => panic!("Unexpected event"),
2896         }
2897         if !deliver_bs_raa {
2898                 match events[1] {
2899                         Event::PendingHTLCsForwardable { .. } => { },
2900                         _ => panic!("Unexpected event"),
2901                 };
2902         }
2903         nodes[1].node.process_pending_htlc_forwards();
2904         check_added_monitors!(nodes[1], 1);
2905
2906         let events = nodes[1].node.get_and_clear_pending_msg_events();
2907         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2908         match events[if deliver_bs_raa { 1 } else { 0 }] {
2909                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2910                 _ => panic!("Unexpected event"),
2911         }
2912         if deliver_bs_raa {
2913                 match events[0] {
2914                         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, .. } } => {
2915                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2916                                 assert_eq!(update_add_htlcs.len(), 1);
2917                                 assert!(update_fulfill_htlcs.is_empty());
2918                                 assert!(update_fail_htlcs.is_empty());
2919                                 assert!(update_fail_malformed_htlcs.is_empty());
2920                         },
2921                         _ => panic!("Unexpected event"),
2922                 }
2923         }
2924         match events[if deliver_bs_raa { 2 } else { 1 }] {
2925                 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, .. } } => {
2926                         assert!(update_add_htlcs.is_empty());
2927                         assert_eq!(update_fail_htlcs.len(), 3);
2928                         assert!(update_fulfill_htlcs.is_empty());
2929                         assert!(update_fail_malformed_htlcs.is_empty());
2930                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2931
2932                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2933                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2934                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2935
2936                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2937
2938                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2939                         // If we delivered B's RAA we got an unknown preimage error, not something
2940                         // that we should update our routing table for.
2941                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2942                         for event in events {
2943                                 match event {
2944                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2945                                         _ => panic!("Unexpected event"),
2946                                 }
2947                         }
2948                         let events = nodes[0].node.get_and_clear_pending_events();
2949                         assert_eq!(events.len(), 3);
2950                         match events[0] {
2951                                 Event::PaymentFailed { ref payment_hash, .. } => {
2952                                         assert!(failed_htlcs.insert(payment_hash.0));
2953                                 },
2954                                 _ => panic!("Unexpected event"),
2955                         }
2956                         match events[1] {
2957                                 Event::PaymentFailed { ref payment_hash, .. } => {
2958                                         assert!(failed_htlcs.insert(payment_hash.0));
2959                                 },
2960                                 _ => panic!("Unexpected event"),
2961                         }
2962                         match events[2] {
2963                                 Event::PaymentFailed { ref payment_hash, .. } => {
2964                                         assert!(failed_htlcs.insert(payment_hash.0));
2965                                 },
2966                                 _ => panic!("Unexpected event"),
2967                         }
2968                 },
2969                 _ => panic!("Unexpected event"),
2970         }
2971
2972         assert!(failed_htlcs.contains(&first_payment_hash.0));
2973         assert!(failed_htlcs.contains(&second_payment_hash.0));
2974         assert!(failed_htlcs.contains(&third_payment_hash.0));
2975 }
2976
2977 #[test]
2978 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2979         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2980         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2981         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2982         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2983 }
2984
2985 #[test]
2986 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2987         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2988         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2989         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2990         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2991 }
2992
2993 #[test]
2994 fn fail_backward_pending_htlc_upon_channel_failure() {
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2999         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
3000
3001         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3002         {
3003                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3004                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3005                 nodes[0].node.send_payment(route, payment_hash, &None).unwrap();
3006                 check_added_monitors!(nodes[0], 1);
3007
3008                 let payment_event = {
3009                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3010                         assert_eq!(events.len(), 1);
3011                         SendEvent::from_event(events.remove(0))
3012                 };
3013                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3014                 assert_eq!(payment_event.msgs.len(), 1);
3015         }
3016
3017         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3018         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3019         {
3020                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3021                 nodes[0].node.send_payment(route, failed_payment_hash, &None).unwrap();
3022                 check_added_monitors!(nodes[0], 0);
3023
3024                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3025         }
3026
3027         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3028         {
3029                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3030                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3031
3032                 let secp_ctx = Secp256k1::new();
3033                 let session_priv = {
3034                         let mut session_key = [0; 32];
3035                         let mut rng = thread_rng();
3036                         rng.fill_bytes(&mut session_key);
3037                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3038                 };
3039
3040                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3041                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route, &None, current_height).unwrap();
3042                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3043                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3044
3045                 // Send a 0-msat update_add_htlc to fail the channel.
3046                 let update_add_htlc = msgs::UpdateAddHTLC {
3047                         channel_id: chan.2,
3048                         htlc_id: 0,
3049                         amount_msat: 0,
3050                         payment_hash,
3051                         cltv_expiry,
3052                         onion_routing_packet,
3053                 };
3054                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3055         }
3056
3057         // Check that Alice fails backward the pending HTLC from the second payment.
3058         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3059         check_closed_broadcast!(nodes[0], true);
3060         check_added_monitors!(nodes[0], 1);
3061 }
3062
3063 #[test]
3064 fn test_htlc_ignore_latest_remote_commitment() {
3065         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3066         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3067         let chanmon_cfgs = create_chanmon_cfgs(2);
3068         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3069         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3070         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3071         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3072
3073         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3074         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3075         check_closed_broadcast!(nodes[0], false);
3076         check_added_monitors!(nodes[0], 1);
3077
3078         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3079         assert_eq!(node_txn.len(), 2);
3080
3081         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3082         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3083         check_closed_broadcast!(nodes[1], false);
3084         check_added_monitors!(nodes[1], 1);
3085
3086         // Duplicate the block_connected call since this may happen due to other listeners
3087         // registering new transactions
3088         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3089 }
3090
3091 #[test]
3092 fn test_force_close_fail_back() {
3093         // Check which HTLCs are failed-backwards on channel force-closure
3094         let chanmon_cfgs = create_chanmon_cfgs(3);
3095         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3096         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3097         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3098         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3099         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3100
3101         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3102
3103         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3104
3105         let mut payment_event = {
3106                 nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
3107                 check_added_monitors!(nodes[0], 1);
3108
3109                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3110                 assert_eq!(events.len(), 1);
3111                 SendEvent::from_event(events.remove(0))
3112         };
3113
3114         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3115         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3116
3117         expect_pending_htlcs_forwardable!(nodes[1]);
3118
3119         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3120         assert_eq!(events_2.len(), 1);
3121         payment_event = SendEvent::from_event(events_2.remove(0));
3122         assert_eq!(payment_event.msgs.len(), 1);
3123
3124         check_added_monitors!(nodes[1], 1);
3125         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3126         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3127         check_added_monitors!(nodes[2], 1);
3128         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3129
3130         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3131         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3132         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3133
3134         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3135         check_closed_broadcast!(nodes[2], false);
3136         check_added_monitors!(nodes[2], 1);
3137         let tx = {
3138                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3139                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3140                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3141                 // back to nodes[1] upon timeout otherwise.
3142                 assert_eq!(node_txn.len(), 1);
3143                 node_txn.remove(0)
3144         };
3145
3146         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3147         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3148
3149         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3150         check_closed_broadcast!(nodes[1], false);
3151         check_added_monitors!(nodes[1], 1);
3152
3153         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3154         {
3155                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3156                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3157                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3158         }
3159         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3160         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3161         assert_eq!(node_txn.len(), 1);
3162         assert_eq!(node_txn[0].input.len(), 1);
3163         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3164         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3165         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3166
3167         check_spends!(node_txn[0], tx);
3168 }
3169
3170 #[test]
3171 fn test_unconf_chan() {
3172         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3173         let chanmon_cfgs = create_chanmon_cfgs(2);
3174         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3175         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3176         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3177         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3178
3179         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3180         assert_eq!(channel_state.by_id.len(), 1);
3181         assert_eq!(channel_state.short_to_id.len(), 1);
3182         mem::drop(channel_state);
3183
3184         let mut headers = Vec::new();
3185         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3186         headers.push(header.clone());
3187         for _i in 2..100 {
3188                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3189                 headers.push(header.clone());
3190         }
3191         let mut height = 99;
3192         while !headers.is_empty() {
3193                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3194                 height -= 1;
3195         }
3196         check_closed_broadcast!(nodes[0], false);
3197         check_added_monitors!(nodes[0], 1);
3198         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3199         assert_eq!(channel_state.by_id.len(), 0);
3200         assert_eq!(channel_state.short_to_id.len(), 0);
3201 }
3202
3203 #[test]
3204 fn test_simple_peer_disconnect() {
3205         // Test that we can reconnect when there are no lost messages
3206         let chanmon_cfgs = create_chanmon_cfgs(3);
3207         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3208         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3209         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3210         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3211         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3212
3213         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3214         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3215         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3216
3217         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3218         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3219         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3220         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3221
3222         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3223         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3224         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3225
3226         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3227         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3228         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3229         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3230
3231         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3232         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3233
3234         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3235         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3236
3237         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3238         {
3239                 let events = nodes[0].node.get_and_clear_pending_events();
3240                 assert_eq!(events.len(), 2);
3241                 match events[0] {
3242                         Event::PaymentSent { payment_preimage } => {
3243                                 assert_eq!(payment_preimage, payment_preimage_3);
3244                         },
3245                         _ => panic!("Unexpected event"),
3246                 }
3247                 match events[1] {
3248                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3249                                 assert_eq!(payment_hash, payment_hash_5);
3250                                 assert!(rejected_by_dest);
3251                         },
3252                         _ => panic!("Unexpected event"),
3253                 }
3254         }
3255
3256         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3257         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3258 }
3259
3260 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3261         // Test that we can reconnect when in-flight HTLC updates get dropped
3262         let chanmon_cfgs = create_chanmon_cfgs(2);
3263         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3264         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3265         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3266         if messages_delivered == 0 {
3267                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3268                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3269         } else {
3270                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3271         }
3272
3273         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();
3274         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3275
3276         let payment_event = {
3277                 nodes[0].node.send_payment(route.clone(), payment_hash_1, &None).unwrap();
3278                 check_added_monitors!(nodes[0], 1);
3279
3280                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3281                 assert_eq!(events.len(), 1);
3282                 SendEvent::from_event(events.remove(0))
3283         };
3284         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3285
3286         if messages_delivered < 2 {
3287                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3288         } else {
3289                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3290                 if messages_delivered >= 3 {
3291                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3292                         check_added_monitors!(nodes[1], 1);
3293                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3294
3295                         if messages_delivered >= 4 {
3296                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3297                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3298                                 check_added_monitors!(nodes[0], 1);
3299
3300                                 if messages_delivered >= 5 {
3301                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3302                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3303                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3304                                         check_added_monitors!(nodes[0], 1);
3305
3306                                         if messages_delivered >= 6 {
3307                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3308                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3309                                                 check_added_monitors!(nodes[1], 1);
3310                                         }
3311                                 }
3312                         }
3313                 }
3314         }
3315
3316         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3317         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3318         if messages_delivered < 3 {
3319                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3320                 // received on either side, both sides will need to resend them.
3321                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3322         } else if messages_delivered == 3 {
3323                 // nodes[0] still wants its RAA + commitment_signed
3324                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3325         } else if messages_delivered == 4 {
3326                 // nodes[0] still wants its commitment_signed
3327                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3328         } else if messages_delivered == 5 {
3329                 // nodes[1] still wants its final RAA
3330                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3331         } else if messages_delivered == 6 {
3332                 // Everything was delivered...
3333                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3334         }
3335
3336         let events_1 = nodes[1].node.get_and_clear_pending_events();
3337         assert_eq!(events_1.len(), 1);
3338         match events_1[0] {
3339                 Event::PendingHTLCsForwardable { .. } => { },
3340                 _ => panic!("Unexpected event"),
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         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3346
3347         nodes[1].node.process_pending_htlc_forwards();
3348
3349         let events_2 = nodes[1].node.get_and_clear_pending_events();
3350         assert_eq!(events_2.len(), 1);
3351         match events_2[0] {
3352                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3353                         assert_eq!(payment_hash_1, *payment_hash);
3354                         assert_eq!(*payment_secret, None);
3355                         assert_eq!(amt, 1000000);
3356                 },
3357                 _ => panic!("Unexpected event"),
3358         }
3359
3360         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3361         check_added_monitors!(nodes[1], 1);
3362
3363         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3364         assert_eq!(events_3.len(), 1);
3365         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3366                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3367                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3368                         assert!(updates.update_add_htlcs.is_empty());
3369                         assert!(updates.update_fail_htlcs.is_empty());
3370                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3371                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3372                         assert!(updates.update_fee.is_none());
3373                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3374                 },
3375                 _ => panic!("Unexpected event"),
3376         };
3377
3378         if messages_delivered >= 1 {
3379                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3380
3381                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3382                 assert_eq!(events_4.len(), 1);
3383                 match events_4[0] {
3384                         Event::PaymentSent { ref payment_preimage } => {
3385                                 assert_eq!(payment_preimage_1, *payment_preimage);
3386                         },
3387                         _ => panic!("Unexpected event"),
3388                 }
3389
3390                 if messages_delivered >= 2 {
3391                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3392                         check_added_monitors!(nodes[0], 1);
3393                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3394
3395                         if messages_delivered >= 3 {
3396                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3397                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3398                                 check_added_monitors!(nodes[1], 1);
3399
3400                                 if messages_delivered >= 4 {
3401                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3402                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3403                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3404                                         check_added_monitors!(nodes[1], 1);
3405
3406                                         if messages_delivered >= 5 {
3407                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3408                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3409                                                 check_added_monitors!(nodes[0], 1);
3410                                         }
3411                                 }
3412                         }
3413                 }
3414         }
3415
3416         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3417         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3418         if messages_delivered < 2 {
3419                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3420                 //TODO: Deduplicate PaymentSent events, then enable this if:
3421                 //if messages_delivered < 1 {
3422                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3423                         assert_eq!(events_4.len(), 1);
3424                         match events_4[0] {
3425                                 Event::PaymentSent { ref payment_preimage } => {
3426                                         assert_eq!(payment_preimage_1, *payment_preimage);
3427                                 },
3428                                 _ => panic!("Unexpected event"),
3429                         }
3430                 //}
3431         } else if messages_delivered == 2 {
3432                 // nodes[0] still wants its RAA + commitment_signed
3433                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3434         } else if messages_delivered == 3 {
3435                 // nodes[0] still wants its commitment_signed
3436                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3437         } else if messages_delivered == 4 {
3438                 // nodes[1] still wants its final RAA
3439                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3440         } else if messages_delivered == 5 {
3441                 // Everything was delivered...
3442                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3443         }
3444
3445         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3446         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3447         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3448
3449         // Channel should still work fine...
3450         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3451         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3452 }
3453
3454 #[test]
3455 fn test_drop_messages_peer_disconnect_a() {
3456         do_test_drop_messages_peer_disconnect(0);
3457         do_test_drop_messages_peer_disconnect(1);
3458         do_test_drop_messages_peer_disconnect(2);
3459         do_test_drop_messages_peer_disconnect(3);
3460 }
3461
3462 #[test]
3463 fn test_drop_messages_peer_disconnect_b() {
3464         do_test_drop_messages_peer_disconnect(4);
3465         do_test_drop_messages_peer_disconnect(5);
3466         do_test_drop_messages_peer_disconnect(6);
3467 }
3468
3469 #[test]
3470 fn test_funding_peer_disconnect() {
3471         // Test that we can lock in our funding tx while disconnected
3472         let chanmon_cfgs = create_chanmon_cfgs(2);
3473         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3474         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3475         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3476         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3477
3478         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3479         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3480
3481         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3482         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3483         assert_eq!(events_1.len(), 1);
3484         match events_1[0] {
3485                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3486                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3487                 },
3488                 _ => panic!("Unexpected event"),
3489         }
3490
3491         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3492
3493         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3494         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3495
3496         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3497         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3498         assert_eq!(events_2.len(), 2);
3499         let funding_locked = match events_2[0] {
3500                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3501                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3502                         msg.clone()
3503                 },
3504                 _ => panic!("Unexpected event"),
3505         };
3506         let bs_announcement_sigs = match events_2[1] {
3507                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3508                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3509                         msg.clone()
3510                 },
3511                 _ => panic!("Unexpected event"),
3512         };
3513
3514         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3515
3516         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3517         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3518         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3519         assert_eq!(events_3.len(), 2);
3520         let as_announcement_sigs = match events_3[0] {
3521                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3522                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3523                         msg.clone()
3524                 },
3525                 _ => panic!("Unexpected event"),
3526         };
3527         let (as_announcement, as_update) = match events_3[1] {
3528                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3529                         (msg.clone(), update_msg.clone())
3530                 },
3531                 _ => panic!("Unexpected event"),
3532         };
3533
3534         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3535         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3536         assert_eq!(events_4.len(), 1);
3537         let (_, bs_update) = match events_4[0] {
3538                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3539                         (msg.clone(), update_msg.clone())
3540                 },
3541                 _ => panic!("Unexpected event"),
3542         };
3543
3544         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3545         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3546         nodes[0].router.handle_channel_update(&as_update).unwrap();
3547
3548         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3549         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3550         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3551 }
3552
3553 #[test]
3554 fn test_drop_messages_peer_disconnect_dual_htlc() {
3555         // Test that we can handle reconnecting when both sides of a channel have pending
3556         // commitment_updates when we disconnect.
3557         let chanmon_cfgs = create_chanmon_cfgs(2);
3558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3560         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3561         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3562
3563         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3564
3565         // Now try to send a second payment which will fail to send
3566         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3567         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3568
3569         nodes[0].node.send_payment(route.clone(), payment_hash_2, &None).unwrap();
3570         check_added_monitors!(nodes[0], 1);
3571
3572         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3573         assert_eq!(events_1.len(), 1);
3574         match events_1[0] {
3575                 MessageSendEvent::UpdateHTLCs { .. } => {},
3576                 _ => panic!("Unexpected event"),
3577         }
3578
3579         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3580         check_added_monitors!(nodes[1], 1);
3581
3582         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3583         assert_eq!(events_2.len(), 1);
3584         match events_2[0] {
3585                 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 } } => {
3586                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3587                         assert!(update_add_htlcs.is_empty());
3588                         assert_eq!(update_fulfill_htlcs.len(), 1);
3589                         assert!(update_fail_htlcs.is_empty());
3590                         assert!(update_fail_malformed_htlcs.is_empty());
3591                         assert!(update_fee.is_none());
3592
3593                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3594                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3595                         assert_eq!(events_3.len(), 1);
3596                         match events_3[0] {
3597                                 Event::PaymentSent { ref payment_preimage } => {
3598                                         assert_eq!(*payment_preimage, payment_preimage_1);
3599                                 },
3600                                 _ => panic!("Unexpected event"),
3601                         }
3602
3603                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3604                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3605                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3606                         check_added_monitors!(nodes[0], 1);
3607                 },
3608                 _ => panic!("Unexpected event"),
3609         }
3610
3611         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3612         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3613
3614         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3615         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3616         assert_eq!(reestablish_1.len(), 1);
3617         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3618         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3619         assert_eq!(reestablish_2.len(), 1);
3620
3621         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3622         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3623         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3624         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3625
3626         assert!(as_resp.0.is_none());
3627         assert!(bs_resp.0.is_none());
3628
3629         assert!(bs_resp.1.is_none());
3630         assert!(bs_resp.2.is_none());
3631
3632         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3633
3634         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3635         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3636         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3637         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3638         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3639         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3640         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3641         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3642         // No commitment_signed so get_event_msg's assert(len == 1) passes
3643         check_added_monitors!(nodes[1], 1);
3644
3645         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3646         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3647         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3648         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3649         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3650         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3651         assert!(bs_second_commitment_signed.update_fee.is_none());
3652         check_added_monitors!(nodes[1], 1);
3653
3654         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3655         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3656         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3657         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3658         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3659         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3660         assert!(as_commitment_signed.update_fee.is_none());
3661         check_added_monitors!(nodes[0], 1);
3662
3663         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3664         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3665         // No commitment_signed so get_event_msg's assert(len == 1) passes
3666         check_added_monitors!(nodes[0], 1);
3667
3668         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3669         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3670         // No commitment_signed so get_event_msg's assert(len == 1) passes
3671         check_added_monitors!(nodes[1], 1);
3672
3673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3674         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3675         check_added_monitors!(nodes[1], 1);
3676
3677         expect_pending_htlcs_forwardable!(nodes[1]);
3678
3679         let events_5 = nodes[1].node.get_and_clear_pending_events();
3680         assert_eq!(events_5.len(), 1);
3681         match events_5[0] {
3682                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3683                         assert_eq!(payment_hash_2, *payment_hash);
3684                         assert_eq!(*payment_secret, None);
3685                 },
3686                 _ => panic!("Unexpected event"),
3687         }
3688
3689         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3691         check_added_monitors!(nodes[0], 1);
3692
3693         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3694 }
3695
3696 #[test]
3697 fn test_invalid_channel_announcement() {
3698         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3699         let secp_ctx = Secp256k1::new();
3700         let chanmon_cfgs = create_chanmon_cfgs(2);
3701         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3702         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3703         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3704
3705         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3706
3707         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3708         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3709         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3710         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3711
3712         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3713
3714         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3715         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3716
3717         let as_network_key = nodes[0].node.get_our_node_id();
3718         let bs_network_key = nodes[1].node.get_our_node_id();
3719
3720         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3721
3722         let mut chan_announcement;
3723
3724         macro_rules! dummy_unsigned_msg {
3725                 () => {
3726                         msgs::UnsignedChannelAnnouncement {
3727                                 features: ChannelFeatures::supported(),
3728                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3729                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3730                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3731                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3732                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3733                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3734                                 excess_data: Vec::new(),
3735                         };
3736                 }
3737         }
3738
3739         macro_rules! sign_msg {
3740                 ($unsigned_msg: expr) => {
3741                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3742                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3743                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3744                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3745                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3746                         chan_announcement = msgs::ChannelAnnouncement {
3747                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3748                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3749                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3750                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3751                                 contents: $unsigned_msg
3752                         }
3753                 }
3754         }
3755
3756         let unsigned_msg = dummy_unsigned_msg!();
3757         sign_msg!(unsigned_msg);
3758         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3759         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 } );
3760
3761         // Configured with Network::Testnet
3762         let mut unsigned_msg = dummy_unsigned_msg!();
3763         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3764         sign_msg!(unsigned_msg);
3765         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3766
3767         let mut unsigned_msg = dummy_unsigned_msg!();
3768         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3769         sign_msg!(unsigned_msg);
3770         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3771 }
3772
3773 #[test]
3774 fn test_no_txn_manager_serialize_deserialize() {
3775         let chanmon_cfgs = create_chanmon_cfgs(2);
3776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3778         let fee_estimator: test_utils::TestFeeEstimator;
3779         let new_chan_monitor: test_utils::TestChannelMonitor;
3780         let keys_manager: test_utils::TestKeysInterface;
3781         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3782         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3783
3784         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
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         let config = UserConfig::default();
3801         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3802         let (_, nodes_0_deserialized_tmp) = {
3803                 let mut channel_monitors = HashMap::new();
3804                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3805                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3806                         default_config: config,
3807                         keys_manager: &keys_manager,
3808                         fee_estimator: &fee_estimator,
3809                         monitor: nodes[0].chan_monitor,
3810                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3811                         logger: Arc::new(test_utils::TestLogger::new()),
3812                         channel_monitors: &mut channel_monitors,
3813                 }).unwrap()
3814         };
3815         nodes_0_deserialized = nodes_0_deserialized_tmp;
3816         assert!(nodes_0_read.is_empty());
3817
3818         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3819         nodes[0].node = &nodes_0_deserialized;
3820         nodes[0].block_notifier.register_listener(nodes[0].node);
3821         assert_eq!(nodes[0].node.list_channels().len(), 1);
3822         check_added_monitors!(nodes[0], 1);
3823
3824         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3825         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3826         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3827         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3828
3829         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3830         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3831         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3832         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3833
3834         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3835         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3836         for node in nodes.iter() {
3837                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3838                 node.router.handle_channel_update(&as_update).unwrap();
3839                 node.router.handle_channel_update(&bs_update).unwrap();
3840         }
3841
3842         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3843 }
3844
3845 #[test]
3846 fn test_simple_manager_serialize_deserialize() {
3847         let chanmon_cfgs = create_chanmon_cfgs(2);
3848         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3849         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3850         let fee_estimator: test_utils::TestFeeEstimator;
3851         let new_chan_monitor: test_utils::TestChannelMonitor;
3852         let keys_manager: test_utils::TestKeysInterface;
3853         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3854         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3855         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3856
3857         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3858         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3859
3860         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3861
3862         let nodes_0_serialized = nodes[0].node.encode();
3863         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3864         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3865
3866         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3867         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);
3868         nodes[0].chan_monitor = &new_chan_monitor;
3869         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3870         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3871         assert!(chan_0_monitor_read.is_empty());
3872
3873         let mut nodes_0_read = &nodes_0_serialized[..];
3874         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3875         let (_, nodes_0_deserialized_tmp) = {
3876                 let mut channel_monitors = HashMap::new();
3877                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3878                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3879                         default_config: UserConfig::default(),
3880                         keys_manager: &keys_manager,
3881                         fee_estimator: &fee_estimator,
3882                         monitor: nodes[0].chan_monitor,
3883                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3884                         logger: Arc::new(test_utils::TestLogger::new()),
3885                         channel_monitors: &mut channel_monitors,
3886                 }).unwrap()
3887         };
3888         nodes_0_deserialized = nodes_0_deserialized_tmp;
3889         assert!(nodes_0_read.is_empty());
3890
3891         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3892         nodes[0].node = &nodes_0_deserialized;
3893         check_added_monitors!(nodes[0], 1);
3894
3895         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3896
3897         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3898         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3899 }
3900
3901 #[test]
3902 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3903         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3904         let chanmon_cfgs = create_chanmon_cfgs(4);
3905         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3906         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3907         let fee_estimator: test_utils::TestFeeEstimator;
3908         let new_chan_monitor: test_utils::TestChannelMonitor;
3909         let keys_manager: test_utils::TestKeysInterface;
3910         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3911         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3912         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3913         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3914         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3915
3916         let mut node_0_stale_monitors_serialized = Vec::new();
3917         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3918                 let mut writer = test_utils::TestVecWriter(Vec::new());
3919                 monitor.1.write_for_disk(&mut writer).unwrap();
3920                 node_0_stale_monitors_serialized.push(writer.0);
3921         }
3922
3923         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3924
3925         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3926         let nodes_0_serialized = nodes[0].node.encode();
3927
3928         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3929         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3930         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3931         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3932
3933         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3934         // nodes[3])
3935         let mut node_0_monitors_serialized = Vec::new();
3936         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3937                 let mut writer = test_utils::TestVecWriter(Vec::new());
3938                 monitor.1.write_for_disk(&mut writer).unwrap();
3939                 node_0_monitors_serialized.push(writer.0);
3940         }
3941
3942         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3943         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);
3944         nodes[0].chan_monitor = &new_chan_monitor;
3945
3946         let mut node_0_stale_monitors = Vec::new();
3947         for serialized in node_0_stale_monitors_serialized.iter() {
3948                 let mut read = &serialized[..];
3949                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3950                 assert!(read.is_empty());
3951                 node_0_stale_monitors.push(monitor);
3952         }
3953
3954         let mut node_0_monitors = Vec::new();
3955         for serialized in node_0_monitors_serialized.iter() {
3956                 let mut read = &serialized[..];
3957                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3958                 assert!(read.is_empty());
3959                 node_0_monitors.push(monitor);
3960         }
3961
3962         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3963
3964         let mut nodes_0_read = &nodes_0_serialized[..];
3965         if let Err(msgs::DecodeError::InvalidValue) =
3966                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3967                 default_config: UserConfig::default(),
3968                 keys_manager: &keys_manager,
3969                 fee_estimator: &fee_estimator,
3970                 monitor: nodes[0].chan_monitor,
3971                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3972                 logger: Arc::new(test_utils::TestLogger::new()),
3973                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3974         }) { } else {
3975                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3976         };
3977
3978         let mut nodes_0_read = &nodes_0_serialized[..];
3979         let (_, nodes_0_deserialized_tmp) =
3980                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3981                 default_config: UserConfig::default(),
3982                 keys_manager: &keys_manager,
3983                 fee_estimator: &fee_estimator,
3984                 monitor: nodes[0].chan_monitor,
3985                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3986                 logger: Arc::new(test_utils::TestLogger::new()),
3987                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3988         }).unwrap();
3989         nodes_0_deserialized = nodes_0_deserialized_tmp;
3990         assert!(nodes_0_read.is_empty());
3991
3992         { // Channel close should result in a commitment tx and an HTLC tx
3993                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3994                 assert_eq!(txn.len(), 2);
3995                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3996                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3997         }
3998
3999         for monitor in node_0_monitors.drain(..) {
4000                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
4001                 check_added_monitors!(nodes[0], 1);
4002         }
4003         nodes[0].node = &nodes_0_deserialized;
4004
4005         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4006         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4007         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4008         //... and we can even still claim the payment!
4009         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4010
4011         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4012         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4013         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4014         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4015         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4016         assert_eq!(msg_events.len(), 1);
4017         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4018                 match action {
4019                         &ErrorAction::SendErrorMessage { ref msg } => {
4020                                 assert_eq!(msg.channel_id, channel_id);
4021                         },
4022                         _ => panic!("Unexpected event!"),
4023                 }
4024         }
4025 }
4026
4027 macro_rules! check_spendable_outputs {
4028         ($node: expr, $der_idx: expr) => {
4029                 {
4030                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4031                         let mut txn = Vec::new();
4032                         for event in events {
4033                                 match event {
4034                                         Event::SpendableOutputs { ref outputs } => {
4035                                                 for outp in outputs {
4036                                                         match *outp {
4037                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4038                                                                         let input = TxIn {
4039                                                                                 previous_output: outpoint.clone(),
4040                                                                                 script_sig: Script::new(),
4041                                                                                 sequence: 0,
4042                                                                                 witness: Vec::new(),
4043                                                                         };
4044                                                                         let outp = TxOut {
4045                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4046                                                                                 value: output.value,
4047                                                                         };
4048                                                                         let mut spend_tx = Transaction {
4049                                                                                 version: 2,
4050                                                                                 lock_time: 0,
4051                                                                                 input: vec![input],
4052                                                                                 output: vec![outp],
4053                                                                         };
4054                                                                         let secp_ctx = Secp256k1::new();
4055                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4056                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4057                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4058                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4059                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4060                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4061                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4062                                                                         txn.push(spend_tx);
4063                                                                 },
4064                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4065                                                                         let input = TxIn {
4066                                                                                 previous_output: outpoint.clone(),
4067                                                                                 script_sig: Script::new(),
4068                                                                                 sequence: *to_self_delay as u32,
4069                                                                                 witness: Vec::new(),
4070                                                                         };
4071                                                                         let outp = TxOut {
4072                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4073                                                                                 value: output.value,
4074                                                                         };
4075                                                                         let mut spend_tx = Transaction {
4076                                                                                 version: 2,
4077                                                                                 lock_time: 0,
4078                                                                                 input: vec![input],
4079                                                                                 output: vec![outp],
4080                                                                         };
4081                                                                         let secp_ctx = Secp256k1::new();
4082                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4083                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4084                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4085                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4086                                                                         spend_tx.input[0].witness.push(vec!());
4087                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4088                                                                         txn.push(spend_tx);
4089                                                                 },
4090                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4091                                                                         let secp_ctx = Secp256k1::new();
4092                                                                         let input = TxIn {
4093                                                                                 previous_output: outpoint.clone(),
4094                                                                                 script_sig: Script::new(),
4095                                                                                 sequence: 0,
4096                                                                                 witness: Vec::new(),
4097                                                                         };
4098                                                                         let outp = TxOut {
4099                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4100                                                                                 value: output.value,
4101                                                                         };
4102                                                                         let mut spend_tx = Transaction {
4103                                                                                 version: 2,
4104                                                                                 lock_time: 0,
4105                                                                                 input: vec![input],
4106                                                                                 output: vec![outp.clone()],
4107                                                                         };
4108                                                                         let secret = {
4109                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4110                                                                                         Ok(master_key) => {
4111                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4112                                                                                                         Ok(key) => key,
4113                                                                                                         Err(_) => panic!("Your RNG is busted"),
4114                                                                                                 }
4115                                                                                         }
4116                                                                                         Err(_) => panic!("Your rng is busted"),
4117                                                                                 }
4118                                                                         };
4119                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4120                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4121                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4122                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4123                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4124                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4125                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4126                                                                         txn.push(spend_tx);
4127                                                                 },
4128                                                         }
4129                                                 }
4130                                         },
4131                                         _ => panic!("Unexpected event"),
4132                                 };
4133                         }
4134                         txn
4135                 }
4136         }
4137 }
4138
4139 #[test]
4140 fn test_claim_sizeable_push_msat() {
4141         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4142         let chanmon_cfgs = create_chanmon_cfgs(2);
4143         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4144         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4145         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4146
4147         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4148         nodes[1].node.force_close_channel(&chan.2);
4149         check_closed_broadcast!(nodes[1], false);
4150         check_added_monitors!(nodes[1], 1);
4151         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4152         assert_eq!(node_txn.len(), 1);
4153         check_spends!(node_txn[0], chan.3);
4154         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
4155
4156         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4157         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4158         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4159
4160         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4161         assert_eq!(spend_txn.len(), 1);
4162         check_spends!(spend_txn[0], node_txn[0]);
4163 }
4164
4165 #[test]
4166 fn test_claim_on_remote_sizeable_push_msat() {
4167         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4168         // to_remote output is encumbered by a P2WPKH
4169         let chanmon_cfgs = create_chanmon_cfgs(2);
4170         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4171         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4172         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4173
4174         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4175         nodes[0].node.force_close_channel(&chan.2);
4176         check_closed_broadcast!(nodes[0], false);
4177         check_added_monitors!(nodes[0], 1);
4178
4179         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4180         assert_eq!(node_txn.len(), 1);
4181         check_spends!(node_txn[0], chan.3);
4182         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
4183
4184         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4185         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4186         check_closed_broadcast!(nodes[1], false);
4187         check_added_monitors!(nodes[1], 1);
4188         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4189
4190         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4191         assert_eq!(spend_txn.len(), 2);
4192         assert_eq!(spend_txn[0], spend_txn[1]);
4193         check_spends!(spend_txn[0], node_txn[0]);
4194 }
4195
4196 #[test]
4197 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4198         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4199         // to_remote output is encumbered by a P2WPKH
4200
4201         let chanmon_cfgs = create_chanmon_cfgs(2);
4202         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4203         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4204         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4205
4206         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4207         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4208         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4209         assert_eq!(revoked_local_txn[0].input.len(), 1);
4210         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4211
4212         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4213         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4214         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4215         check_closed_broadcast!(nodes[1], false);
4216         check_added_monitors!(nodes[1], 1);
4217
4218         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4219         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4220         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4221         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4222
4223         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4224         assert_eq!(spend_txn.len(), 3);
4225         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4226         check_spends!(spend_txn[0], revoked_local_txn[0]);
4227         check_spends!(spend_txn[2], node_txn[0]);
4228 }
4229
4230 #[test]
4231 fn test_static_spendable_outputs_preimage_tx() {
4232         let chanmon_cfgs = create_chanmon_cfgs(2);
4233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4235         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4236
4237         // Create some initial channels
4238         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4239
4240         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4241
4242         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4243         assert_eq!(commitment_tx[0].input.len(), 1);
4244         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4245
4246         // Settle A's commitment tx on B's chain
4247         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4248         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4249         check_added_monitors!(nodes[1], 1);
4250         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4251         check_added_monitors!(nodes[1], 1);
4252         let events = nodes[1].node.get_and_clear_pending_msg_events();
4253         match events[0] {
4254                 MessageSendEvent::UpdateHTLCs { .. } => {},
4255                 _ => panic!("Unexpected event"),
4256         }
4257         match events[1] {
4258                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4259                 _ => panic!("Unexepected event"),
4260         }
4261
4262         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4263         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4264         assert_eq!(node_txn.len(), 3);
4265         check_spends!(node_txn[0], commitment_tx[0]);
4266         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4267         check_spends!(node_txn[1], chan_1.3);
4268         check_spends!(node_txn[2], node_txn[1]);
4269
4270         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4271         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4272         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4273
4274         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4275         assert_eq!(spend_txn.len(), 1);
4276         check_spends!(spend_txn[0], node_txn[0]);
4277 }
4278
4279 #[test]
4280 fn test_static_spendable_outputs_timeout_tx() {
4281         let chanmon_cfgs = create_chanmon_cfgs(2);
4282         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4283         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4284         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4285
4286         // Create some initial channels
4287         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4288
4289         // Rebalance the network a bit by relaying one payment through all the channels ...
4290         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4291
4292         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4293
4294         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4295         assert_eq!(commitment_tx[0].input.len(), 1);
4296         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4297
4298         // Settle A's commitment tx on B' chain
4299         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4300         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4301         check_added_monitors!(nodes[1], 1);
4302         let events = nodes[1].node.get_and_clear_pending_msg_events();
4303         match events[0] {
4304                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4305                 _ => panic!("Unexpected event"),
4306         }
4307
4308         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4309         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4310         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4311         check_spends!(node_txn[0],  commitment_tx[0].clone());
4312         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4313         check_spends!(node_txn[1], chan_1.3.clone());
4314         check_spends!(node_txn[2], node_txn[1]);
4315
4316         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4317         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4318         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4319         let events = nodes[1].node.get_and_clear_pending_events();
4320         assert_eq!(events.len(), 1);
4321         match events[0] {
4322                 Event::PaymentFailed { payment_hash, .. } => {
4323                         assert_eq!(payment_hash, our_payment_hash);
4324                 },
4325                 _ => panic!("Unexpected event"),
4326         }
4327
4328         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4329         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4330         check_spends!(spend_txn[2], node_txn[0].clone());
4331 }
4332
4333 #[test]
4334 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4335         let chanmon_cfgs = create_chanmon_cfgs(2);
4336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4338         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4339
4340         // Create some initial channels
4341         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4342
4343         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4344         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4345         assert_eq!(revoked_local_txn[0].input.len(), 1);
4346         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4347
4348         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4349
4350         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4351         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4352         check_closed_broadcast!(nodes[1], false);
4353         check_added_monitors!(nodes[1], 1);
4354
4355         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4356         assert_eq!(node_txn.len(), 2);
4357         assert_eq!(node_txn[0].input.len(), 2);
4358         check_spends!(node_txn[0], revoked_local_txn[0]);
4359
4360         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4361         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4362         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4363
4364         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4365         assert_eq!(spend_txn.len(), 1);
4366         check_spends!(spend_txn[0], node_txn[0]);
4367 }
4368
4369 #[test]
4370 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4371         let chanmon_cfgs = create_chanmon_cfgs(2);
4372         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4373         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4374         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4375
4376         // Create some initial channels
4377         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4378
4379         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4380         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4381         assert_eq!(revoked_local_txn[0].input.len(), 1);
4382         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4383
4384         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4385
4386         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4387         // A will generate HTLC-Timeout from revoked commitment tx
4388         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4389         check_closed_broadcast!(nodes[0], false);
4390         check_added_monitors!(nodes[0], 1);
4391
4392         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4393         assert_eq!(revoked_htlc_txn.len(), 3);
4394         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4395         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4396         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4397         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4398         check_spends!(revoked_htlc_txn[1], chan_1.3);
4399
4400         // B will generate justice tx from A's revoked commitment/HTLC tx
4401         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4402         check_closed_broadcast!(nodes[1], false);
4403         check_added_monitors!(nodes[1], 1);
4404
4405         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4406         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
4407         assert_eq!(node_txn[0].input.len(), 2);
4408         check_spends!(node_txn[0], revoked_local_txn[0]);
4409         check_spends!(node_txn[1], chan_1.3);
4410         assert_eq!(node_txn[2].input.len(), 1);
4411         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4412         assert_eq!(node_txn[3].input.len(), 1);
4413         check_spends!(node_txn[3], revoked_local_txn[0]);
4414
4415         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4416         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4417         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4418
4419         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4420         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4421         assert_eq!(spend_txn.len(), 2);
4422         check_spends!(spend_txn[0], node_txn[0]);
4423         check_spends!(spend_txn[1], node_txn[2]);
4424 }
4425
4426 #[test]
4427 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4428         let chanmon_cfgs = create_chanmon_cfgs(2);
4429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4431         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4432
4433         // Create some initial channels
4434         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4435
4436         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4437         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4438         assert_eq!(revoked_local_txn[0].input.len(), 1);
4439         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4440
4441         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4442
4443         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4444         // B will generate HTLC-Success from revoked commitment tx
4445         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4446         check_closed_broadcast!(nodes[1], false);
4447         check_added_monitors!(nodes[1], 1);
4448         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4449
4450         assert_eq!(revoked_htlc_txn.len(), 3);
4451         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4452         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4453         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4454         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4455
4456         // A will generate justice tx from B's revoked commitment/HTLC tx
4457         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4458         check_closed_broadcast!(nodes[0], false);
4459         check_added_monitors!(nodes[0], 1);
4460
4461         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4462         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4463         assert_eq!(node_txn[2].input.len(), 1);
4464         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4465
4466         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4467         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4468         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4469
4470         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4471         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4472         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4473         assert_eq!(spend_txn[0], spend_txn[1]);
4474         assert_eq!(spend_txn[0], spend_txn[2]);
4475         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4476         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4477         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4478 }
4479
4480 #[test]
4481 fn test_onchain_to_onchain_claim() {
4482         // Test that in case of channel closure, we detect the state of output thanks to
4483         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4484         // First, have C claim an HTLC against its own latest commitment transaction.
4485         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4486         // channel.
4487         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4488         // gets broadcast.
4489
4490         let chanmon_cfgs = create_chanmon_cfgs(3);
4491         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4492         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4493         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4494
4495         // Create some initial channels
4496         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4497         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4498
4499         // Rebalance the network a bit by relaying one payment through all the channels ...
4500         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4501         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4502
4503         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4504         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4505         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4506         check_spends!(commitment_tx[0], chan_2.3);
4507         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4508         check_added_monitors!(nodes[2], 1);
4509         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4510         assert!(updates.update_add_htlcs.is_empty());
4511         assert!(updates.update_fail_htlcs.is_empty());
4512         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4513         assert!(updates.update_fail_malformed_htlcs.is_empty());
4514
4515         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4516         check_closed_broadcast!(nodes[2], false);
4517         check_added_monitors!(nodes[2], 1);
4518
4519         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4520         assert_eq!(c_txn.len(), 4);
4521         assert_eq!(c_txn[0], c_txn[2]);
4522         assert_eq!(c_txn[0], c_txn[3]);
4523         assert_eq!(commitment_tx[0], c_txn[1]);
4524         check_spends!(c_txn[1], chan_2.3);
4525         check_spends!(c_txn[2], c_txn[1]);
4526         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4527         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4528         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4529         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4530
4531         // 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
4532         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4533         {
4534                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4535                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4536                 assert_eq!(b_txn.len(), 3);
4537                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4538                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4539                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4540                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4541                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4542                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4543                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4544                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4545                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4546                 b_txn.clear();
4547         }
4548         check_added_monitors!(nodes[1], 1);
4549         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4550         check_added_monitors!(nodes[1], 1);
4551         match msg_events[0] {
4552                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4553                 _ => panic!("Unexpected event"),
4554         }
4555         match msg_events[1] {
4556                 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, .. } } => {
4557                         assert!(update_add_htlcs.is_empty());
4558                         assert!(update_fail_htlcs.is_empty());
4559                         assert_eq!(update_fulfill_htlcs.len(), 1);
4560                         assert!(update_fail_malformed_htlcs.is_empty());
4561                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4562                 },
4563                 _ => panic!("Unexpected event"),
4564         };
4565         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4566         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4567         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4568         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4569         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4570         assert_eq!(b_txn.len(), 3);
4571         check_spends!(b_txn[1], chan_1.3);
4572         check_spends!(b_txn[2], b_txn[1]);
4573         check_spends!(b_txn[0], commitment_tx[0]);
4574         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4575         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4576         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4577
4578         check_closed_broadcast!(nodes[1], false);
4579         check_added_monitors!(nodes[1], 1);
4580 }
4581
4582 #[test]
4583 fn test_duplicate_payment_hash_one_failure_one_success() {
4584         // Topology : A --> B --> C
4585         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4586         let chanmon_cfgs = create_chanmon_cfgs(3);
4587         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4588         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4589         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4590
4591         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4592         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4593
4594         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4595         *nodes[0].network_payment_count.borrow_mut() -= 1;
4596         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4597
4598         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4599         assert_eq!(commitment_txn[0].input.len(), 1);
4600         check_spends!(commitment_txn[0], chan_2.3);
4601
4602         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4603         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4604         check_closed_broadcast!(nodes[1], false);
4605         check_added_monitors!(nodes[1], 1);
4606
4607         let htlc_timeout_tx;
4608         { // Extract one of the two HTLC-Timeout transaction
4609                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4610                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4611                 assert_eq!(node_txn.len(), 5);
4612                 check_spends!(node_txn[0], commitment_txn[0]);
4613                 assert_eq!(node_txn[0].input.len(), 1);
4614                 check_spends!(node_txn[1], commitment_txn[0]);
4615                 assert_eq!(node_txn[1].input.len(), 1);
4616                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4617                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4618                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4619                 check_spends!(node_txn[2], chan_2.3);
4620                 check_spends!(node_txn[3], node_txn[2]);
4621                 check_spends!(node_txn[4], node_txn[2]);
4622                 htlc_timeout_tx = node_txn[1].clone();
4623         }
4624
4625         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4626         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4627         check_added_monitors!(nodes[2], 3);
4628         let events = nodes[2].node.get_and_clear_pending_msg_events();
4629         match events[0] {
4630                 MessageSendEvent::UpdateHTLCs { .. } => {},
4631                 _ => panic!("Unexpected event"),
4632         }
4633         match events[1] {
4634                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4635                 _ => panic!("Unexepected event"),
4636         }
4637         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4638         assert_eq!(htlc_success_txn.len(), 7);
4639         check_spends!(htlc_success_txn[2], chan_2.3);
4640         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4641         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4642         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4643         assert_eq!(htlc_success_txn[0].input.len(), 1);
4644         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4645         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4646         assert_eq!(htlc_success_txn[1].input.len(), 1);
4647         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4648         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4649         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4650         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4651
4652         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4653         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4654         expect_pending_htlcs_forwardable!(nodes[1]);
4655         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4656         assert!(htlc_updates.update_add_htlcs.is_empty());
4657         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4658         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4659         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4660         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4661         check_added_monitors!(nodes[1], 1);
4662
4663         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4664         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4665         {
4666                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4667                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4668                 assert_eq!(events.len(), 1);
4669                 match events[0] {
4670                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4671                         },
4672                         _ => { panic!("Unexpected event"); }
4673                 }
4674         }
4675         let events = nodes[0].node.get_and_clear_pending_events();
4676         match events[0] {
4677                 Event::PaymentFailed { ref payment_hash, .. } => {
4678                         assert_eq!(*payment_hash, duplicate_payment_hash);
4679                 }
4680                 _ => panic!("Unexpected event"),
4681         }
4682
4683         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4684         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4685         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4686         assert!(updates.update_add_htlcs.is_empty());
4687         assert!(updates.update_fail_htlcs.is_empty());
4688         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4689         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4690         assert!(updates.update_fail_malformed_htlcs.is_empty());
4691         check_added_monitors!(nodes[1], 1);
4692
4693         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4694         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4695
4696         let events = nodes[0].node.get_and_clear_pending_events();
4697         match events[0] {
4698                 Event::PaymentSent { ref payment_preimage } => {
4699                         assert_eq!(*payment_preimage, our_payment_preimage);
4700                 }
4701                 _ => panic!("Unexpected event"),
4702         }
4703 }
4704
4705 #[test]
4706 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4707         let chanmon_cfgs = create_chanmon_cfgs(2);
4708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4710         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4711
4712         // Create some initial channels
4713         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4714
4715         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4716         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4717         assert_eq!(local_txn[0].input.len(), 1);
4718         check_spends!(local_txn[0], chan_1.3);
4719
4720         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4721         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4722         check_added_monitors!(nodes[1], 1);
4723         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4724         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4725         check_added_monitors!(nodes[1], 1);
4726         let events = nodes[1].node.get_and_clear_pending_msg_events();
4727         match events[0] {
4728                 MessageSendEvent::UpdateHTLCs { .. } => {},
4729                 _ => panic!("Unexpected event"),
4730         }
4731         match events[1] {
4732                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4733                 _ => panic!("Unexepected event"),
4734         }
4735         let node_txn = {
4736                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4737                 assert_eq!(node_txn[0].input.len(), 1);
4738                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4739                 check_spends!(node_txn[0], local_txn[0]);
4740                 vec![node_txn[0].clone(), node_txn[2].clone()]
4741         };
4742
4743         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4744         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4745         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4746
4747         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4748         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4749         assert_eq!(spend_txn.len(), 2);
4750         check_spends!(spend_txn[0], node_txn[0]);
4751         check_spends!(spend_txn[1], node_txn[1]);
4752 }
4753
4754 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4755         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4756         // unrevoked commitment transaction.
4757         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4758         // a remote RAA before they could be failed backwards (and combinations thereof).
4759         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4760         // use the same payment hashes.
4761         // Thus, we use a six-node network:
4762         //
4763         // A \         / E
4764         //    - C - D -
4765         // B /         \ F
4766         // And test where C fails back to A/B when D announces its latest commitment transaction
4767         let chanmon_cfgs = create_chanmon_cfgs(6);
4768         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4769         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4770         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4771
4772         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4773         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4774         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4775         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4776         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4777
4778         // Rebalance and check output sanity...
4779         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4780         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4781         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4782
4783         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4784         // 0th HTLC:
4785         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
4786         // 1st HTLC:
4787         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
4788         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();
4789         // 2nd HTLC:
4790         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
4791         // 3rd HTLC:
4792         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
4793         // 4th HTLC:
4794         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4795         // 5th HTLC:
4796         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4797         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4798         // 6th HTLC:
4799         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4800         // 7th HTLC:
4801         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4802
4803         // 8th HTLC:
4804         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4805         // 9th HTLC:
4806         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();
4807         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
4808
4809         // 10th HTLC:
4810         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
4811         // 11th HTLC:
4812         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4813         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4814
4815         // Double-check that six of the new HTLC were added
4816         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4817         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4818         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4819         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4820
4821         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4822         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4823         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4824         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4825         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4826         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4827         check_added_monitors!(nodes[4], 0);
4828         expect_pending_htlcs_forwardable!(nodes[4]);
4829         check_added_monitors!(nodes[4], 1);
4830
4831         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4832         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4833         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4834         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4835         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4836         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4837
4838         // Fail 3rd below-dust and 7th above-dust HTLCs
4839         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4840         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4841         check_added_monitors!(nodes[5], 0);
4842         expect_pending_htlcs_forwardable!(nodes[5]);
4843         check_added_monitors!(nodes[5], 1);
4844
4845         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4846         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4847         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4848         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4849
4850         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4851
4852         expect_pending_htlcs_forwardable!(nodes[3]);
4853         check_added_monitors!(nodes[3], 1);
4854         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4855         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4856         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4857         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4858         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4859         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4860         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4861         if deliver_last_raa {
4862                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4863         } else {
4864                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4865         }
4866
4867         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4868         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4869         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4870         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4871         //
4872         // We now broadcast the latest commitment transaction, which *should* result in failures for
4873         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4874         // the non-broadcast above-dust HTLCs.
4875         //
4876         // Alternatively, we may broadcast the previous commitment transaction, which should only
4877         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4878         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4879
4880         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4881         if announce_latest {
4882                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4883         } else {
4884                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4885         }
4886         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4887         check_closed_broadcast!(nodes[2], false);
4888         expect_pending_htlcs_forwardable!(nodes[2]);
4889         check_added_monitors!(nodes[2], 3);
4890
4891         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4892         assert_eq!(cs_msgs.len(), 2);
4893         let mut a_done = false;
4894         for msg in cs_msgs {
4895                 match msg {
4896                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4897                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4898                                 // should be failed-backwards here.
4899                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4900                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4901                                         for htlc in &updates.update_fail_htlcs {
4902                                                 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 });
4903                                         }
4904                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4905                                         assert!(!a_done);
4906                                         a_done = true;
4907                                         &nodes[0]
4908                                 } else {
4909                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4910                                         for htlc in &updates.update_fail_htlcs {
4911                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4912                                         }
4913                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4914                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4915                                         &nodes[1]
4916                                 };
4917                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4918                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4919                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4920                                 if announce_latest {
4921                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4922                                         if *node_id == nodes[0].node.get_our_node_id() {
4923                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4924                                         }
4925                                 }
4926                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4927                         },
4928                         _ => panic!("Unexpected event"),
4929                 }
4930         }
4931
4932         let as_events = nodes[0].node.get_and_clear_pending_events();
4933         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4934         let mut as_failds = HashSet::new();
4935         for event in as_events.iter() {
4936                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4937                         assert!(as_failds.insert(*payment_hash));
4938                         if *payment_hash != payment_hash_2 {
4939                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4940                         } else {
4941                                 assert!(!rejected_by_dest);
4942                         }
4943                 } else { panic!("Unexpected event"); }
4944         }
4945         assert!(as_failds.contains(&payment_hash_1));
4946         assert!(as_failds.contains(&payment_hash_2));
4947         if announce_latest {
4948                 assert!(as_failds.contains(&payment_hash_3));
4949                 assert!(as_failds.contains(&payment_hash_5));
4950         }
4951         assert!(as_failds.contains(&payment_hash_6));
4952
4953         let bs_events = nodes[1].node.get_and_clear_pending_events();
4954         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4955         let mut bs_failds = HashSet::new();
4956         for event in bs_events.iter() {
4957                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4958                         assert!(bs_failds.insert(*payment_hash));
4959                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4960                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4961                         } else {
4962                                 assert!(!rejected_by_dest);
4963                         }
4964                 } else { panic!("Unexpected event"); }
4965         }
4966         assert!(bs_failds.contains(&payment_hash_1));
4967         assert!(bs_failds.contains(&payment_hash_2));
4968         if announce_latest {
4969                 assert!(bs_failds.contains(&payment_hash_4));
4970         }
4971         assert!(bs_failds.contains(&payment_hash_5));
4972
4973         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4974         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4975         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4976         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4977         // PaymentFailureNetworkUpdates.
4978         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4979         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4980         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4981         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4982         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4983                 match event {
4984                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4985                         _ => panic!("Unexpected event"),
4986                 }
4987         }
4988 }
4989
4990 #[test]
4991 fn test_fail_backwards_latest_remote_announce_a() {
4992         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4993 }
4994
4995 #[test]
4996 fn test_fail_backwards_latest_remote_announce_b() {
4997         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4998 }
4999
5000 #[test]
5001 fn test_fail_backwards_previous_remote_announce() {
5002         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5003         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5004         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5005 }
5006
5007 #[test]
5008 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5009         let chanmon_cfgs = create_chanmon_cfgs(2);
5010         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5011         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5012         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5013
5014         // Create some initial channels
5015         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5016
5017         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5018         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5019         assert_eq!(local_txn[0].input.len(), 1);
5020         check_spends!(local_txn[0], chan_1.3);
5021
5022         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5023         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5024         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5025         check_closed_broadcast!(nodes[0], false);
5026         check_added_monitors!(nodes[0], 1);
5027
5028         let htlc_timeout = {
5029                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5030                 assert_eq!(node_txn[0].input.len(), 1);
5031                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5032                 check_spends!(node_txn[0], local_txn[0]);
5033                 node_txn[0].clone()
5034         };
5035
5036         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5037         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5038         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5039         let events = nodes[0].node.get_and_clear_pending_events();
5040         assert_eq!(events.len(), 1);
5041         match events[0] {
5042                 Event::PaymentFailed { payment_hash, .. } => {
5043                         assert_eq!(payment_hash, our_payment_hash);
5044                 },
5045                 _ => panic!("Unexpected event"),
5046         }
5047
5048         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5049         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5050         assert_eq!(spend_txn.len(), 3);
5051         assert_eq!(spend_txn[0], spend_txn[1]);
5052         check_spends!(spend_txn[0], local_txn[0]);
5053         check_spends!(spend_txn[2], htlc_timeout);
5054 }
5055
5056 #[test]
5057 fn test_static_output_closing_tx() {
5058         let chanmon_cfgs = create_chanmon_cfgs(2);
5059         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5060         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5061         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5062
5063         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5064
5065         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5066         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5067
5068         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5069         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5070         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5071
5072         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5073         assert_eq!(spend_txn.len(), 1);
5074         check_spends!(spend_txn[0], closing_tx);
5075
5076         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5077         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5078
5079         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5080         assert_eq!(spend_txn.len(), 1);
5081         check_spends!(spend_txn[0], closing_tx);
5082 }
5083
5084 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5085         let chanmon_cfgs = create_chanmon_cfgs(2);
5086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5088         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5089         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5090
5091         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5092
5093         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5094         // present in B's local commitment transaction, but none of A's commitment transactions.
5095         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5096         check_added_monitors!(nodes[1], 1);
5097
5098         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5099         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5100         let events = nodes[0].node.get_and_clear_pending_events();
5101         assert_eq!(events.len(), 1);
5102         match events[0] {
5103                 Event::PaymentSent { payment_preimage } => {
5104                         assert_eq!(payment_preimage, our_payment_preimage);
5105                 },
5106                 _ => panic!("Unexpected event"),
5107         }
5108
5109         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5110         check_added_monitors!(nodes[0], 1);
5111         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5112         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5113         check_added_monitors!(nodes[1], 1);
5114
5115         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5116         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5117                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5118                 header.prev_blockhash = header.bitcoin_hash();
5119         }
5120         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5121         check_closed_broadcast!(nodes[1], false);
5122         check_added_monitors!(nodes[1], 1);
5123 }
5124
5125 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5126         let chanmon_cfgs = create_chanmon_cfgs(2);
5127         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5128         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5129         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5130         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5131
5132         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();
5133         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5134         nodes[0].node.send_payment(route, payment_hash, &None).unwrap();
5135         check_added_monitors!(nodes[0], 1);
5136
5137         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5138
5139         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5140         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5141         // to "time out" the HTLC.
5142
5143         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5144
5145         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5146                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5147                 header.prev_blockhash = header.bitcoin_hash();
5148         }
5149         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5150         check_closed_broadcast!(nodes[0], false);
5151         check_added_monitors!(nodes[0], 1);
5152 }
5153
5154 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5155         let chanmon_cfgs = create_chanmon_cfgs(3);
5156         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5157         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5158         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5159         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5160
5161         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5162         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5163         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5164         // actually revoked.
5165         let htlc_value = if use_dust { 50000 } else { 3000000 };
5166         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5167         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5168         expect_pending_htlcs_forwardable!(nodes[1]);
5169         check_added_monitors!(nodes[1], 1);
5170
5171         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5172         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5173         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5174         check_added_monitors!(nodes[0], 1);
5175         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5176         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5177         check_added_monitors!(nodes[1], 1);
5178         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5179         check_added_monitors!(nodes[1], 1);
5180         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5181
5182         if check_revoke_no_close {
5183                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5184                 check_added_monitors!(nodes[0], 1);
5185         }
5186
5187         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5188         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5189                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5190                 header.prev_blockhash = header.bitcoin_hash();
5191         }
5192         if !check_revoke_no_close {
5193                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5194                 check_closed_broadcast!(nodes[0], false);
5195                 check_added_monitors!(nodes[0], 1);
5196         } else {
5197                 let events = nodes[0].node.get_and_clear_pending_events();
5198                 assert_eq!(events.len(), 1);
5199                 match events[0] {
5200                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5201                                 assert_eq!(payment_hash, our_payment_hash);
5202                                 assert!(rejected_by_dest);
5203                         },
5204                         _ => panic!("Unexpected event"),
5205                 }
5206         }
5207 }
5208
5209 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5210 // There are only a few cases to test here:
5211 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5212 //    broadcastable commitment transactions result in channel closure,
5213 //  * its included in an unrevoked-but-previous remote commitment transaction,
5214 //  * its included in the latest remote or local commitment transactions.
5215 // We test each of the three possible commitment transactions individually and use both dust and
5216 // non-dust HTLCs.
5217 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5218 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5219 // tested for at least one of the cases in other tests.
5220 #[test]
5221 fn htlc_claim_single_commitment_only_a() {
5222         do_htlc_claim_local_commitment_only(true);
5223         do_htlc_claim_local_commitment_only(false);
5224
5225         do_htlc_claim_current_remote_commitment_only(true);
5226         do_htlc_claim_current_remote_commitment_only(false);
5227 }
5228
5229 #[test]
5230 fn htlc_claim_single_commitment_only_b() {
5231         do_htlc_claim_previous_remote_commitment_only(true, false);
5232         do_htlc_claim_previous_remote_commitment_only(false, false);
5233         do_htlc_claim_previous_remote_commitment_only(true, true);
5234         do_htlc_claim_previous_remote_commitment_only(false, true);
5235 }
5236
5237 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>)
5238         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5239                                 F2: FnMut(),
5240 {
5241         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);
5242 }
5243
5244 // test_case
5245 // 0: node1 fails backward
5246 // 1: final node fails backward
5247 // 2: payment completed but the user rejects the payment
5248 // 3: final node fails backward (but tamper onion payloads from node0)
5249 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5250 // 200: trigger error in the final node and tamper returning fail_htlc
5251 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>)
5252         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5253                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5254                                 F3: FnMut(),
5255 {
5256
5257         // reset block height
5258         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5259         for ix in 0..nodes.len() {
5260                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5261         }
5262
5263         macro_rules! expect_event {
5264                 ($node: expr, $event_type: path) => {{
5265                         let events = $node.node.get_and_clear_pending_events();
5266                         assert_eq!(events.len(), 1);
5267                         match events[0] {
5268                                 $event_type { .. } => {},
5269                                 _ => panic!("Unexpected event"),
5270                         }
5271                 }}
5272         }
5273
5274         macro_rules! expect_htlc_forward {
5275                 ($node: expr) => {{
5276                         expect_event!($node, Event::PendingHTLCsForwardable);
5277                         $node.node.process_pending_htlc_forwards();
5278                 }}
5279         }
5280
5281         // 0 ~~> 2 send payment
5282         nodes[0].node.send_payment(route.clone(), payment_hash.clone(), &None).unwrap();
5283         check_added_monitors!(nodes[0], 1);
5284         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5285         // temper update_add (0 => 1)
5286         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5287         if test_case == 0 || test_case == 3 || test_case == 100 {
5288                 callback_msg(&mut update_add_0);
5289                 callback_node();
5290         }
5291         // 0 => 1 update_add & CS
5292         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5293         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5294
5295         let update_1_0 = match test_case {
5296                 0|100 => { // intermediate node failure; fail backward to 0
5297                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5298                         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));
5299                         update_1_0
5300                 },
5301                 1|2|3|200 => { // final node failure; forwarding to 2
5302                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5303                         // forwarding on 1
5304                         if test_case != 200 {
5305                                 callback_node();
5306                         }
5307                         expect_htlc_forward!(&nodes[1]);
5308
5309                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5310                         check_added_monitors!(&nodes[1], 1);
5311                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5312                         // tamper update_add (1 => 2)
5313                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5314                         if test_case != 3 && test_case != 200 {
5315                                 callback_msg(&mut update_add_1);
5316                         }
5317
5318                         // 1 => 2
5319                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5320                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5321
5322                         if test_case == 2 || test_case == 200 {
5323                                 expect_htlc_forward!(&nodes[2]);
5324                                 expect_event!(&nodes[2], Event::PaymentReceived);
5325                                 callback_node();
5326                                 expect_pending_htlcs_forwardable!(nodes[2]);
5327                         }
5328
5329                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5330                         if test_case == 2 || test_case == 200 {
5331                                 check_added_monitors!(&nodes[2], 1);
5332                         }
5333                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5334
5335                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5336                         if test_case == 200 {
5337                                 callback_fail(&mut fail_msg);
5338                         }
5339
5340                         // 2 => 1
5341                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5342                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5343
5344                         // backward fail on 1
5345                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5346                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5347                         update_1_0
5348                 },
5349                 _ => unreachable!(),
5350         };
5351
5352         // 1 => 0 commitment_signed_dance
5353         if update_1_0.update_fail_htlcs.len() > 0 {
5354                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5355                 if test_case == 100 {
5356                         callback_fail(&mut fail_msg);
5357                 }
5358                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5359         } else {
5360                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5361         };
5362
5363         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5364
5365         let events = nodes[0].node.get_and_clear_pending_events();
5366         assert_eq!(events.len(), 1);
5367         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5368                 assert_eq!(*rejected_by_dest, !expected_retryable);
5369                 assert_eq!(*error_code, expected_error_code);
5370         } else {
5371                 panic!("Uexpected event");
5372         }
5373
5374         let events = nodes[0].node.get_and_clear_pending_msg_events();
5375         if expected_channel_update.is_some() {
5376                 assert_eq!(events.len(), 1);
5377                 match events[0] {
5378                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5379                                 match update {
5380                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5381                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5382                                                         panic!("channel_update not found!");
5383                                                 }
5384                                         },
5385                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5386                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5387                                                         assert!(*short_channel_id == *expected_short_channel_id);
5388                                                         assert!(*is_permanent == *expected_is_permanent);
5389                                                 } else {
5390                                                         panic!("Unexpected message event");
5391                                                 }
5392                                         },
5393                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5394                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5395                                                         assert!(*node_id == *expected_node_id);
5396                                                         assert!(*is_permanent == *expected_is_permanent);
5397                                                 } else {
5398                                                         panic!("Unexpected message event");
5399                                                 }
5400                                         },
5401                                 }
5402                         },
5403                         _ => panic!("Unexpected message event"),
5404                 }
5405         } else {
5406                 assert_eq!(events.len(), 0);
5407         }
5408 }
5409
5410 impl msgs::ChannelUpdate {
5411         fn dummy() -> msgs::ChannelUpdate {
5412                 use secp256k1::ffi::Signature as FFISignature;
5413                 use secp256k1::Signature;
5414                 msgs::ChannelUpdate {
5415                         signature: Signature::from(FFISignature::new()),
5416                         contents: msgs::UnsignedChannelUpdate {
5417                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5418                                 short_channel_id: 0,
5419                                 timestamp: 0,
5420                                 flags: 0,
5421                                 cltv_expiry_delta: 0,
5422                                 htlc_minimum_msat: 0,
5423                                 fee_base_msat: 0,
5424                                 fee_proportional_millionths: 0,
5425                                 excess_data: vec![],
5426                         }
5427                 }
5428         }
5429 }
5430
5431 struct BogusOnionHopData {
5432         data: Vec<u8>
5433 }
5434 impl BogusOnionHopData {
5435         fn new(orig: msgs::OnionHopData) -> Self {
5436                 Self { data: orig.encode() }
5437         }
5438 }
5439 impl Writeable for BogusOnionHopData {
5440         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5441                 writer.write_all(&self.data[..])
5442         }
5443 }
5444
5445 #[test]
5446 fn test_onion_failure() {
5447         use ln::msgs::ChannelUpdate;
5448         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5449         use secp256k1;
5450
5451         const BADONION: u16 = 0x8000;
5452         const PERM: u16 = 0x4000;
5453         const NODE: u16 = 0x2000;
5454         const UPDATE: u16 = 0x1000;
5455
5456         let chanmon_cfgs = create_chanmon_cfgs(3);
5457         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5458         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5459         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5460         for node in nodes.iter() {
5461                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5462         }
5463         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())];
5464         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5465         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5466         // positve case
5467         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5468
5469         // intermediate node failure
5470         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5471                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5472                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5473                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5474                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, &None, cur_height).unwrap();
5475                 let mut new_payloads = Vec::new();
5476                 for payload in onion_payloads.drain(..) {
5477                         new_payloads.push(BogusOnionHopData::new(payload));
5478                 }
5479                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5480                 // describing a length-1 TLV payload, which is obviously bogus.
5481                 new_payloads[0].data[0] = 1;
5482                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5483         }, ||{}, 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
5484
5485         // final node failure
5486         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5487                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5488                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5489                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5490                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, &None, cur_height).unwrap();
5491                 let mut new_payloads = Vec::new();
5492                 for payload in onion_payloads.drain(..) {
5493                         new_payloads.push(BogusOnionHopData::new(payload));
5494                 }
5495                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5496                 // length-1 TLV payload, which is obviously bogus.
5497                 new_payloads[1].data[0] = 1;
5498                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5499         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5500
5501         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5502         // receiving simulated fail messages
5503         // intermediate node failure
5504         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5505                 // trigger error
5506                 msg.amount_msat -= 1;
5507         }, |msg| {
5508                 // and tamper returning error message
5509                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5510                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5511                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5512         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5513
5514         // final node failure
5515         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5516                 // and tamper returning error message
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[1].shared_secret[..], NODE|2, &[0;0]);
5520         }, ||{
5521                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5522         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5523
5524         // intermediate node failure
5525         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5526                 msg.amount_msat -= 1;
5527         }, |msg| {
5528                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5529                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5530                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5531         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5532
5533         // final node failure
5534         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5535                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5536                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5537                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5538         }, ||{
5539                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5540         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5541
5542         // intermediate node failure
5543         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5544                 msg.amount_msat -= 1;
5545         }, |msg| {
5546                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5547                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5548                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5549         }, ||{
5550                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5551         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5552
5553         // final node failure
5554         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5555                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5556                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5557                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5558         }, ||{
5559                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5560         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5561
5562         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5563                 Some(BADONION|PERM|4), None);
5564
5565         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5566                 Some(BADONION|PERM|5), None);
5567
5568         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5569                 Some(BADONION|PERM|6), None);
5570
5571         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5572                 msg.amount_msat -= 1;
5573         }, |msg| {
5574                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5575                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5576                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5577         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5578
5579         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5580                 msg.amount_msat -= 1;
5581         }, |msg| {
5582                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5583                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5584                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5585                 // short_channel_id from the processing node
5586         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5587
5588         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5589                 msg.amount_msat -= 1;
5590         }, |msg| {
5591                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5592                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5593                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5594                 // short_channel_id from the processing node
5595         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5596
5597         let mut bogus_route = route.clone();
5598         bogus_route.hops[1].short_channel_id -= 1;
5599         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5600           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5601
5602         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5603         let mut bogus_route = route.clone();
5604         let route_len = bogus_route.hops.len();
5605         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5606         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5607
5608         //TODO: with new config API, we will be able to generate both valid and
5609         //invalid channel_update cases.
5610         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5611                 msg.amount_msat -= 1;
5612         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5613
5614         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5615                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5616                 msg.cltv_expiry -= 1;
5617         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5618
5619         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5620                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5621                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5622
5623                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5624         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5625
5626         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5627                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5628         }, false, Some(PERM|15), None);
5629
5630         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5631                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5632                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5633
5634                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5635         }, || {}, true, Some(17), None);
5636
5637         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5638                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5639                         for f in pending_forwards.iter_mut() {
5640                                 match f {
5641                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5642                                                 forward_info.outgoing_cltv_value += 1,
5643                                         _ => {},
5644                                 }
5645                         }
5646                 }
5647         }, true, Some(18), None);
5648
5649         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5650                 // violate amt_to_forward > msg.amount_msat
5651                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5652                         for f in pending_forwards.iter_mut() {
5653                                 match f {
5654                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5655                                                 forward_info.amt_to_forward -= 1,
5656                                         _ => {},
5657                                 }
5658                         }
5659                 }
5660         }, true, Some(19), None);
5661
5662         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5663                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5664                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5665                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5666         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5667         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5668
5669         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5670                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5671                 let mut route = route.clone();
5672                 let height = 1;
5673                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5674                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5675                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, &None, height).unwrap();
5676                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5677                 msg.cltv_expiry = htlc_cltv;
5678                 msg.onion_routing_packet = onion_packet;
5679         }, ||{}, true, Some(21), None);
5680 }
5681
5682 #[test]
5683 #[should_panic]
5684 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5685         let chanmon_cfgs = create_chanmon_cfgs(2);
5686         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5687         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5688         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5689         //Force duplicate channel ids
5690         for node in nodes.iter() {
5691                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5692         }
5693
5694         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5695         let channel_value_satoshis=10000;
5696         let push_msat=10001;
5697         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5698         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5699         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5700
5701         //Create a second channel with a channel_id collision
5702         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5703 }
5704
5705 #[test]
5706 fn bolt2_open_channel_sending_node_checks_part2() {
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5711
5712         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5713         let channel_value_satoshis=2^24;
5714         let push_msat=10001;
5715         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5716
5717         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5718         let channel_value_satoshis=10000;
5719         // Test when push_msat is equal to 1000 * funding_satoshis.
5720         let push_msat=1000*channel_value_satoshis+1;
5721         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5722
5723         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5724         let channel_value_satoshis=10000;
5725         let push_msat=10001;
5726         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
5727         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5728         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5729
5730         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5731         // 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
5732         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5733
5734         // 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.
5735         assert!(BREAKDOWN_TIMEOUT>0);
5736         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5737
5738         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5739         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5740         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5741
5742         // 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.
5743         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5744         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5745         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5746         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5747         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5748 }
5749
5750 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5751 // 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.
5752 //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.
5753
5754 #[test]
5755 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5756         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5757         let chanmon_cfgs = create_chanmon_cfgs(2);
5758         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5759         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5760         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5761         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5762         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5763         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5764
5765         route.hops[0].fee_msat = 100;
5766
5767         let err = nodes[0].node.send_payment(route, our_payment_hash, &None);
5768
5769         if let Err(APIError::ChannelUnavailable{err}) = err {
5770                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5771         } else {
5772                 assert!(false);
5773         }
5774         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5775         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5776 }
5777
5778 #[test]
5779 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5780         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5781         let chanmon_cfgs = create_chanmon_cfgs(2);
5782         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5783         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5784         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5785         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5786         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5787         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5788
5789         route.hops[0].fee_msat = 0;
5790
5791         let err = nodes[0].node.send_payment(route, our_payment_hash, &None);
5792
5793         if let Err(APIError::ChannelUnavailable{err}) = err {
5794                 assert_eq!(err, "Cannot send 0-msat HTLC");
5795         } else {
5796                 assert!(false);
5797         }
5798         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5799         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5800 }
5801
5802 #[test]
5803 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5804         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5805         let chanmon_cfgs = create_chanmon_cfgs(2);
5806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5809         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5810         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5811         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5812
5813         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
5814         check_added_monitors!(nodes[0], 1);
5815         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5816         updates.update_add_htlcs[0].amount_msat = 0;
5817
5818         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5819         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5820         check_closed_broadcast!(nodes[1], true).unwrap();
5821         check_added_monitors!(nodes[1], 1);
5822 }
5823
5824 #[test]
5825 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5826         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5827         //It is enforced when constructing a route.
5828         let chanmon_cfgs = create_chanmon_cfgs(2);
5829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5831         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5832         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5833         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5834         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5835
5836         let err = nodes[0].node.send_payment(route, our_payment_hash, &None);
5837
5838         if let Err(APIError::RouteError{err}) = err {
5839                 assert_eq!(err, "Channel CLTV overflowed?!");
5840         } else {
5841                 assert!(false);
5842         }
5843 }
5844
5845 #[test]
5846 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5847         //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.
5848         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5849         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5850         let chanmon_cfgs = create_chanmon_cfgs(2);
5851         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5852         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5853         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5854         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5855         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5856
5857         for i in 0..max_accepted_htlcs {
5858                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5859                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5860                 let payment_event = {
5861                         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
5862                         check_added_monitors!(nodes[0], 1);
5863
5864                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5865                         assert_eq!(events.len(), 1);
5866                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5867                                 assert_eq!(htlcs[0].htlc_id, i);
5868                         } else {
5869                                 assert!(false);
5870                         }
5871                         SendEvent::from_event(events.remove(0))
5872                 };
5873                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5874                 check_added_monitors!(nodes[1], 0);
5875                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5876
5877                 expect_pending_htlcs_forwardable!(nodes[1]);
5878                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5879         }
5880         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5881         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5882         let err = nodes[0].node.send_payment(route, our_payment_hash, &None);
5883
5884         if let Err(APIError::ChannelUnavailable{err}) = err {
5885                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5886         } else {
5887                 assert!(false);
5888         }
5889         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5890         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5891 }
5892
5893 #[test]
5894 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5895         //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.
5896         let chanmon_cfgs = create_chanmon_cfgs(2);
5897         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5898         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5899         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5900         let channel_value = 100000;
5901         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5902         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5903
5904         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5905
5906         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5907         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5908         let err = nodes[0].node.send_payment(route, our_payment_hash, &None);
5909
5910         if let Err(APIError::ChannelUnavailable{err}) = err {
5911                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5912         } else {
5913                 assert!(false);
5914         }
5915         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5916         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);
5917
5918         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5919 }
5920
5921 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5922 #[test]
5923 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5924         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5925         let chanmon_cfgs = create_chanmon_cfgs(2);
5926         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5927         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5928         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5929         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5930         let htlc_minimum_msat: u64;
5931         {
5932                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5933                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5934                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5935         }
5936         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5937         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5938         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
5939         check_added_monitors!(nodes[0], 1);
5940         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5941         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5942         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5943         assert!(nodes[1].node.list_channels().is_empty());
5944         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5945         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5946         check_added_monitors!(nodes[1], 1);
5947 }
5948
5949 #[test]
5950 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5951         //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
5952         let chanmon_cfgs = create_chanmon_cfgs(2);
5953         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5954         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5955         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5956         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5957
5958         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5959
5960         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5961         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5962         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
5963         check_added_monitors!(nodes[0], 1);
5964         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5965
5966         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5967         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5968
5969         assert!(nodes[1].node.list_channels().is_empty());
5970         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5971         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5972         check_added_monitors!(nodes[1], 1);
5973 }
5974
5975 #[test]
5976 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5977         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5978         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5979         let chanmon_cfgs = create_chanmon_cfgs(2);
5980         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5981         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5982         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5983         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5984         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5985         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5986
5987         let session_priv = SecretKey::from_slice(&{
5988                 let mut session_key = [0; 32];
5989                 let mut rng = thread_rng();
5990                 rng.fill_bytes(&mut session_key);
5991                 session_key
5992         }).expect("RNG is bad!");
5993
5994         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5995         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5996         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, &None, cur_height).unwrap();
5997         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5998
5999         let mut msg = msgs::UpdateAddHTLC {
6000                 channel_id: chan.2,
6001                 htlc_id: 0,
6002                 amount_msat: 1000,
6003                 payment_hash: our_payment_hash,
6004                 cltv_expiry: htlc_cltv,
6005                 onion_routing_packet: onion_packet.clone(),
6006         };
6007
6008         for i in 0..super::channel::OUR_MAX_HTLCS {
6009                 msg.htlc_id = i as u64;
6010                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6011         }
6012         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6013         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6014
6015         assert!(nodes[1].node.list_channels().is_empty());
6016         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6017         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
6018         check_added_monitors!(nodes[1], 1);
6019 }
6020
6021 #[test]
6022 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6023         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6024         let chanmon_cfgs = create_chanmon_cfgs(2);
6025         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6026         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6027         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6028         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6029         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6030         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6031         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6032         check_added_monitors!(nodes[0], 1);
6033         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6034         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6035         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6036
6037         assert!(nodes[1].node.list_channels().is_empty());
6038         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6039         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6040         check_added_monitors!(nodes[1], 1);
6041 }
6042
6043 #[test]
6044 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6045         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6046         let chanmon_cfgs = create_chanmon_cfgs(2);
6047         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6048         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6049         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6050         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
6051         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
6052         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6053         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6054         check_added_monitors!(nodes[0], 1);
6055         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6056         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6057         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6058
6059         assert!(nodes[1].node.list_channels().is_empty());
6060         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6061         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6062         check_added_monitors!(nodes[1], 1);
6063 }
6064
6065 #[test]
6066 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6067         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6068         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6069         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6070         let chanmon_cfgs = create_chanmon_cfgs(2);
6071         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6072         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6073         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6074         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6075         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6076         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6077         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6078         check_added_monitors!(nodes[0], 1);
6079         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6080         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6081
6082         //Disconnect and Reconnect
6083         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6084         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6085         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6086         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6087         assert_eq!(reestablish_1.len(), 1);
6088         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6089         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6090         assert_eq!(reestablish_2.len(), 1);
6091         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6092         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6093         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6094         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6095
6096         //Resend HTLC
6097         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6098         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6099         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6100         check_added_monitors!(nodes[1], 1);
6101         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6102
6103         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6104
6105         assert!(nodes[1].node.list_channels().is_empty());
6106         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6107         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6108         check_added_monitors!(nodes[1], 1);
6109 }
6110
6111 #[test]
6112 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6113         //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.
6114
6115         let chanmon_cfgs = create_chanmon_cfgs(2);
6116         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6117         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6118         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6119         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6120
6121         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6122         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6123         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6124         check_added_monitors!(nodes[0], 1);
6125         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6126         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6127
6128         let update_msg = msgs::UpdateFulfillHTLC{
6129                 channel_id: chan.2,
6130                 htlc_id: 0,
6131                 payment_preimage: our_payment_preimage,
6132         };
6133
6134         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6135
6136         assert!(nodes[0].node.list_channels().is_empty());
6137         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6138         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6139         check_added_monitors!(nodes[0], 1);
6140 }
6141
6142 #[test]
6143 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6144         //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.
6145
6146         let chanmon_cfgs = create_chanmon_cfgs(2);
6147         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6148         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6149         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6150         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6151
6152         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6153         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6154         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6155         check_added_monitors!(nodes[0], 1);
6156         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6157         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6158
6159         let update_msg = msgs::UpdateFailHTLC{
6160                 channel_id: chan.2,
6161                 htlc_id: 0,
6162                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6163         };
6164
6165         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6166
6167         assert!(nodes[0].node.list_channels().is_empty());
6168         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6169         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6170         check_added_monitors!(nodes[0], 1);
6171 }
6172
6173 #[test]
6174 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6175         //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.
6176
6177         let chanmon_cfgs = create_chanmon_cfgs(2);
6178         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6179         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6180         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6181         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6182
6183         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6184         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6185         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6186         check_added_monitors!(nodes[0], 1);
6187         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6188         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6189
6190         let update_msg = msgs::UpdateFailMalformedHTLC{
6191                 channel_id: chan.2,
6192                 htlc_id: 0,
6193                 sha256_of_onion: [1; 32],
6194                 failure_code: 0x8000,
6195         };
6196
6197         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6198
6199         assert!(nodes[0].node.list_channels().is_empty());
6200         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6201         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6202         check_added_monitors!(nodes[0], 1);
6203 }
6204
6205 #[test]
6206 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6207         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6208
6209         let chanmon_cfgs = create_chanmon_cfgs(2);
6210         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6211         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6212         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6213         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6214
6215         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6216
6217         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6218         check_added_monitors!(nodes[1], 1);
6219
6220         let events = nodes[1].node.get_and_clear_pending_msg_events();
6221         assert_eq!(events.len(), 1);
6222         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6223                 match events[0] {
6224                         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, .. } } => {
6225                                 assert!(update_add_htlcs.is_empty());
6226                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6227                                 assert!(update_fail_htlcs.is_empty());
6228                                 assert!(update_fail_malformed_htlcs.is_empty());
6229                                 assert!(update_fee.is_none());
6230                                 update_fulfill_htlcs[0].clone()
6231                         },
6232                         _ => panic!("Unexpected event"),
6233                 }
6234         };
6235
6236         update_fulfill_msg.htlc_id = 1;
6237
6238         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6239
6240         assert!(nodes[0].node.list_channels().is_empty());
6241         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6242         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6243         check_added_monitors!(nodes[0], 1);
6244 }
6245
6246 #[test]
6247 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6248         //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.
6249
6250         let chanmon_cfgs = create_chanmon_cfgs(2);
6251         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6252         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6253         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6254         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6255
6256         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6257
6258         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6259         check_added_monitors!(nodes[1], 1);
6260
6261         let events = nodes[1].node.get_and_clear_pending_msg_events();
6262         assert_eq!(events.len(), 1);
6263         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6264                 match events[0] {
6265                         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, .. } } => {
6266                                 assert!(update_add_htlcs.is_empty());
6267                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6268                                 assert!(update_fail_htlcs.is_empty());
6269                                 assert!(update_fail_malformed_htlcs.is_empty());
6270                                 assert!(update_fee.is_none());
6271                                 update_fulfill_htlcs[0].clone()
6272                         },
6273                         _ => panic!("Unexpected event"),
6274                 }
6275         };
6276
6277         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6278
6279         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6280
6281         assert!(nodes[0].node.list_channels().is_empty());
6282         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6283         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6284         check_added_monitors!(nodes[0], 1);
6285 }
6286
6287 #[test]
6288 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6289         //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.
6290
6291         let chanmon_cfgs = create_chanmon_cfgs(2);
6292         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6293         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6294         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6295         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6296         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6297         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6298         nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6299         check_added_monitors!(nodes[0], 1);
6300
6301         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6302         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6303
6304         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6305         check_added_monitors!(nodes[1], 0);
6306         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6307
6308         let events = nodes[1].node.get_and_clear_pending_msg_events();
6309
6310         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6311                 match events[0] {
6312                         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, .. } } => {
6313                                 assert!(update_add_htlcs.is_empty());
6314                                 assert!(update_fulfill_htlcs.is_empty());
6315                                 assert!(update_fail_htlcs.is_empty());
6316                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6317                                 assert!(update_fee.is_none());
6318                                 update_fail_malformed_htlcs[0].clone()
6319                         },
6320                         _ => panic!("Unexpected event"),
6321                 }
6322         };
6323         update_msg.failure_code &= !0x8000;
6324         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6325
6326         assert!(nodes[0].node.list_channels().is_empty());
6327         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6328         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6329         check_added_monitors!(nodes[0], 1);
6330 }
6331
6332 #[test]
6333 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6334         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6335         //    * 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.
6336
6337         let chanmon_cfgs = create_chanmon_cfgs(3);
6338         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6339         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6340         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6341         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6342         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6343
6344         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6345         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6346
6347         //First hop
6348         let mut payment_event = {
6349                 nodes[0].node.send_payment(route, our_payment_hash, &None).unwrap();
6350                 check_added_monitors!(nodes[0], 1);
6351                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6352                 assert_eq!(events.len(), 1);
6353                 SendEvent::from_event(events.remove(0))
6354         };
6355         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6356         check_added_monitors!(nodes[1], 0);
6357         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6358         expect_pending_htlcs_forwardable!(nodes[1]);
6359         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6360         assert_eq!(events_2.len(), 1);
6361         check_added_monitors!(nodes[1], 1);
6362         payment_event = SendEvent::from_event(events_2.remove(0));
6363         assert_eq!(payment_event.msgs.len(), 1);
6364
6365         //Second Hop
6366         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6367         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6368         check_added_monitors!(nodes[2], 0);
6369         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6370
6371         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6372         assert_eq!(events_3.len(), 1);
6373         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6374                 match events_3[0] {
6375                         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 } } => {
6376                                 assert!(update_add_htlcs.is_empty());
6377                                 assert!(update_fulfill_htlcs.is_empty());
6378                                 assert!(update_fail_htlcs.is_empty());
6379                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6380                                 assert!(update_fee.is_none());
6381                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6382                         },
6383                         _ => panic!("Unexpected event"),
6384                 }
6385         };
6386
6387         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6388
6389         check_added_monitors!(nodes[1], 0);
6390         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6391         expect_pending_htlcs_forwardable!(nodes[1]);
6392         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6393         assert_eq!(events_4.len(), 1);
6394
6395         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6396         match events_4[0] {
6397                 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, .. } } => {
6398                         assert!(update_add_htlcs.is_empty());
6399                         assert!(update_fulfill_htlcs.is_empty());
6400                         assert_eq!(update_fail_htlcs.len(), 1);
6401                         assert!(update_fail_malformed_htlcs.is_empty());
6402                         assert!(update_fee.is_none());
6403                 },
6404                 _ => panic!("Unexpected event"),
6405         };
6406
6407         check_added_monitors!(nodes[1], 1);
6408 }
6409
6410 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6411         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6412         // 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
6413         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6414
6415         let chanmon_cfgs = create_chanmon_cfgs(2);
6416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6419         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6420
6421         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6422
6423         // We route 2 dust-HTLCs between A and B
6424         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6425         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6426         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6427
6428         // Cache one local commitment tx as previous
6429         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6430
6431         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6432         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6433         check_added_monitors!(nodes[1], 0);
6434         expect_pending_htlcs_forwardable!(nodes[1]);
6435         check_added_monitors!(nodes[1], 1);
6436
6437         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6438         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6439         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6440         check_added_monitors!(nodes[0], 1);
6441
6442         // Cache one local commitment tx as lastest
6443         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6444
6445         let events = nodes[0].node.get_and_clear_pending_msg_events();
6446         match events[0] {
6447                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6448                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6449                 },
6450                 _ => panic!("Unexpected event"),
6451         }
6452         match events[1] {
6453                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6454                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6455                 },
6456                 _ => panic!("Unexpected event"),
6457         }
6458
6459         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6460         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6461         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6462
6463         if announce_latest {
6464                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6465         } else {
6466                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6467         }
6468
6469         check_closed_broadcast!(nodes[0], false);
6470         check_added_monitors!(nodes[0], 1);
6471
6472         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6473         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6474         let events = nodes[0].node.get_and_clear_pending_events();
6475         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6476         assert_eq!(events.len(), 2);
6477         let mut first_failed = false;
6478         for event in events {
6479                 match event {
6480                         Event::PaymentFailed { payment_hash, .. } => {
6481                                 if payment_hash == payment_hash_1 {
6482                                         assert!(!first_failed);
6483                                         first_failed = true;
6484                                 } else {
6485                                         assert_eq!(payment_hash, payment_hash_2);
6486                                 }
6487                         }
6488                         _ => panic!("Unexpected event"),
6489                 }
6490         }
6491 }
6492
6493 #[test]
6494 fn test_failure_delay_dust_htlc_local_commitment() {
6495         do_test_failure_delay_dust_htlc_local_commitment(true);
6496         do_test_failure_delay_dust_htlc_local_commitment(false);
6497 }
6498
6499 #[test]
6500 fn test_no_failure_dust_htlc_local_commitment() {
6501         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6502         // prone to error, we test here that a dummy transaction don't fail them.
6503
6504         let chanmon_cfgs = create_chanmon_cfgs(2);
6505         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6506         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6507         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6508         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6509
6510         // Rebalance a bit
6511         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6512
6513         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6514         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6515
6516         // We route 2 dust-HTLCs between A and B
6517         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6518         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6519
6520         // Build a dummy invalid transaction trying to spend a commitment tx
6521         let input = TxIn {
6522                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6523                 script_sig: Script::new(),
6524                 sequence: 0,
6525                 witness: Vec::new(),
6526         };
6527
6528         let outp = TxOut {
6529                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6530                 value: 10000,
6531         };
6532
6533         let dummy_tx = Transaction {
6534                 version: 2,
6535                 lock_time: 0,
6536                 input: vec![input],
6537                 output: vec![outp]
6538         };
6539
6540         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6541         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6542         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6543         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6544         // We broadcast a few more block to check everything is all right
6545         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6546         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6547         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6548
6549         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6550         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6551 }
6552
6553 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6554         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6555         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6556         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6557         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6558         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6559         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6560
6561         let chanmon_cfgs = create_chanmon_cfgs(3);
6562         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6563         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6564         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6565         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6566
6567         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6568
6569         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6570         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6571
6572         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6573         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6574
6575         // We revoked bs_commitment_tx
6576         if revoked {
6577                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6578                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6579         }
6580
6581         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6582         let mut timeout_tx = Vec::new();
6583         if local {
6584                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6585                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6586                 check_closed_broadcast!(nodes[0], false);
6587                 check_added_monitors!(nodes[0], 1);
6588                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6589                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6590                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6591                 let events = nodes[0].node.get_and_clear_pending_events();
6592                 assert_eq!(events.len(), 1);
6593                 match events[0] {
6594                         Event::PaymentFailed { payment_hash, .. } => {
6595                                 assert_eq!(payment_hash, dust_hash);
6596                         },
6597                         _ => panic!("Unexpected event"),
6598                 }
6599                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6600                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6601                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6602                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6603                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6604                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6605                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6606                 let events = nodes[0].node.get_and_clear_pending_events();
6607                 assert_eq!(events.len(), 1);
6608                 match events[0] {
6609                         Event::PaymentFailed { payment_hash, .. } => {
6610                                 assert_eq!(payment_hash, non_dust_hash);
6611                         },
6612                         _ => panic!("Unexpected event"),
6613                 }
6614         } else {
6615                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6616                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6617                 check_closed_broadcast!(nodes[0], false);
6618                 check_added_monitors!(nodes[0], 1);
6619                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6620                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6621                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6622                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6623                 if !revoked {
6624                         let events = nodes[0].node.get_and_clear_pending_events();
6625                         assert_eq!(events.len(), 1);
6626                         match events[0] {
6627                                 Event::PaymentFailed { payment_hash, .. } => {
6628                                         assert_eq!(payment_hash, dust_hash);
6629                                 },
6630                                 _ => panic!("Unexpected event"),
6631                         }
6632                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6633                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6634                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6635                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6636                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6637                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6638                         let events = nodes[0].node.get_and_clear_pending_events();
6639                         assert_eq!(events.len(), 1);
6640                         match events[0] {
6641                                 Event::PaymentFailed { payment_hash, .. } => {
6642                                         assert_eq!(payment_hash, non_dust_hash);
6643                                 },
6644                                 _ => panic!("Unexpected event"),
6645                         }
6646                 } else {
6647                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6648                         // commitment tx
6649                         let events = nodes[0].node.get_and_clear_pending_events();
6650                         assert_eq!(events.len(), 2);
6651                         let first;
6652                         match events[0] {
6653                                 Event::PaymentFailed { payment_hash, .. } => {
6654                                         if payment_hash == dust_hash { first = true; }
6655                                         else { first = false; }
6656                                 },
6657                                 _ => panic!("Unexpected event"),
6658                         }
6659                         match events[1] {
6660                                 Event::PaymentFailed { payment_hash, .. } => {
6661                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6662                                         else { assert_eq!(payment_hash, dust_hash); }
6663                                 },
6664                                 _ => panic!("Unexpected event"),
6665                         }
6666                 }
6667         }
6668 }
6669
6670 #[test]
6671 fn test_sweep_outbound_htlc_failure_update() {
6672         do_test_sweep_outbound_htlc_failure_update(false, true);
6673         do_test_sweep_outbound_htlc_failure_update(false, false);
6674         do_test_sweep_outbound_htlc_failure_update(true, false);
6675 }
6676
6677 #[test]
6678 fn test_upfront_shutdown_script() {
6679         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6680         // enforce it at shutdown message
6681
6682         let mut config = UserConfig::default();
6683         config.channel_options.announced_channel = true;
6684         config.peer_channel_config_limits.force_announced_channel_preference = false;
6685         config.channel_options.commit_upfront_shutdown_pubkey = false;
6686         let user_cfgs = [None, Some(config), None];
6687         let chanmon_cfgs = create_chanmon_cfgs(3);
6688         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6689         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6690         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6691
6692         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6693         let flags = InitFeatures::supported();
6694         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6695         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6696         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6697         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6698         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6699         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6700         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6701         check_added_monitors!(nodes[2], 1);
6702
6703         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6704         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6705         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6706         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6707         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6708         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6709         let events = nodes[2].node.get_and_clear_pending_msg_events();
6710         assert_eq!(events.len(), 1);
6711         match events[0] {
6712                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6713                 _ => panic!("Unexpected event"),
6714         }
6715
6716         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6717         let mut flags_no = InitFeatures::supported();
6718         flags_no.unset_upfront_shutdown_script();
6719         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6720         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6721         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6722         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6723         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6724         let events = nodes[1].node.get_and_clear_pending_msg_events();
6725         assert_eq!(events.len(), 1);
6726         match events[0] {
6727                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6728                 _ => panic!("Unexpected event"),
6729         }
6730
6731         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6732         // channel smoothly, opt-out is from channel initiator here
6733         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6734         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6735         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6736         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6737         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6738         let events = nodes[0].node.get_and_clear_pending_msg_events();
6739         assert_eq!(events.len(), 1);
6740         match events[0] {
6741                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6742                 _ => panic!("Unexpected event"),
6743         }
6744
6745         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6746         //// channel smoothly
6747         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6748         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6749         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6750         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6751         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6752         let events = nodes[0].node.get_and_clear_pending_msg_events();
6753         assert_eq!(events.len(), 2);
6754         match events[0] {
6755                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6756                 _ => panic!("Unexpected event"),
6757         }
6758         match events[1] {
6759                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6760                 _ => panic!("Unexpected event"),
6761         }
6762 }
6763
6764 #[test]
6765 fn test_user_configurable_csv_delay() {
6766         // We test our channel constructors yield errors when we pass them absurd csv delay
6767
6768         let mut low_our_to_self_config = UserConfig::default();
6769         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6770         let mut high_their_to_self_config = UserConfig::default();
6771         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6772         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6773         let chanmon_cfgs = create_chanmon_cfgs(2);
6774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6776         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6777
6778         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6779         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())));
6780         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) {
6781                 match error {
6782                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6783                         _ => panic!("Unexpected event"),
6784                 }
6785         } else { assert!(false) }
6786
6787         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6788         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6789         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6790         open_channel.to_self_delay = 200;
6791         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) {
6792                 match error {
6793                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6794                         _ => panic!("Unexpected event"),
6795                 }
6796         } else { assert!(false); }
6797
6798         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6799         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6800         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()));
6801         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6802         accept_channel.to_self_delay = 200;
6803         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6804         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6805                 match action {
6806                         &ErrorAction::SendErrorMessage { ref msg } => {
6807                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6808                         },
6809                         _ => { assert!(false); }
6810                 }
6811         } else { assert!(false); }
6812
6813         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6814         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6815         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6816         open_channel.to_self_delay = 200;
6817         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) {
6818                 match error {
6819                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6820                         _ => panic!("Unexpected event"),
6821                 }
6822         } else { assert!(false); }
6823 }
6824
6825 #[test]
6826 fn test_data_loss_protect() {
6827         // We want to be sure that :
6828         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6829         // * we close channel in case of detecting other being fallen behind
6830         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6831         let keys_manager;
6832         let fee_estimator;
6833         let tx_broadcaster;
6834         let monitor;
6835         let node_state_0;
6836         let chanmon_cfgs = create_chanmon_cfgs(2);
6837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6839         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6840
6841         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6842
6843         // Cache node A state before any channel update
6844         let previous_node_state = nodes[0].node.encode();
6845         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6846         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6847
6848         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6849         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6850
6851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6853
6854         // Restore node A from previous state
6855         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6856         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6857         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6858         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6859         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6860         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6861         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6862         node_state_0 = {
6863                 let mut channel_monitors = HashMap::new();
6864                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6865                 <(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 {
6866                         keys_manager: &keys_manager,
6867                         fee_estimator: &fee_estimator,
6868                         monitor: &monitor,
6869                         logger: Arc::clone(&logger),
6870                         tx_broadcaster: &tx_broadcaster,
6871                         default_config: UserConfig::default(),
6872                         channel_monitors: &mut channel_monitors,
6873                 }).unwrap().1
6874         };
6875         nodes[0].node = &node_state_0;
6876         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6877         nodes[0].chan_monitor = &monitor;
6878         nodes[0].chain_monitor = chain_monitor;
6879
6880         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6881         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6882         nodes[0].block_notifier.register_listener(nodes[0].node);
6883
6884         check_added_monitors!(nodes[0], 1);
6885
6886         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6887         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6888
6889         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6890
6891         // Check we update monitor following learning of per_commitment_point from B
6892         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6893         check_added_monitors!(nodes[0], 2);
6894
6895         {
6896                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6897                 assert_eq!(node_txn.len(), 0);
6898         }
6899
6900         let mut reestablish_1 = Vec::with_capacity(1);
6901         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6902                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6903                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6904                         reestablish_1.push(msg.clone());
6905                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6906                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6907                         match action {
6908                                 &ErrorAction::SendErrorMessage { ref msg } => {
6909                                         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");
6910                                 },
6911                                 _ => panic!("Unexpected event!"),
6912                         }
6913                 } else {
6914                         panic!("Unexpected event")
6915                 }
6916         }
6917
6918         // Check we close channel detecting A is fallen-behind
6919         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6920         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6921         check_added_monitors!(nodes[1], 1);
6922
6923
6924         // Check A is able to claim to_remote output
6925         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6926         assert_eq!(node_txn.len(), 1);
6927         check_spends!(node_txn[0], chan.3);
6928         assert_eq!(node_txn[0].output.len(), 2);
6929         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6930         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6931         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6932         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6933         assert_eq!(spend_txn.len(), 1);
6934         check_spends!(spend_txn[0], node_txn[0]);
6935 }
6936
6937 #[test]
6938 fn test_check_htlc_underpaying() {
6939         // Send payment through A -> B but A is maliciously
6940         // sending a probe payment (i.e less than expected value0
6941         // to B, B should refuse payment.
6942
6943         let chanmon_cfgs = create_chanmon_cfgs(2);
6944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6946         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6947
6948         // Create some initial channels
6949         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6950
6951         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6952
6953         // Node 3 is expecting payment of 100_000 but receive 10_000,
6954         // fail htlc like we didn't know the preimage.
6955         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6956         nodes[1].node.process_pending_htlc_forwards();
6957
6958         let events = nodes[1].node.get_and_clear_pending_msg_events();
6959         assert_eq!(events.len(), 1);
6960         let (update_fail_htlc, commitment_signed) = match events[0] {
6961                 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 } } => {
6962                         assert!(update_add_htlcs.is_empty());
6963                         assert!(update_fulfill_htlcs.is_empty());
6964                         assert_eq!(update_fail_htlcs.len(), 1);
6965                         assert!(update_fail_malformed_htlcs.is_empty());
6966                         assert!(update_fee.is_none());
6967                         (update_fail_htlcs[0].clone(), commitment_signed)
6968                 },
6969                 _ => panic!("Unexpected event"),
6970         };
6971         check_added_monitors!(nodes[1], 1);
6972
6973         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6974         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6975
6976         let events = nodes[0].node.get_and_clear_pending_events();
6977         assert_eq!(events.len(), 1);
6978         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6979                 assert_eq!(*rejected_by_dest, true);
6980                 assert_eq!(error_code.unwrap(), 0x4000|15);
6981         } else {
6982                 panic!("Unexpected event");
6983         }
6984         nodes[1].node.get_and_clear_pending_events();
6985 }
6986
6987 #[test]
6988 fn test_announce_disable_channels() {
6989         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6990         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6991
6992         let chanmon_cfgs = create_chanmon_cfgs(2);
6993         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6994         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6995         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6996
6997         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6998         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6999         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7000
7001         // Disconnect peers
7002         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7003         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7004
7005         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7006         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7007         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7008         assert_eq!(msg_events.len(), 3);
7009         for e in msg_events {
7010                 match e {
7011                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7012                                 let short_id = msg.contents.short_channel_id;
7013                                 // Check generated channel_update match list in PendingChannelUpdate
7014                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7015                                         panic!("Generated ChannelUpdate for wrong chan!");
7016                                 }
7017                         },
7018                         _ => panic!("Unexpected event"),
7019                 }
7020         }
7021         // Reconnect peers
7022         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7023         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7024         assert_eq!(reestablish_1.len(), 3);
7025         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7026         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7027         assert_eq!(reestablish_2.len(), 3);
7028
7029         // Reestablish chan_1
7030         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7031         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7032         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7033         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7034         // Reestablish chan_2
7035         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7036         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7037         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7038         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7039         // Reestablish chan_3
7040         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7041         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7042         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7043         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7044
7045         nodes[0].node.timer_chan_freshness_every_min();
7046         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7047 }
7048
7049 #[test]
7050 fn test_bump_penalty_txn_on_revoked_commitment() {
7051         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7052         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7053
7054         let chanmon_cfgs = create_chanmon_cfgs(2);
7055         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7057         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7058
7059         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7060         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7061         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7062         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7063
7064         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7065         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7066         assert_eq!(revoked_txn[0].output.len(), 4);
7067         assert_eq!(revoked_txn[0].input.len(), 1);
7068         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7069         let revoked_txid = revoked_txn[0].txid();
7070
7071         let mut penalty_sum = 0;
7072         for outp in revoked_txn[0].output.iter() {
7073                 if outp.script_pubkey.is_v0_p2wsh() {
7074                         penalty_sum += outp.value;
7075                 }
7076         }
7077
7078         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7079         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7080
7081         // Actually revoke tx by claiming a HTLC
7082         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7083         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7084         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7085         check_added_monitors!(nodes[1], 1);
7086
7087         // One or more justice tx should have been broadcast, check it
7088         let penalty_1;
7089         let feerate_1;
7090         {
7091                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7092                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7093                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7094                 assert_eq!(node_txn[0].output.len(), 1);
7095                 check_spends!(node_txn[0], revoked_txn[0]);
7096                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7097                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7098                 penalty_1 = node_txn[0].txid();
7099                 node_txn.clear();
7100         };
7101
7102         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7103         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7104         let mut penalty_2 = penalty_1;
7105         let mut feerate_2 = 0;
7106         {
7107                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7108                 assert_eq!(node_txn.len(), 1);
7109                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7110                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7111                         assert_eq!(node_txn[0].output.len(), 1);
7112                         check_spends!(node_txn[0], revoked_txn[0]);
7113                         penalty_2 = node_txn[0].txid();
7114                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7115                         assert_ne!(penalty_2, penalty_1);
7116                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7117                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7118                         // Verify 25% bump heuristic
7119                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7120                         node_txn.clear();
7121                 }
7122         }
7123         assert_ne!(feerate_2, 0);
7124
7125         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7126         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7127         let penalty_3;
7128         let mut feerate_3 = 0;
7129         {
7130                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7131                 assert_eq!(node_txn.len(), 1);
7132                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7133                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7134                         assert_eq!(node_txn[0].output.len(), 1);
7135                         check_spends!(node_txn[0], revoked_txn[0]);
7136                         penalty_3 = node_txn[0].txid();
7137                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7138                         assert_ne!(penalty_3, penalty_2);
7139                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7140                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7141                         // Verify 25% bump heuristic
7142                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7143                         node_txn.clear();
7144                 }
7145         }
7146         assert_ne!(feerate_3, 0);
7147
7148         nodes[1].node.get_and_clear_pending_events();
7149         nodes[1].node.get_and_clear_pending_msg_events();
7150 }
7151
7152 #[test]
7153 fn test_bump_penalty_txn_on_revoked_htlcs() {
7154         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7155         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7156
7157         let chanmon_cfgs = create_chanmon_cfgs(2);
7158         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7159         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7160         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7161
7162         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7163         // Lock HTLC in both directions
7164         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7165         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7166
7167         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7168         assert_eq!(revoked_local_txn[0].input.len(), 1);
7169         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7170
7171         // Revoke local commitment tx
7172         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7173
7174         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7175         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7176         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7177         check_closed_broadcast!(nodes[1], false);
7178         check_added_monitors!(nodes[1], 1);
7179
7180         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7181         assert_eq!(revoked_htlc_txn.len(), 6);
7182         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7183                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7184                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7185                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7186                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7187                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7188         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7189                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7190                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7191                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7192                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7193                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7194         }
7195
7196         // Broadcast set of revoked txn on A
7197         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7198         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7199         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);
7200         let first;
7201         let feerate_1;
7202         let penalty_txn;
7203         {
7204                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7205                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7206                 // Verify claim tx are spending revoked HTLC txn
7207                 assert_eq!(node_txn[4].input.len(), 2);
7208                 assert_eq!(node_txn[4].output.len(), 1);
7209                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7210                 first = node_txn[4].txid();
7211                 // Store both feerates for later comparison
7212                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7213                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7214                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7215                 node_txn.clear();
7216         }
7217
7218         // Connect three more block to see if bumped penalty are issued for HTLC txn
7219         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7220         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7221         {
7222                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7223                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7224
7225                 check_spends!(node_txn[0], revoked_local_txn[0]);
7226                 check_spends!(node_txn[1], revoked_local_txn[0]);
7227
7228                 node_txn.clear();
7229         };
7230
7231         // Few more blocks to confirm penalty txn
7232         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7233         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7234         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7235         let node_txn = {
7236                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7237                 assert_eq!(node_txn.len(), 1);
7238
7239                 assert_eq!(node_txn[0].input.len(), 2);
7240                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7241                 // Verify bumped tx is different and 25% bump heuristic
7242                 assert_ne!(first, node_txn[0].txid());
7243                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7244                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7245                 assert!(feerate_2 * 100 > feerate_1 * 125);
7246                 let txn = vec![node_txn[0].clone()];
7247                 node_txn.clear();
7248                 txn
7249         };
7250         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7251         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7252         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7253         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7254         {
7255                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7256                 // We verify than no new transaction has been broadcast because previously
7257                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7258                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7259                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7260                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7261                 // up bumped justice generation.
7262                 assert_eq!(node_txn.len(), 0);
7263                 node_txn.clear();
7264         }
7265         check_closed_broadcast!(nodes[0], false);
7266         check_added_monitors!(nodes[0], 1);
7267 }
7268
7269 #[test]
7270 fn test_bump_penalty_txn_on_remote_commitment() {
7271         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7272         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7273
7274         // Create 2 HTLCs
7275         // Provide preimage for one
7276         // Check aggregation
7277
7278         let chanmon_cfgs = create_chanmon_cfgs(2);
7279         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7280         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7281         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7282
7283         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7284         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7285         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7286
7287         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7288         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7289         assert_eq!(remote_txn[0].output.len(), 4);
7290         assert_eq!(remote_txn[0].input.len(), 1);
7291         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7292
7293         // Claim a HTLC without revocation (provide B monitor with preimage)
7294         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7295         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7296         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7297         check_added_monitors!(nodes[1], 2);
7298
7299         // One or more claim tx should have been broadcast, check it
7300         let timeout;
7301         let preimage;
7302         let feerate_timeout;
7303         let feerate_preimage;
7304         {
7305                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7306                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7307                 assert_eq!(node_txn[0].input.len(), 1);
7308                 assert_eq!(node_txn[1].input.len(), 1);
7309                 check_spends!(node_txn[0], remote_txn[0]);
7310                 check_spends!(node_txn[1], remote_txn[0]);
7311                 check_spends!(node_txn[2], chan.3);
7312                 check_spends!(node_txn[3], node_txn[2]);
7313                 check_spends!(node_txn[4], node_txn[2]);
7314                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7315                         timeout = node_txn[0].txid();
7316                         let index = node_txn[0].input[0].previous_output.vout;
7317                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7318                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7319
7320                         preimage = node_txn[1].txid();
7321                         let index = node_txn[1].input[0].previous_output.vout;
7322                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7323                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7324                 } else {
7325                         timeout = node_txn[1].txid();
7326                         let index = node_txn[1].input[0].previous_output.vout;
7327                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7328                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7329
7330                         preimage = node_txn[0].txid();
7331                         let index = node_txn[0].input[0].previous_output.vout;
7332                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7333                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7334                 }
7335                 node_txn.clear();
7336         };
7337         assert_ne!(feerate_timeout, 0);
7338         assert_ne!(feerate_preimage, 0);
7339
7340         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7341         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7342         {
7343                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7344                 assert_eq!(node_txn.len(), 2);
7345                 assert_eq!(node_txn[0].input.len(), 1);
7346                 assert_eq!(node_txn[1].input.len(), 1);
7347                 check_spends!(node_txn[0], remote_txn[0]);
7348                 check_spends!(node_txn[1], remote_txn[0]);
7349                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7350                         let index = node_txn[0].input[0].previous_output.vout;
7351                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7352                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7353                         assert!(new_feerate * 100 > feerate_timeout * 125);
7354                         assert_ne!(timeout, node_txn[0].txid());
7355
7356                         let index = node_txn[1].input[0].previous_output.vout;
7357                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7358                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7359                         assert!(new_feerate * 100 > feerate_preimage * 125);
7360                         assert_ne!(preimage, node_txn[1].txid());
7361                 } else {
7362                         let index = node_txn[1].input[0].previous_output.vout;
7363                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7364                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7365                         assert!(new_feerate * 100 > feerate_timeout * 125);
7366                         assert_ne!(timeout, node_txn[1].txid());
7367
7368                         let index = node_txn[0].input[0].previous_output.vout;
7369                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7370                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7371                         assert!(new_feerate * 100 > feerate_preimage * 125);
7372                         assert_ne!(preimage, node_txn[0].txid());
7373                 }
7374                 node_txn.clear();
7375         }
7376
7377         nodes[1].node.get_and_clear_pending_events();
7378         nodes[1].node.get_and_clear_pending_msg_events();
7379 }
7380
7381 #[test]
7382 fn test_set_outpoints_partial_claiming() {
7383         // - remote party claim tx, new bump tx
7384         // - disconnect remote claiming tx, new bump
7385         // - disconnect tx, see no tx anymore
7386         let chanmon_cfgs = create_chanmon_cfgs(2);
7387         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7388         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7389         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7390
7391         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7392         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7393         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7394
7395         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7396         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7397         assert_eq!(remote_txn.len(), 3);
7398         assert_eq!(remote_txn[0].output.len(), 4);
7399         assert_eq!(remote_txn[0].input.len(), 1);
7400         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7401         check_spends!(remote_txn[1], remote_txn[0]);
7402         check_spends!(remote_txn[2], remote_txn[0]);
7403
7404         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7405         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7406         // Provide node A with both preimage
7407         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7408         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7409         check_added_monitors!(nodes[0], 2);
7410         nodes[0].node.get_and_clear_pending_events();
7411         nodes[0].node.get_and_clear_pending_msg_events();
7412
7413         // Connect blocks on node A commitment transaction
7414         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7415         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7416         check_closed_broadcast!(nodes[0], false);
7417         check_added_monitors!(nodes[0], 1);
7418         // Verify node A broadcast tx claiming both HTLCs
7419         {
7420                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7421                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7422                 assert_eq!(node_txn.len(), 4);
7423                 check_spends!(node_txn[0], remote_txn[0]);
7424                 check_spends!(node_txn[1], chan.3);
7425                 check_spends!(node_txn[2], node_txn[1]);
7426                 check_spends!(node_txn[3], node_txn[1]);
7427                 assert_eq!(node_txn[0].input.len(), 2);
7428                 node_txn.clear();
7429         }
7430
7431         // Connect blocks on node B
7432         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7433         check_closed_broadcast!(nodes[1], false);
7434         check_added_monitors!(nodes[1], 1);
7435         // Verify node B broadcast 2 HTLC-timeout txn
7436         let partial_claim_tx = {
7437                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7438                 assert_eq!(node_txn.len(), 3);
7439                 check_spends!(node_txn[1], node_txn[0]);
7440                 check_spends!(node_txn[2], node_txn[0]);
7441                 assert_eq!(node_txn[1].input.len(), 1);
7442                 assert_eq!(node_txn[2].input.len(), 1);
7443                 node_txn[1].clone()
7444         };
7445
7446         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7447         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7448         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7449         {
7450                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7451                 assert_eq!(node_txn.len(), 1);
7452                 check_spends!(node_txn[0], remote_txn[0]);
7453                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7454                 node_txn.clear();
7455         }
7456         nodes[0].node.get_and_clear_pending_msg_events();
7457
7458         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7459         nodes[0].block_notifier.block_disconnected(&header, 102);
7460         {
7461                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7462                 assert_eq!(node_txn.len(), 1);
7463                 check_spends!(node_txn[0], remote_txn[0]);
7464                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7465                 node_txn.clear();
7466         }
7467
7468         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7469         nodes[0].block_notifier.block_disconnected(&header, 101);
7470         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7471         {
7472                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7473                 assert_eq!(node_txn.len(), 0);
7474                 node_txn.clear();
7475         }
7476 }
7477
7478 #[test]
7479 fn test_counterparty_raa_skip_no_crash() {
7480         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7481         // commitment transaction, we would have happily carried on and provided them the next
7482         // commitment transaction based on one RAA forward. This would probably eventually have led to
7483         // channel closure, but it would not have resulted in funds loss. Still, our
7484         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7485         // check simply that the channel is closed in response to such an RAA, but don't check whether
7486         // we decide to punish our counterparty for revoking their funds (as we don't currently
7487         // implement that).
7488         let chanmon_cfgs = create_chanmon_cfgs(2);
7489         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7490         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7491         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7492         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7493
7494         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7495         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7496         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7497                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7498         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7499
7500         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7501                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7502         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7503         check_added_monitors!(nodes[1], 1);
7504 }
7505
7506 #[test]
7507 fn test_bump_txn_sanitize_tracking_maps() {
7508         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7509         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7510
7511         let chanmon_cfgs = create_chanmon_cfgs(2);
7512         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7513         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7514         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7515
7516         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7517         // Lock HTLC in both directions
7518         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7519         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7520
7521         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7522         assert_eq!(revoked_local_txn[0].input.len(), 1);
7523         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7524
7525         // Revoke local commitment tx
7526         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7527
7528         // Broadcast set of revoked txn on A
7529         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7530         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7531         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7532         check_closed_broadcast!(nodes[0], false);
7533         check_added_monitors!(nodes[0], 1);
7534         let penalty_txn = {
7535                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7536                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7537                 check_spends!(node_txn[0], revoked_local_txn[0]);
7538                 check_spends!(node_txn[1], revoked_local_txn[0]);
7539                 check_spends!(node_txn[2], revoked_local_txn[0]);
7540                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7541                 node_txn.clear();
7542                 penalty_txn
7543         };
7544         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7545         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7546         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7547         {
7548                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7549                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7550                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7551                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7552                 }
7553         }
7554 }
7555
7556 #[test]
7557 fn test_override_channel_config() {
7558         let chanmon_cfgs = create_chanmon_cfgs(2);
7559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7561         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7562
7563         // Node0 initiates a channel to node1 using the override config.
7564         let mut override_config = UserConfig::default();
7565         override_config.own_channel_config.our_to_self_delay = 200;
7566
7567         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7568
7569         // Assert the channel created by node0 is using the override config.
7570         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7571         assert_eq!(res.channel_flags, 0);
7572         assert_eq!(res.to_self_delay, 200);
7573 }
7574
7575 #[test]
7576 fn test_override_0msat_htlc_minimum() {
7577         let mut zero_config = UserConfig::default();
7578         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7579         let chanmon_cfgs = create_chanmon_cfgs(2);
7580         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7581         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7582         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7583
7584         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7585         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7586         assert_eq!(res.htlc_minimum_msat, 1);
7587
7588         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7589         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7590         assert_eq!(res.htlc_minimum_msat, 1);
7591 }
7592
7593 #[test]
7594 fn test_simple_payment_secret() {
7595         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7596         // features, however.
7597         let chanmon_cfgs = create_chanmon_cfgs(3);
7598         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7599         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7600         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7601
7602         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7603         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7604
7605         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7606         let payment_secret = PaymentSecret([0xdb; 32]);
7607         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7608         send_along_route_with_secret(&nodes[0], route, &[&nodes[1], &nodes[2]], 100000, payment_hash, Some(payment_secret.clone()));
7609         // Claiming with all the correct values but the wrong secret should result in nothing...
7610         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7611         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7612         // ...but with the right secret we should be able to claim all the way back
7613         claim_payment_along_route_with_secret(&nodes[0], &[&nodes[1], &nodes[2]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7614 }