_ Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain::transaction::OutPoint;
  15 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
  16 use chain::chaininterface;
  17 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
  18 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  19 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  20 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  21 use ln::channelmonitor;
  22 use ln::channel::{Channel, ChannelError};
  23 use ln::{chan_utils, onion_utils};
  24 use routing::router::{Route, RouteHop, get_route};
  25 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  26 use ln::msgs;
  27 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
  28 use util::enforcing_trait_impls::EnforcingChannelKeys;
  29 use util::{byte_utils, test_utils};
  30 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  31 use util::errors::APIError;
  32 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  33 use util::config::UserConfig;
  34
  35 use bitcoin::util::hash::BitcoinHash;
  36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  37 use bitcoin::hashes::HashEngine;
  38 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  39 use bitcoin::util::bip143;
  40 use bitcoin::util::address::Address;
  41 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  42 use bitcoin::blockdata::block::{Block, BlockHeader};
  43 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  44 use bitcoin::blockdata::script::{Builder, Script};
  45 use bitcoin::blockdata::opcodes;
  46 use bitcoin::blockdata::constants::genesis_block;
  47 use bitcoin::network::constants::Network;
  48
  49 use bitcoin::hashes::sha256::Hash as Sha256;
  50 use bitcoin::hashes::Hash;
  51
  52 use bitcoin::secp256k1::{Secp256k1, Message};
  53 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  54
  55 use regex;
  56
  57 use std::collections::{BTreeSet, HashMap, HashSet};
  58 use std::default::Default;
  59 use std::sync::{Arc, Mutex};
  60 use std::sync::atomic::Ordering;
  61 use std::{mem, io};
  62
  63 use ln::functional_test_utils::*;
  64 use ln::chan_utils::PreCalculatedTxCreationKeys;
  65
  66 #[test]
  67 fn test_insane_channel_opens() {
  68         // Stand up a network of 2 nodes
  69         let chanmon_cfgs = create_chanmon_cfgs(2);
  70         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  71         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  72         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  73
  74         // Instantiate channel parameters where we push the maximum msats given our
  75         // funding satoshis
  76         let channel_value_sat = 31337; // same as funding satoshis
  77         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  78         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  79
  80         // Have node0 initiate a channel to node1 with aforementioned parameters
  81         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  82
  83         // Extract the channel open message from node0 to node1
  84         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  85
  86         // Test helper that asserts we get the correct error string given a mutator
  87         // that supposedly makes the channel open message insane
  88         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  89                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  90                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  91                 assert_eq!(msg_events.len(), 1);
  92                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  93                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  94                         match action {
  95                                 &ErrorAction::SendErrorMessage { .. } => {
  96                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  97                                 },
  98                                 _ => panic!("unexpected event!"),
  99                         }
 100                 } else { assert!(false); }
 101         };
 102
 103         use ln::channel::MAX_FUNDING_SATOSHIS;
 104         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 105
 106         // Test all mutations that would make the channel open message insane
 107         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 108
 109         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 110
 111         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 112
 113         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 114
 115         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 116
 117         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 118
 119         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 });
 120
 121         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 122
 123         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 124 }
 125
 126 #[test]
 127 fn test_async_inbound_update_fee() {
 128         let chanmon_cfgs = create_chanmon_cfgs(2);
 129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 131         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 132         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 133         let logger = test_utils::TestLogger::new();
 134         let channel_id = chan.2;
 135
 136         // balancing
 137         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 138
 139         // A                                        B
 140         // update_fee                            ->
 141         // send (1) commitment_signed            -.
 142         //                                       <- update_add_htlc/commitment_signed
 143         // send (2) RAA (awaiting remote revoke) -.
 144         // (1) commitment_signed is delivered    ->
 145         //                                       .- send (3) RAA (awaiting remote revoke)
 146         // (2) RAA is delivered                  ->
 147         //                                       .- send (4) commitment_signed
 148         //                                       <- (3) RAA is delivered
 149         // send (5) commitment_signed            -.
 150         //                                       <- (4) commitment_signed is delivered
 151         // send (6) RAA                          -.
 152         // (5) commitment_signed is delivered    ->
 153         //                                       <- RAA
 154         // (6) RAA is delivered                  ->
 155
 156         // First nodes[0] generates an update_fee
 157         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 158         check_added_monitors!(nodes[0], 1);
 159
 160         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 161         assert_eq!(events_0.len(), 1);
 162         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 163                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 164                         (update_fee.as_ref(), commitment_signed)
 165                 },
 166                 _ => panic!("Unexpected event"),
 167         };
 168
 169         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 170
 171         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 172         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 173         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 174         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 175         check_added_monitors!(nodes[1], 1);
 176
 177         let payment_event = {
 178                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 179                 assert_eq!(events_1.len(), 1);
 180                 SendEvent::from_event(events_1.remove(0))
 181         };
 182         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 183         assert_eq!(payment_event.msgs.len(), 1);
 184
 185         // ...now when the messages get delivered everyone should be happy
 186         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 187         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 188         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 189         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 190         check_added_monitors!(nodes[0], 1);
 191
 192         // deliver(1), generate (3):
 193         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 194         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 195         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 196         check_added_monitors!(nodes[1], 1);
 197
 198         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 199         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 200         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 203         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 204         assert!(bs_update.update_fee.is_none()); // (4)
 205         check_added_monitors!(nodes[1], 1);
 206
 207         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 208         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 209         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 212         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 213         assert!(as_update.update_fee.is_none()); // (5)
 214         check_added_monitors!(nodes[0], 1);
 215
 216         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 217         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 218         // only (6) so get_event_msg's assert(len == 1) passes
 219         check_added_monitors!(nodes[0], 1);
 220
 221         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 222         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 223         check_added_monitors!(nodes[1], 1);
 224
 225         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 226         check_added_monitors!(nodes[0], 1);
 227
 228         let events_2 = nodes[0].node.get_and_clear_pending_events();
 229         assert_eq!(events_2.len(), 1);
 230         match events_2[0] {
 231                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 232                 _ => panic!("Unexpected event"),
 233         }
 234
 235         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 236         check_added_monitors!(nodes[1], 1);
 237 }
 238
 239 #[test]
 240 fn test_update_fee_unordered_raa() {
 241         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 242         // crash in an earlier version of the update_fee patch)
 243         let chanmon_cfgs = create_chanmon_cfgs(2);
 244         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 245         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 246         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 247         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 248         let channel_id = chan.2;
 249         let logger = test_utils::TestLogger::new();
 250
 251         // balancing
 252         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 253
 254         // First nodes[0] generates an update_fee
 255         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 256         check_added_monitors!(nodes[0], 1);
 257
 258         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 259         assert_eq!(events_0.len(), 1);
 260         let update_msg = match events_0[0] { // (1)
 261                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 262                         update_fee.as_ref()
 263                 },
 264                 _ => panic!("Unexpected event"),
 265         };
 266
 267         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 268
 269         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 270         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 271         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 272         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 273         check_added_monitors!(nodes[1], 1);
 274
 275         let payment_event = {
 276                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 277                 assert_eq!(events_1.len(), 1);
 278                 SendEvent::from_event(events_1.remove(0))
 279         };
 280         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 281         assert_eq!(payment_event.msgs.len(), 1);
 282
 283         // ...now when the messages get delivered everyone should be happy
 284         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 285         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 286         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 287         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 288         check_added_monitors!(nodes[0], 1);
 289
 290         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 291         check_added_monitors!(nodes[1], 1);
 292
 293         // We can't continue, sadly, because our (1) now has a bogus signature
 294 }
 295
 296 #[test]
 297 fn test_multi_flight_update_fee() {
 298         let chanmon_cfgs = create_chanmon_cfgs(2);
 299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 301         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 302         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 303         let channel_id = chan.2;
 304
 305         // A                                        B
 306         // update_fee/commitment_signed          ->
 307         //                                       .- send (1) RAA and (2) commitment_signed
 308         // update_fee (never committed)          ->
 309         // (3) update_fee                        ->
 310         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 311         // don't track which updates correspond to which revoke_and_ack responses so we're in
 312         // AwaitingRAA mode and will not generate the update_fee yet.
 313         //                                       <- (1) RAA delivered
 314         // (3) is generated and send (4) CS      -.
 315         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 316         // know the per_commitment_point to use for it.
 317         //                                       <- (2) commitment_signed delivered
 318         // revoke_and_ack                        ->
 319         //                                          B should send no response here
 320         // (4) commitment_signed delivered       ->
 321         //                                       <- RAA/commitment_signed delivered
 322         // revoke_and_ack                        ->
 323
 324         // First nodes[0] generates an update_fee
 325         let initial_feerate = get_feerate!(nodes[0], channel_id);
 326         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 327         check_added_monitors!(nodes[0], 1);
 328
 329         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 330         assert_eq!(events_0.len(), 1);
 331         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 332                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 333                         (update_fee.as_ref().unwrap(), commitment_signed)
 334                 },
 335                 _ => panic!("Unexpected event"),
 336         };
 337
 338         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 339         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 340         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 341         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 342         check_added_monitors!(nodes[1], 1);
 343
 344         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 345         // transaction:
 346         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 347         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 348         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 349
 350         // Create the (3) update_fee message that nodes[0] will generate before it does...
 351         let mut update_msg_2 = msgs::UpdateFee {
 352                 channel_id: update_msg_1.channel_id.clone(),
 353                 feerate_per_kw: (initial_feerate + 30) as u32,
 354         };
 355
 356         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 357
 358         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 359         // Deliver (3)
 360         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 361
 362         // Deliver (1), generating (3) and (4)
 363         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 364         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 365         check_added_monitors!(nodes[0], 1);
 366         assert!(as_second_update.update_add_htlcs.is_empty());
 367         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 368         assert!(as_second_update.update_fail_htlcs.is_empty());
 369         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 370         // Check that the update_fee newly generated matches what we delivered:
 371         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 372         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 373
 374         // Deliver (2) commitment_signed
 375         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 376         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 377         check_added_monitors!(nodes[0], 1);
 378         // No commitment_signed so get_event_msg's assert(len == 1) passes
 379
 380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 381         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 382         check_added_monitors!(nodes[1], 1);
 383
 384         // Delever (4)
 385         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 386         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 387         check_added_monitors!(nodes[1], 1);
 388
 389         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 390         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 391         check_added_monitors!(nodes[0], 1);
 392
 393         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 394         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 395         // No commitment_signed so get_event_msg's assert(len == 1) passes
 396         check_added_monitors!(nodes[0], 1);
 397
 398         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 399         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 400         check_added_monitors!(nodes[1], 1);
 401 }
 402
 403 #[test]
 404 fn test_1_conf_open() {
 405         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 406         // tests that we properly send one in that case.
 407         let mut alice_config = UserConfig::default();
 408         alice_config.own_channel_config.minimum_depth = 1;
 409         alice_config.channel_options.announced_channel = true;
 410         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let mut bob_config = UserConfig::default();
 412         bob_config.own_channel_config.minimum_depth = 1;
 413         bob_config.channel_options.announced_channel = true;
 414         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 415         let chanmon_cfgs = create_chanmon_cfgs(2);
 416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 419
 420         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 421         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 422         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 423
 424         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 425         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 426         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()));
 427
 428         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 429         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 430         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 431
 432         for node in nodes {
 433                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 434                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 435                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 436         }
 437 }
 438
 439 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 440         // Previously, we had issues deserializing channels when we hadn't connected the first block
 441         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 442         // serialization round-trips and simply do steps towards opening a channel and then drop the
 443         // Node objects.
 444
 445         let chanmon_cfgs = create_chanmon_cfgs(2);
 446         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 448         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 449
 450         if steps & 0b1000_0000 != 0{
 451                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 452                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 453                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 1);
 495         match events_4[0] {
 496                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 497                         assert_eq!(user_channel_id, 42);
 498                         assert_eq!(*funding_txo, funding_output);
 499                 },
 500                 _ => panic!("Unexpected event"),
 501         };
 502
 503         if steps & 0x0f == 6 { return; }
 504         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 505
 506         if steps & 0x0f == 7 { return; }
 507         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 508         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 509 }
 510
 511 #[test]
 512 fn test_sanity_on_in_flight_opens() {
 513         do_test_sanity_on_in_flight_opens(0);
 514         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(1);
 516         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(2);
 518         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(3);
 520         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(4);
 522         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(5);
 524         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(6);
 526         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 527         do_test_sanity_on_in_flight_opens(7);
 528         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 529         do_test_sanity_on_in_flight_opens(8);
 530         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 531 }
 532
 533 #[test]
 534 fn test_update_fee_vanilla() {
 535         let chanmon_cfgs = create_chanmon_cfgs(2);
 536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 538         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 539         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 540         let channel_id = chan.2;
 541
 542         let feerate = get_feerate!(nodes[0], channel_id);
 543         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 544         check_added_monitors!(nodes[0], 1);
 545
 546         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 547         assert_eq!(events_0.len(), 1);
 548         let (update_msg, commitment_signed) = match events_0[0] {
 549                         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 } } => {
 550                         (update_fee.as_ref(), commitment_signed)
 551                 },
 552                 _ => panic!("Unexpected event"),
 553         };
 554         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 555
 556         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 557         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 558         check_added_monitors!(nodes[1], 1);
 559
 560         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 562         check_added_monitors!(nodes[0], 1);
 563
 564         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 565         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 566         // No commitment_signed so get_event_msg's assert(len == 1) passes
 567         check_added_monitors!(nodes[0], 1);
 568
 569         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 570         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 571         check_added_monitors!(nodes[1], 1);
 572 }
 573
 574 #[test]
 575 fn test_update_fee_that_funder_cannot_afford() {
 576         let chanmon_cfgs = create_chanmon_cfgs(2);
 577         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 578         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 579         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 580         let channel_value = 1888;
 581         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 582         let channel_id = chan.2;
 583
 584         let feerate = 260;
 585         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 586         check_added_monitors!(nodes[0], 1);
 587         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 588
 589         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 590
 591         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 592
 593         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 594         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 595         {
 596                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 597
 598                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 599                 let num_htlcs = commitment_tx.output.len() - 2;
 600                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 601                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 602                 actual_fee = channel_value - actual_fee;
 603                 assert_eq!(total_fee, actual_fee);
 604         }
 605
 606         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 607         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 608         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 609         check_added_monitors!(nodes[0], 1);
 610
 611         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 612
 613         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 614
 615         //While producing the commitment_signed response after handling a received update_fee request the
 616         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 617         //Should produce and error.
 618         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 619         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 620         check_added_monitors!(nodes[1], 1);
 621         check_closed_broadcast!(nodes[1], true);
 622 }
 623
 624 #[test]
 625 fn test_update_fee_with_fundee_update_add_htlc() {
 626         let chanmon_cfgs = create_chanmon_cfgs(2);
 627         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 628         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 629         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 630         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 631         let channel_id = chan.2;
 632         let logger = test_utils::TestLogger::new();
 633
 634         // balancing
 635         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 636
 637         let feerate = get_feerate!(nodes[0], channel_id);
 638         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 639         check_added_monitors!(nodes[0], 1);
 640
 641         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 642         assert_eq!(events_0.len(), 1);
 643         let (update_msg, commitment_signed) = match events_0[0] {
 644                         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 } } => {
 645                         (update_fee.as_ref(), commitment_signed)
 646                 },
 647                 _ => panic!("Unexpected event"),
 648         };
 649         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 650         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 651         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 652         check_added_monitors!(nodes[1], 1);
 653
 654         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 655         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 656         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 657
 658         // nothing happens since node[1] is in AwaitingRemoteRevoke
 659         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 660         {
 661                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 662                 assert_eq!(added_monitors.len(), 0);
 663                 added_monitors.clear();
 664         }
 665         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         // node[1] has nothing to do
 668
 669         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 670         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 671         check_added_monitors!(nodes[0], 1);
 672
 673         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 674         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 675         // No commitment_signed so get_event_msg's assert(len == 1) passes
 676         check_added_monitors!(nodes[0], 1);
 677         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 678         check_added_monitors!(nodes[1], 1);
 679         // AwaitingRemoteRevoke ends here
 680
 681         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 682         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 683         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 684         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 685         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 686         assert_eq!(commitment_update.update_fee.is_none(), true);
 687
 688         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 689         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 690         check_added_monitors!(nodes[0], 1);
 691         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 692
 693         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 694         check_added_monitors!(nodes[1], 1);
 695         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 696
 697         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 698         check_added_monitors!(nodes[1], 1);
 699         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 700         // No commitment_signed so get_event_msg's assert(len == 1) passes
 701
 702         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 703         check_added_monitors!(nodes[0], 1);
 704         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 705
 706         expect_pending_htlcs_forwardable!(nodes[0]);
 707
 708         let events = nodes[0].node.get_and_clear_pending_events();
 709         assert_eq!(events.len(), 1);
 710         match events[0] {
 711                 Event::PaymentReceived { .. } => { },
 712                 _ => panic!("Unexpected event"),
 713         };
 714
 715         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 716
 717         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 718         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 719         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 720 }
 721
 722 #[test]
 723 fn test_update_fee() {
 724         let chanmon_cfgs = create_chanmon_cfgs(2);
 725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 727         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 728         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 729         let channel_id = chan.2;
 730
 731         // A                                        B
 732         // (1) update_fee/commitment_signed      ->
 733         //                                       <- (2) revoke_and_ack
 734         //                                       .- send (3) commitment_signed
 735         // (4) update_fee/commitment_signed      ->
 736         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 737         //                                       <- (3) commitment_signed delivered
 738         // send (6) revoke_and_ack               -.
 739         //                                       <- (5) deliver revoke_and_ack
 740         // (6) deliver revoke_and_ack            ->
 741         //                                       .- send (7) commitment_signed in response to (4)
 742         //                                       <- (7) deliver commitment_signed
 743         // revoke_and_ack                        ->
 744
 745         // Create and deliver (1)...
 746         let feerate = get_feerate!(nodes[0], channel_id);
 747         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 748         check_added_monitors!(nodes[0], 1);
 749
 750         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 751         assert_eq!(events_0.len(), 1);
 752         let (update_msg, commitment_signed) = match events_0[0] {
 753                         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 } } => {
 754                         (update_fee.as_ref(), commitment_signed)
 755                 },
 756                 _ => panic!("Unexpected event"),
 757         };
 758         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 759
 760         // Generate (2) and (3):
 761         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 762         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 763         check_added_monitors!(nodes[1], 1);
 764
 765         // Deliver (2):
 766         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 767         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 768         check_added_monitors!(nodes[0], 1);
 769
 770         // Create and deliver (4)...
 771         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 772         check_added_monitors!(nodes[0], 1);
 773         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 774         assert_eq!(events_0.len(), 1);
 775         let (update_msg, commitment_signed) = match events_0[0] {
 776                         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 } } => {
 777                         (update_fee.as_ref(), commitment_signed)
 778                 },
 779                 _ => panic!("Unexpected event"),
 780         };
 781
 782         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 783         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 784         check_added_monitors!(nodes[1], 1);
 785         // ... creating (5)
 786         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Handle (3), creating (6):
 790         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 791         check_added_monitors!(nodes[0], 1);
 792         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 793         // No commitment_signed so get_event_msg's assert(len == 1) passes
 794
 795         // Deliver (5):
 796         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 797         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 798         check_added_monitors!(nodes[0], 1);
 799
 800         // Deliver (6), creating (7):
 801         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 802         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 803         assert!(commitment_update.update_add_htlcs.is_empty());
 804         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 805         assert!(commitment_update.update_fail_htlcs.is_empty());
 806         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 807         assert!(commitment_update.update_fee.is_none());
 808         check_added_monitors!(nodes[1], 1);
 809
 810         // Deliver (7)
 811         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 812         check_added_monitors!(nodes[0], 1);
 813         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 814         // No commitment_signed so get_event_msg's assert(len == 1) passes
 815
 816         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 817         check_added_monitors!(nodes[1], 1);
 818         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 819
 820         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 821         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 822         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 823 }
 824
 825 #[test]
 826 fn pre_funding_lock_shutdown_test() {
 827         // Test sending a shutdown prior to funding_locked after funding generation
 828         let chanmon_cfgs = create_chanmon_cfgs(2);
 829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 831         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 832         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 833         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 834         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 835         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 836
 837         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 838         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 840         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 842
 843         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 844         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 845         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 846         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 847         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 848         assert!(node_0_none.is_none());
 849
 850         assert!(nodes[0].node.list_channels().is_empty());
 851         assert!(nodes[1].node.list_channels().is_empty());
 852 }
 853
 854 #[test]
 855 fn updates_shutdown_wait() {
 856         // Test sending a shutdown with outstanding updates pending
 857         let chanmon_cfgs = create_chanmon_cfgs(3);
 858         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 859         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 860         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 862         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 863         let logger = test_utils::TestLogger::new();
 864
 865         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 866
 867         nodes[0].node.close_channel(&chan_1.2).unwrap();
 868         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 869         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 870         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 871         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 872
 873         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 875
 876         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 877
 878         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 879         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 880         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 881         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 882         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 883         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 884
 885         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 886         check_added_monitors!(nodes[2], 1);
 887         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 888         assert!(updates.update_add_htlcs.is_empty());
 889         assert!(updates.update_fail_htlcs.is_empty());
 890         assert!(updates.update_fail_malformed_htlcs.is_empty());
 891         assert!(updates.update_fee.is_none());
 892         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 893         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 894         check_added_monitors!(nodes[1], 1);
 895         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 896         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 897
 898         assert!(updates_2.update_add_htlcs.is_empty());
 899         assert!(updates_2.update_fail_htlcs.is_empty());
 900         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 901         assert!(updates_2.update_fee.is_none());
 902         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 903         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 904         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 905
 906         let events = nodes[0].node.get_and_clear_pending_events();
 907         assert_eq!(events.len(), 1);
 908         match events[0] {
 909                 Event::PaymentSent { ref payment_preimage } => {
 910                         assert_eq!(our_payment_preimage, *payment_preimage);
 911                 },
 912                 _ => panic!("Unexpected event"),
 913         }
 914
 915         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 916         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 917         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 918         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 919         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 920         assert!(node_0_none.is_none());
 921
 922         assert!(nodes[0].node.list_channels().is_empty());
 923
 924         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 925         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 926         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 927         assert!(nodes[1].node.list_channels().is_empty());
 928         assert!(nodes[2].node.list_channels().is_empty());
 929 }
 930
 931 #[test]
 932 fn htlc_fail_async_shutdown() {
 933         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 934         let chanmon_cfgs = create_chanmon_cfgs(3);
 935         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 936         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 937         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 938         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 939         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 940         let logger = test_utils::TestLogger::new();
 941
 942         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 943         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 944         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 945         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 946         check_added_monitors!(nodes[0], 1);
 947         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 948         assert_eq!(updates.update_add_htlcs.len(), 1);
 949         assert!(updates.update_fulfill_htlcs.is_empty());
 950         assert!(updates.update_fail_htlcs.is_empty());
 951         assert!(updates.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates.update_fee.is_none());
 953
 954         nodes[1].node.close_channel(&chan_1.2).unwrap();
 955         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 956         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 957         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 958
 959         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 960         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 961         check_added_monitors!(nodes[1], 1);
 962         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 963         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 964
 965         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 966         assert!(updates_2.update_add_htlcs.is_empty());
 967         assert!(updates_2.update_fulfill_htlcs.is_empty());
 968         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 969         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 970         assert!(updates_2.update_fee.is_none());
 971
 972         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 973         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 974
 975         expect_payment_failed!(nodes[0], our_payment_hash, false);
 976
 977         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 978         assert_eq!(msg_events.len(), 2);
 979         let node_0_closing_signed = match msg_events[0] {
 980                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 981                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 982                         (*msg).clone()
 983                 },
 984                 _ => panic!("Unexpected event"),
 985         };
 986         match msg_events[1] {
 987                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 988                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 989                 },
 990                 _ => panic!("Unexpected event"),
 991         }
 992
 993         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 994         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 995         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 996         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 997         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 998         assert!(node_0_none.is_none());
 999
1000         assert!(nodes[0].node.list_channels().is_empty());
1001
1002         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1003         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1004         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1005         assert!(nodes[1].node.list_channels().is_empty());
1006         assert!(nodes[2].node.list_channels().is_empty());
1007 }
1008
1009 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1010         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1011         // messages delivered prior to disconnect
1012         let chanmon_cfgs = create_chanmon_cfgs(3);
1013         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1014         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1015         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1016         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1017         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1018
1019         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1020
1021         nodes[1].node.close_channel(&chan_1.2).unwrap();
1022         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1023         if recv_count > 0 {
1024                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1025                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1026                 if recv_count > 1 {
1027                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1028                 }
1029         }
1030
1031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1032         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1033
1034         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1035         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1036         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1037         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1038
1039         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1040         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1041         assert!(node_1_shutdown == node_1_2nd_shutdown);
1042
1043         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1044         let node_0_2nd_shutdown = if recv_count > 0 {
1045                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1047                 node_0_2nd_shutdown
1048         } else {
1049                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1051                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1052         };
1053         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1054
1055         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1057
1058         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1059         check_added_monitors!(nodes[2], 1);
1060         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061         assert!(updates.update_add_htlcs.is_empty());
1062         assert!(updates.update_fail_htlcs.is_empty());
1063         assert!(updates.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates.update_fee.is_none());
1065         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1066         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1067         check_added_monitors!(nodes[1], 1);
1068         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1069         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1070
1071         assert!(updates_2.update_add_htlcs.is_empty());
1072         assert!(updates_2.update_fail_htlcs.is_empty());
1073         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1074         assert!(updates_2.update_fee.is_none());
1075         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1076         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1077         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1078
1079         let events = nodes[0].node.get_and_clear_pending_events();
1080         assert_eq!(events.len(), 1);
1081         match events[0] {
1082                 Event::PaymentSent { ref payment_preimage } => {
1083                         assert_eq!(our_payment_preimage, *payment_preimage);
1084                 },
1085                 _ => panic!("Unexpected event"),
1086         }
1087
1088         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1089         if recv_count > 0 {
1090                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1091                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1092                 assert!(node_1_closing_signed.is_some());
1093         }
1094
1095         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1096         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1097
1098         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1099         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1100         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1101         if recv_count == 0 {
1102                 // If all closing_signeds weren't delivered we can just resume where we left off...
1103                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1104
1105                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1106                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1107                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1108
1109                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1110                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1111                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1112
1113                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1114                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115
1116                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1117                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1118                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1119
1120                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1121                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1122                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1123                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1124                 assert!(node_0_none.is_none());
1125         } else {
1126                 // If one node, however, received + responded with an identical closing_signed we end
1127                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1128                 // There isn't really anything better we can do simply, but in the future we might
1129                 // explore storing a set of recently-closed channels that got disconnected during
1130                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1131                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1132                 // transaction.
1133                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1134
1135                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1136                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1137                 assert_eq!(msg_events.len(), 1);
1138                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1139                         match action {
1140                                 &ErrorAction::SendErrorMessage { ref msg } => {
1141                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1142                                         assert_eq!(msg.channel_id, chan_1.2);
1143                                 },
1144                                 _ => panic!("Unexpected event!"),
1145                         }
1146                 } else { panic!("Needed SendErrorMessage close"); }
1147
1148                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1149                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1150                 // closing_signed so we do it ourselves
1151                 check_closed_broadcast!(nodes[0], false);
1152                 check_added_monitors!(nodes[0], 1);
1153         }
1154
1155         assert!(nodes[0].node.list_channels().is_empty());
1156
1157         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1158         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1159         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1160         assert!(nodes[1].node.list_channels().is_empty());
1161         assert!(nodes[2].node.list_channels().is_empty());
1162 }
1163
1164 #[test]
1165 fn test_shutdown_rebroadcast() {
1166         do_test_shutdown_rebroadcast(0);
1167         do_test_shutdown_rebroadcast(1);
1168         do_test_shutdown_rebroadcast(2);
1169 }
1170
1171 #[test]
1172 fn fake_network_test() {
1173         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1174         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1175         let chanmon_cfgs = create_chanmon_cfgs(4);
1176         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1177         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1178         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1179
1180         // Create some initial channels
1181         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1182         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1183         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1184
1185         // Rebalance the network a bit by relaying one payment through all the channels...
1186         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1187         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1188         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1189         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1190
1191         // Send some more payments
1192         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1193         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1195
1196         // Test failure packets
1197         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1198         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1199
1200         // Add a new channel that skips 3
1201         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1202
1203         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1204         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1207         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1208         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1209         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1210
1211         // Do some rebalance loop payments, simultaneously
1212         let mut hops = Vec::with_capacity(3);
1213         hops.push(RouteHop {
1214                 pubkey: nodes[2].node.get_our_node_id(),
1215                 node_features: NodeFeatures::empty(),
1216                 short_channel_id: chan_2.0.contents.short_channel_id,
1217                 channel_features: ChannelFeatures::empty(),
1218                 fee_msat: 0,
1219                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1220         });
1221         hops.push(RouteHop {
1222                 pubkey: nodes[3].node.get_our_node_id(),
1223                 node_features: NodeFeatures::empty(),
1224                 short_channel_id: chan_3.0.contents.short_channel_id,
1225                 channel_features: ChannelFeatures::empty(),
1226                 fee_msat: 0,
1227                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1228         });
1229         hops.push(RouteHop {
1230                 pubkey: nodes[1].node.get_our_node_id(),
1231                 node_features: NodeFeatures::empty(),
1232                 short_channel_id: chan_4.0.contents.short_channel_id,
1233                 channel_features: ChannelFeatures::empty(),
1234                 fee_msat: 1000000,
1235                 cltv_expiry_delta: TEST_FINAL_CLTV,
1236         });
1237         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;
1238         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;
1239         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1240
1241         let mut hops = Vec::with_capacity(3);
1242         hops.push(RouteHop {
1243                 pubkey: nodes[3].node.get_our_node_id(),
1244                 node_features: NodeFeatures::empty(),
1245                 short_channel_id: chan_4.0.contents.short_channel_id,
1246                 channel_features: ChannelFeatures::empty(),
1247                 fee_msat: 0,
1248                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1249         });
1250         hops.push(RouteHop {
1251                 pubkey: nodes[2].node.get_our_node_id(),
1252                 node_features: NodeFeatures::empty(),
1253                 short_channel_id: chan_3.0.contents.short_channel_id,
1254                 channel_features: ChannelFeatures::empty(),
1255                 fee_msat: 0,
1256                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1257         });
1258         hops.push(RouteHop {
1259                 pubkey: nodes[1].node.get_our_node_id(),
1260                 node_features: NodeFeatures::empty(),
1261                 short_channel_id: chan_2.0.contents.short_channel_id,
1262                 channel_features: ChannelFeatures::empty(),
1263                 fee_msat: 1000000,
1264                 cltv_expiry_delta: TEST_FINAL_CLTV,
1265         });
1266         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;
1267         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;
1268         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1269
1270         // Claim the rebalances...
1271         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1272         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1273
1274         // Add a duplicate new channel from 2 to 4
1275         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1276
1277         // Send some payments across both channels
1278         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1280         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1281
1282
1283         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1284         let events = nodes[0].node.get_and_clear_pending_msg_events();
1285         assert_eq!(events.len(), 0);
1286         nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1287
1288         //TODO: Test that routes work again here as we've been notified that the channel is full
1289
1290         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1291         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1292         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1293
1294         // Close down the channels...
1295         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1296         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1297         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1298         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1299         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1300 }
1301
1302 #[test]
1303 fn holding_cell_htlc_counting() {
1304         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1305         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1306         // commitment dance rounds.
1307         let chanmon_cfgs = create_chanmon_cfgs(3);
1308         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1309         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1310         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1311         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1312         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1313         let logger = test_utils::TestLogger::new();
1314
1315         let mut payments = Vec::new();
1316         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1317                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1318                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1319                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1320                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1321                 payments.push((payment_preimage, payment_hash));
1322         }
1323         check_added_monitors!(nodes[1], 1);
1324
1325         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1326         assert_eq!(events.len(), 1);
1327         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1328         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1329
1330         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1331         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1332         // another HTLC.
1333         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1334         {
1335                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1336                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1337                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1338                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1339                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1340                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1341         }
1342
1343         // This should also be true if we try to forward a payment.
1344         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1345         {
1346                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1347                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1348                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1349                 check_added_monitors!(nodes[0], 1);
1350         }
1351
1352         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1353         assert_eq!(events.len(), 1);
1354         let payment_event = SendEvent::from_event(events.pop().unwrap());
1355         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1356
1357         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1358         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1359         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1360         // fails), the second will process the resulting failure and fail the HTLC backward.
1361         expect_pending_htlcs_forwardable!(nodes[1]);
1362         expect_pending_htlcs_forwardable!(nodes[1]);
1363         check_added_monitors!(nodes[1], 1);
1364
1365         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1366         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1367         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1368
1369         let events = nodes[0].node.get_and_clear_pending_msg_events();
1370         assert_eq!(events.len(), 1);
1371         match events[0] {
1372                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1373                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1374                 },
1375                 _ => panic!("Unexpected event"),
1376         }
1377
1378         expect_payment_failed!(nodes[0], payment_hash_2, false);
1379
1380         // Now forward all the pending HTLCs and claim them back
1381         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1382         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1383         check_added_monitors!(nodes[2], 1);
1384
1385         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1386         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1387         check_added_monitors!(nodes[1], 1);
1388         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1389
1390         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391         check_added_monitors!(nodes[1], 1);
1392         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1393
1394         for ref update in as_updates.update_add_htlcs.iter() {
1395                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1396         }
1397         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1398         check_added_monitors!(nodes[2], 1);
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1400         check_added_monitors!(nodes[2], 1);
1401         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1402
1403         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1404         check_added_monitors!(nodes[1], 1);
1405         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1406         check_added_monitors!(nodes[1], 1);
1407         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1408
1409         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1410         check_added_monitors!(nodes[2], 1);
1411
1412         expect_pending_htlcs_forwardable!(nodes[2]);
1413
1414         let events = nodes[2].node.get_and_clear_pending_events();
1415         assert_eq!(events.len(), payments.len());
1416         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1417                 match event {
1418                         &Event::PaymentReceived { ref payment_hash, .. } => {
1419                                 assert_eq!(*payment_hash, *hash);
1420                         },
1421                         _ => panic!("Unexpected event"),
1422                 };
1423         }
1424
1425         for (preimage, _) in payments.drain(..) {
1426                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1427         }
1428
1429         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1430 }
1431
1432 #[test]
1433 fn duplicate_htlc_test() {
1434         // Test that we accept duplicate payment_hash HTLCs across the network and that
1435         // claiming/failing them are all separate and don't affect each other
1436         let chanmon_cfgs = create_chanmon_cfgs(6);
1437         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1438         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1439         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1440
1441         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1442         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1443         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1444         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1445         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1446         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1447
1448         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1449
1450         *nodes[0].network_payment_count.borrow_mut() -= 1;
1451         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1452
1453         *nodes[0].network_payment_count.borrow_mut() -= 1;
1454         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1455
1456         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1457         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1458         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1459 }
1460
1461 #[test]
1462 fn test_duplicate_htlc_different_direction_onchain() {
1463         // Test that ChannelMonitor doesn't generate 2 preimage txn
1464         // when we have 2 HTLCs with same preimage that go across a node
1465         // in opposite directions.
1466         let chanmon_cfgs = create_chanmon_cfgs(2);
1467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1469         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1470
1471         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1472         let logger = test_utils::TestLogger::new();
1473
1474         // balancing
1475         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1476
1477         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1478
1479         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1480         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1481         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1482
1483         // Provide preimage to node 0 by claiming payment
1484         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1485         check_added_monitors!(nodes[0], 1);
1486
1487         // Broadcast node 1 commitment txn
1488         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1489
1490         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1491         let mut has_both_htlcs = 0; // check htlcs match ones committed
1492         for outp in remote_txn[0].output.iter() {
1493                 if outp.value == 800_000 / 1000 {
1494                         has_both_htlcs += 1;
1495                 } else if outp.value == 900_000 / 1000 {
1496                         has_both_htlcs += 1;
1497                 }
1498         }
1499         assert_eq!(has_both_htlcs, 2);
1500
1501         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1502         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1503         check_added_monitors!(nodes[0], 1);
1504
1505         // Check we only broadcast 1 timeout tx
1506         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1507         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()) };
1508         assert_eq!(claim_txn.len(), 5);
1509         check_spends!(claim_txn[2], chan_1.3);
1510         check_spends!(claim_txn[3], claim_txn[2]);
1511         assert_eq!(htlc_pair.0.input.len(), 1);
1512         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1513         check_spends!(htlc_pair.0, remote_txn[0]);
1514         assert_eq!(htlc_pair.1.input.len(), 1);
1515         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1516         check_spends!(htlc_pair.1, remote_txn[0]);
1517
1518         let events = nodes[0].node.get_and_clear_pending_msg_events();
1519         assert_eq!(events.len(), 2);
1520         for e in events {
1521                 match e {
1522                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1523                         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, .. } } => {
1524                                 assert!(update_add_htlcs.is_empty());
1525                                 assert!(update_fail_htlcs.is_empty());
1526                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1527                                 assert!(update_fail_malformed_htlcs.is_empty());
1528                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1529                         },
1530                         _ => panic!("Unexpected event"),
1531                 }
1532         }
1533 }
1534
1535 #[test]
1536 fn test_basic_channel_reserve() {
1537         let chanmon_cfgs = create_chanmon_cfgs(2);
1538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542         let logger = test_utils::TestLogger::new();
1543
1544         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545         let channel_reserve = chan_stat.channel_reserve_msat;
1546
1547         // The 2* and +1 are for the fee spike reserve.
1548         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1549         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1554         match err {
1555                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1556                         match &fails[0] {
1557                                 &APIError::ChannelUnavailable{ref err} =>
1558                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1559                                 _ => panic!("Unexpected error variant"),
1560                         }
1561                 },
1562                 _ => panic!("Unexpected error variant"),
1563         }
1564         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1566
1567         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1568 }
1569
1570 #[test]
1571 fn test_fee_spike_violation_fails_htlc() {
1572         let chanmon_cfgs = create_chanmon_cfgs(2);
1573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1577         let logger = test_utils::TestLogger::new();
1578
1579         macro_rules! get_route_and_payment_hash {
1580                 ($recv_value: expr) => {{
1581                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1582                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1583                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1584                         (route, payment_hash, payment_preimage)
1585                 }}
1586         };
1587
1588         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1589         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1590         let secp_ctx = Secp256k1::new();
1591         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1592
1593         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1594
1595         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1596         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1597         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1598         let msg = msgs::UpdateAddHTLC {
1599                 channel_id: chan.2,
1600                 htlc_id: 0,
1601                 amount_msat: htlc_msat,
1602                 payment_hash: payment_hash,
1603                 cltv_expiry: htlc_cltv,
1604                 onion_routing_packet: onion_packet,
1605         };
1606
1607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1608
1609         // Now manually create the commitment_signed message corresponding to the update_add
1610         // nodes[0] just sent. In the code for construction of this message, "local" refers
1611         // to the sender of the message, and "remote" refers to the receiver.
1612
1613         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1614
1615         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1616
1617         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1618         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1619         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1620                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1621                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622                 let chan_keys = local_chan.get_local_keys();
1623                 let pubkeys = chan_keys.pubkeys();
1624                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1625                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1626         };
1627         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1628                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1629                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1630                 let chan_keys = remote_chan.get_local_keys();
1631                 let pubkeys = chan_keys.pubkeys();
1632                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1633                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1634         };
1635
1636         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1637         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1638         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1639         let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1640                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1641
1642         // Build the remote commitment transaction so we can sign it, and then later use the
1643         // signature for the commitment_signed message.
1644         let local_chan_balance = 1313;
1645         let static_payment_pk = local_payment_point.serialize();
1646         let remote_commit_tx_output = TxOut {
1647                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1648                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1649                                                              .into_script(),
1650                 value: local_chan_balance as u64
1651         };
1652
1653         let local_commit_tx_output = TxOut {
1654                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1655                                                                                BREAKDOWN_TIMEOUT,
1656                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1657                                 value: 95000,
1658         };
1659
1660         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1661                 offered: false,
1662                 amount_msat: 3460001,
1663                 cltv_expiry: htlc_cltv,
1664                 payment_hash: payment_hash,
1665                 transaction_output_index: Some(1),
1666         };
1667
1668         let htlc_output = TxOut {
1669                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1670                 value: 3460001 / 1000
1671         };
1672
1673         let commit_tx_obscure_factor = {
1674                 let mut sha = Sha256::engine();
1675                 let remote_payment_point = &remote_payment_point.serialize();
1676                 sha.input(&local_payment_point.serialize());
1677                 sha.input(remote_payment_point);
1678                 let res = Sha256::from_engine(sha).into_inner();
1679
1680                 ((res[26] as u64) << 5*8) |
1681                 ((res[27] as u64) << 4*8) |
1682                 ((res[28] as u64) << 3*8) |
1683                 ((res[29] as u64) << 2*8) |
1684                 ((res[30] as u64) << 1*8) |
1685                 ((res[31] as u64) << 0*8)
1686         };
1687         let commitment_number = 1;
1688         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1689         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1690         let input = TxIn {
1691                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1692                 script_sig: Script::new(),
1693                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1694                 witness: Vec::new(),
1695         };
1696
1697         let commit_tx = Transaction {
1698                 version: 2,
1699                 lock_time,
1700                 input: vec![input],
1701                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1702         };
1703         let res = {
1704                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1705                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1706                 let local_chan_keys = local_chan.get_local_keys();
1707                 let pre_commit_tx_keys = PreCalculatedTxCreationKeys::new(commit_tx_keys);
1708                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &pre_commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1709         };
1710
1711         let commit_signed_msg = msgs::CommitmentSigned {
1712                 channel_id: chan.2,
1713                 signature: res.0,
1714                 htlc_signatures: res.1
1715         };
1716
1717         // Send the commitment_signed message to the nodes[1].
1718         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1719         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1720
1721         // Send the RAA to nodes[1].
1722         let per_commitment_secret = local_secret;
1723         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1724         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1725         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1726         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1727
1728         let events = nodes[1].node.get_and_clear_pending_msg_events();
1729         assert_eq!(events.len(), 1);
1730         // Make sure the HTLC failed in the way we expect.
1731         match events[0] {
1732                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1733                         assert_eq!(update_fail_htlcs.len(), 1);
1734                         update_fail_htlcs[0].clone()
1735                 },
1736                 _ => panic!("Unexpected event"),
1737         };
1738         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1739
1740         check_added_monitors!(nodes[1], 2);
1741 }
1742
1743 #[test]
1744 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1745         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1746         // Set the fee rate for the channel very high, to the point where the fundee
1747         // sending any amount would result in a channel reserve violation. In this test
1748         // we check that we would be prevented from sending an HTLC in this situation.
1749         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1750         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1751         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1752         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1753         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1754         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1755         let logger = test_utils::TestLogger::new();
1756
1757         macro_rules! get_route_and_payment_hash {
1758                 ($recv_value: expr) => {{
1759                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1760                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1761                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1762                         (route, payment_hash, payment_preimage)
1763                 }}
1764         };
1765
1766         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1767         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1768                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1769         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1770         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1771 }
1772
1773 #[test]
1774 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1775         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1776         // Set the fee rate for the channel very high, to the point where the funder
1777         // receiving 1 update_add_htlc would result in them closing the channel due
1778         // to channel reserve violation. This close could also happen if the fee went
1779         // up a more realistic amount, but many HTLCs were outstanding at the time of
1780         // the update_add_htlc.
1781         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1782         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1787         let logger = test_utils::TestLogger::new();
1788
1789         macro_rules! get_route_and_payment_hash {
1790                 ($recv_value: expr) => {{
1791                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1792                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1793                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1794                         (route, payment_hash, payment_preimage)
1795                 }}
1796         };
1797
1798         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1799         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1800         let secp_ctx = Secp256k1::new();
1801         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1802         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1803         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1804         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1805         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1806         let msg = msgs::UpdateAddHTLC {
1807                 channel_id: chan.2,
1808                 htlc_id: 1,
1809                 amount_msat: htlc_msat + 1,
1810                 payment_hash: payment_hash,
1811                 cltv_expiry: htlc_cltv,
1812                 onion_routing_packet: onion_packet,
1813         };
1814
1815         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1816         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1817         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1818         assert_eq!(nodes[0].node.list_channels().len(), 0);
1819         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1820         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1821         check_added_monitors!(nodes[0], 1);
1822 }
1823
1824 #[test]
1825 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1826         let chanmon_cfgs = create_chanmon_cfgs(3);
1827         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1828         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1829         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1830         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1831         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1832         let logger = test_utils::TestLogger::new();
1833
1834         macro_rules! get_route_and_payment_hash {
1835                 ($recv_value: expr) => {{
1836                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1837                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1838                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1839                         (route, payment_hash, payment_preimage)
1840                 }}
1841         };
1842
1843         let feemsat = 239;
1844         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1845         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1846         let feerate = get_feerate!(nodes[0], chan.2);
1847
1848         // Add a 2* and +1 for the fee spike reserve.
1849         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1850         let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1851         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1852
1853         // Add a pending HTLC.
1854         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1855         let payment_event_1 = {
1856                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1857                 check_added_monitors!(nodes[0], 1);
1858
1859                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1860                 assert_eq!(events.len(), 1);
1861                 SendEvent::from_event(events.remove(0))
1862         };
1863         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1864
1865         // Attempt to trigger a channel reserve violation --> payment failure.
1866         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1867         let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1868         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1869         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1870
1871         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1872         let secp_ctx = Secp256k1::new();
1873         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1874         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1875         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1876         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1877         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1878         let msg = msgs::UpdateAddHTLC {
1879                 channel_id: chan.2,
1880                 htlc_id: 1,
1881                 amount_msat: htlc_msat + 1,
1882                 payment_hash: our_payment_hash_1,
1883                 cltv_expiry: htlc_cltv,
1884                 onion_routing_packet: onion_packet,
1885         };
1886
1887         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1888         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1889         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1890         assert_eq!(nodes[1].node.list_channels().len(), 1);
1891         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1892         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1893         check_added_monitors!(nodes[1], 1);
1894 }
1895
1896 #[test]
1897 fn test_inbound_outbound_capacity_is_not_zero() {
1898         let chanmon_cfgs = create_chanmon_cfgs(2);
1899         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1900         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1901         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1902         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1903         let channels0 = node_chanmgrs[0].list_channels();
1904         let channels1 = node_chanmgrs[1].list_channels();
1905         assert_eq!(channels0.len(), 1);
1906         assert_eq!(channels1.len(), 1);
1907
1908         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1909         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1910
1911         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1912         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1913 }
1914
1915 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1916         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1917 }
1918
1919 #[test]
1920 fn test_channel_reserve_holding_cell_htlcs() {
1921         let chanmon_cfgs = create_chanmon_cfgs(3);
1922         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1923         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1924         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1925         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1926         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1927         let logger = test_utils::TestLogger::new();
1928
1929         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1930         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1931
1932         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1933         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1934
1935         macro_rules! get_route_and_payment_hash {
1936                 ($recv_value: expr) => {{
1937                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1938                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1939                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1940                         (route, payment_hash, payment_preimage)
1941                 }}
1942         };
1943
1944         macro_rules! expect_forward {
1945                 ($node: expr) => {{
1946                         let mut events = $node.node.get_and_clear_pending_msg_events();
1947                         assert_eq!(events.len(), 1);
1948                         check_added_monitors!($node, 1);
1949                         let payment_event = SendEvent::from_event(events.remove(0));
1950                         payment_event
1951                 }}
1952         }
1953
1954         let feemsat = 239; // somehow we know?
1955         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1956         let feerate = get_feerate!(nodes[0], chan_1.2);
1957
1958         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1959
1960         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1961         {
1962                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1963                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1964                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1965                         assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1966                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1967                 nodes[0].logger.assert_log_contains("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);
1968         }
1969
1970         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1971         // nodes[0]'s wealth
1972         loop {
1973                 let amt_msat = recv_value_0 + total_fee_msat;
1974                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1975                 // Also, ensure that each payment has enough to be over the dust limit to
1976                 // ensure it'll be included in each commit tx fee calculation.
1977                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1978                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1979                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1980                         break;
1981                 }
1982                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1983
1984                 let (stat01_, stat11_, stat12_, stat22_) = (
1985                         get_channel_value_stat!(nodes[0], chan_1.2),
1986                         get_channel_value_stat!(nodes[1], chan_1.2),
1987                         get_channel_value_stat!(nodes[1], chan_2.2),
1988                         get_channel_value_stat!(nodes[2], chan_2.2),
1989                 );
1990
1991                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1992                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1993                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1994                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1995                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1996         }
1997
1998         // adding pending output.
1999         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2000         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2001         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2002         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2003         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2004         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2005         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2006         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2007         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2008         // policy.
2009         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2010         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2011         let amt_msat_1 = recv_value_1 + total_fee_msat;
2012
2013         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2014         let payment_event_1 = {
2015                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2016                 check_added_monitors!(nodes[0], 1);
2017
2018                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2019                 assert_eq!(events.len(), 1);
2020                 SendEvent::from_event(events.remove(0))
2021         };
2022         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2023
2024         // channel reserve test with htlc pending output > 0
2025         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2026         {
2027                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2028                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2029                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2030                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2031         }
2032
2033         // split the rest to test holding cell
2034         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2035         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2036         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2037         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2038         {
2039                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2040                 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 + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
2041         }
2042
2043         // now see if they go through on both sides
2044         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2045         // but this will stuck in the holding cell
2046         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2047         check_added_monitors!(nodes[0], 0);
2048         let events = nodes[0].node.get_and_clear_pending_events();
2049         assert_eq!(events.len(), 0);
2050
2051         // test with outbound holding cell amount > 0
2052         {
2053                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2054                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2055                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2056                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2057                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
2058         }
2059
2060         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2061         // this will also stuck in the holding cell
2062         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2063         check_added_monitors!(nodes[0], 0);
2064         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2065         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2066
2067         // flush the pending htlc
2068         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2069         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2070         check_added_monitors!(nodes[1], 1);
2071
2072         // the pending htlc should be promoted to committed
2073         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2074         check_added_monitors!(nodes[0], 1);
2075         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2076
2077         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2078         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2079         // No commitment_signed so get_event_msg's assert(len == 1) passes
2080         check_added_monitors!(nodes[0], 1);
2081
2082         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2083         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2084         check_added_monitors!(nodes[1], 1);
2085
2086         expect_pending_htlcs_forwardable!(nodes[1]);
2087
2088         let ref payment_event_11 = expect_forward!(nodes[1]);
2089         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2090         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2091
2092         expect_pending_htlcs_forwardable!(nodes[2]);
2093         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2094
2095         // flush the htlcs in the holding cell
2096         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2097         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2098         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2099         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2100         expect_pending_htlcs_forwardable!(nodes[1]);
2101
2102         let ref payment_event_3 = expect_forward!(nodes[1]);
2103         assert_eq!(payment_event_3.msgs.len(), 2);
2104         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2105         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2106
2107         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2108         expect_pending_htlcs_forwardable!(nodes[2]);
2109
2110         let events = nodes[2].node.get_and_clear_pending_events();
2111         assert_eq!(events.len(), 2);
2112         match events[0] {
2113                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2114                         assert_eq!(our_payment_hash_21, *payment_hash);
2115                         assert_eq!(*payment_secret, None);
2116                         assert_eq!(recv_value_21, amt);
2117                 },
2118                 _ => panic!("Unexpected event"),
2119         }
2120         match events[1] {
2121                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2122                         assert_eq!(our_payment_hash_22, *payment_hash);
2123                         assert_eq!(None, *payment_secret);
2124                         assert_eq!(recv_value_22, amt);
2125                 },
2126                 _ => panic!("Unexpected event"),
2127         }
2128
2129         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2130         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2131         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2132
2133         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2134         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2135         {
2136                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2137                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2138                 match err {
2139                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2140                                 match &fails[0] {
2141                                         &APIError::ChannelUnavailable{ref err} =>
2142                                                 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2143                                         _ => panic!("Unexpected error variant"),
2144                                 }
2145                         },
2146                         _ => panic!("Unexpected error variant"),
2147                 }
2148                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2149                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
2150         }
2151
2152         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2153
2154         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2155         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) - (recv_value_3 + total_fee_msat);
2156         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2157         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2158         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2159
2160         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2161         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2162 }
2163
2164 #[test]
2165 fn channel_reserve_in_flight_removes() {
2166         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2167         // can send to its counterparty, but due to update ordering, the other side may not yet have
2168         // considered those HTLCs fully removed.
2169         // This tests that we don't count HTLCs which will not be included in the next remote
2170         // commitment transaction towards the reserve value (as it implies no commitment transaction
2171         // will be generated which violates the remote reserve value).
2172         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2173         // To test this we:
2174         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2175         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2176         //    you only consider the value of the first HTLC, it may not),
2177         //  * start routing a third HTLC from A to B,
2178         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2179         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2180         //  * deliver the first fulfill from B
2181         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2182         //    claim,
2183         //  * deliver A's response CS and RAA.
2184         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2185         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2186         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2187         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2188         let chanmon_cfgs = create_chanmon_cfgs(2);
2189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2191         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2192         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2193         let logger = test_utils::TestLogger::new();
2194
2195         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2196         // Route the first two HTLCs.
2197         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2198         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2199
2200         // Start routing the third HTLC (this is just used to get everyone in the right state).
2201         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2202         let send_1 = {
2203                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2204                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2205                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2206                 check_added_monitors!(nodes[0], 1);
2207                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2208                 assert_eq!(events.len(), 1);
2209                 SendEvent::from_event(events.remove(0))
2210         };
2211
2212         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2213         // initial fulfill/CS.
2214         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2215         check_added_monitors!(nodes[1], 1);
2216         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2217
2218         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2219         // remove the second HTLC when we send the HTLC back from B to A.
2220         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2221         check_added_monitors!(nodes[1], 1);
2222         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2223
2224         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2225         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2226         check_added_monitors!(nodes[0], 1);
2227         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2228         expect_payment_sent!(nodes[0], payment_preimage_1);
2229
2230         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2231         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2232         check_added_monitors!(nodes[1], 1);
2233         // B is already AwaitingRAA, so cant generate a CS here
2234         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2235
2236         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2237         check_added_monitors!(nodes[1], 1);
2238         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2239
2240         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2241         check_added_monitors!(nodes[0], 1);
2242         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2243
2244         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2245         check_added_monitors!(nodes[1], 1);
2246         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2247
2248         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2249         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2250         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2251         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2252         // on-chain as necessary).
2253         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2254         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2255         check_added_monitors!(nodes[0], 1);
2256         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2257         expect_payment_sent!(nodes[0], payment_preimage_2);
2258
2259         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2260         check_added_monitors!(nodes[1], 1);
2261         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2262
2263         expect_pending_htlcs_forwardable!(nodes[1]);
2264         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2265
2266         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2267         // resolve the second HTLC from A's point of view.
2268         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2269         check_added_monitors!(nodes[0], 1);
2270         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2271
2272         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2273         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2274         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2275         let send_2 = {
2276                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2277                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2278                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2279                 check_added_monitors!(nodes[1], 1);
2280                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2281                 assert_eq!(events.len(), 1);
2282                 SendEvent::from_event(events.remove(0))
2283         };
2284
2285         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2286         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2287         check_added_monitors!(nodes[0], 1);
2288         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2289
2290         // Now just resolve all the outstanding messages/HTLCs for completeness...
2291
2292         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2293         check_added_monitors!(nodes[1], 1);
2294         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2295
2296         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2297         check_added_monitors!(nodes[1], 1);
2298
2299         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2300         check_added_monitors!(nodes[0], 1);
2301         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2302
2303         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2304         check_added_monitors!(nodes[1], 1);
2305         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2306
2307         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2308         check_added_monitors!(nodes[0], 1);
2309
2310         expect_pending_htlcs_forwardable!(nodes[0]);
2311         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2312
2313         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2314         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2315 }
2316
2317 #[test]
2318 fn channel_monitor_network_test() {
2319         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2320         // tests that ChannelMonitor is able to recover from various states.
2321         let chanmon_cfgs = create_chanmon_cfgs(5);
2322         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2323         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2324         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2325
2326         // Create some initial channels
2327         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2328         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2329         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2330         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2331
2332         // Rebalance the network a bit by relaying one payment through all the channels...
2333         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2334         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2335         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2336         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2337
2338         // Simple case with no pending HTLCs:
2339         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2340         check_added_monitors!(nodes[1], 1);
2341         {
2342                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2343                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2344                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2345                 check_added_monitors!(nodes[0], 1);
2346                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2347         }
2348         get_announce_close_broadcast_events(&nodes, 0, 1);
2349         assert_eq!(nodes[0].node.list_channels().len(), 0);
2350         assert_eq!(nodes[1].node.list_channels().len(), 1);
2351
2352         // One pending HTLC is discarded by the force-close:
2353         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2354
2355         // Simple case of one pending HTLC to HTLC-Timeout
2356         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2357         check_added_monitors!(nodes[1], 1);
2358         {
2359                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2360                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2361                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2362                 check_added_monitors!(nodes[2], 1);
2363                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2364         }
2365         get_announce_close_broadcast_events(&nodes, 1, 2);
2366         assert_eq!(nodes[1].node.list_channels().len(), 0);
2367         assert_eq!(nodes[2].node.list_channels().len(), 1);
2368
2369         macro_rules! claim_funds {
2370                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2371                         {
2372                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2373                                 check_added_monitors!($node, 1);
2374
2375                                 let events = $node.node.get_and_clear_pending_msg_events();
2376                                 assert_eq!(events.len(), 1);
2377                                 match events[0] {
2378                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2379                                                 assert!(update_add_htlcs.is_empty());
2380                                                 assert!(update_fail_htlcs.is_empty());
2381                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2382                                         },
2383                                         _ => panic!("Unexpected event"),
2384                                 };
2385                         }
2386                 }
2387         }
2388
2389         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2390         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2391         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2392         check_added_monitors!(nodes[2], 1);
2393         let node2_commitment_txid;
2394         {
2395                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2396                 node2_commitment_txid = node_txn[0].txid();
2397
2398                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2399                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2400
2401                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2402                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2403                 check_added_monitors!(nodes[3], 1);
2404
2405                 check_preimage_claim(&nodes[3], &node_txn);
2406         }
2407         get_announce_close_broadcast_events(&nodes, 2, 3);
2408         assert_eq!(nodes[2].node.list_channels().len(), 0);
2409         assert_eq!(nodes[3].node.list_channels().len(), 1);
2410
2411         { // Cheat and reset nodes[4]'s height to 1
2412                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2413                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2414         }
2415
2416         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2417         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2418         // One pending HTLC to time out:
2419         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2420         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2421         // buffer space).
2422
2423         {
2424                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2425                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2426                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2427                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2428                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2429                 }
2430                 check_added_monitors!(nodes[3], 1);
2431
2432                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2433                 {
2434                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2435                         node_txn.retain(|tx| {
2436                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2437                                         false
2438                                 } else { true }
2439                         });
2440                 }
2441
2442                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2443
2444                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2445                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2446
2447                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2448
2449                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2450                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2451                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2452                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2453                 }
2454
2455                 check_added_monitors!(nodes[4], 1);
2456                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2457
2458                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2459                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2460
2461                 check_preimage_claim(&nodes[4], &node_txn);
2462         }
2463         get_announce_close_broadcast_events(&nodes, 3, 4);
2464         assert_eq!(nodes[3].node.list_channels().len(), 0);
2465         assert_eq!(nodes[4].node.list_channels().len(), 0);
2466 }
2467
2468 #[test]
2469 fn test_justice_tx() {
2470         // Test justice txn built on revoked HTLC-Success tx, against both sides
2471         let mut alice_config = UserConfig::default();
2472         alice_config.channel_options.announced_channel = true;
2473         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2474         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2475         let mut bob_config = UserConfig::default();
2476         bob_config.channel_options.announced_channel = true;
2477         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2478         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2479         let user_cfgs = [Some(alice_config), Some(bob_config)];
2480         let chanmon_cfgs = create_chanmon_cfgs(2);
2481         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2482         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2483         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2484         // Create some new channels:
2485         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2486
2487         // A pending HTLC which will be revoked:
2488         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2489         // Get the will-be-revoked local txn from nodes[0]
2490         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2491         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2492         assert_eq!(revoked_local_txn[0].input.len(), 1);
2493         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2494         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2495         assert_eq!(revoked_local_txn[1].input.len(), 1);
2496         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2497         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2498         // Revoke the old state
2499         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2500
2501         {
2502                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2503                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2504                 {
2505                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2506                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2507                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2508
2509                         check_spends!(node_txn[0], revoked_local_txn[0]);
2510                         node_txn.swap_remove(0);
2511                         node_txn.truncate(1);
2512                 }
2513                 check_added_monitors!(nodes[1], 1);
2514                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2515
2516                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2517                 // Verify broadcast of revoked HTLC-timeout
2518                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2519                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2520                 check_added_monitors!(nodes[0], 1);
2521                 // Broadcast revoked HTLC-timeout on node 1
2522                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2523                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2524         }
2525         get_announce_close_broadcast_events(&nodes, 0, 1);
2526
2527         assert_eq!(nodes[0].node.list_channels().len(), 0);
2528         assert_eq!(nodes[1].node.list_channels().len(), 0);
2529
2530         // We test justice_tx build by A on B's revoked HTLC-Success tx
2531         // Create some new channels:
2532         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2533         {
2534                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2535                 node_txn.clear();
2536         }
2537
2538         // A pending HTLC which will be revoked:
2539         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2540         // Get the will-be-revoked local txn from B
2541         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2542         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2543         assert_eq!(revoked_local_txn[0].input.len(), 1);
2544         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2545         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2546         // Revoke the old state
2547         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2548         {
2549                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2550                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2551                 {
2552                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2553                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2554                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2555
2556                         check_spends!(node_txn[0], revoked_local_txn[0]);
2557                         node_txn.swap_remove(0);
2558                 }
2559                 check_added_monitors!(nodes[0], 1);
2560                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2561
2562                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2563                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2564                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2565                 check_added_monitors!(nodes[1], 1);
2566                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2567                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2568         }
2569         get_announce_close_broadcast_events(&nodes, 0, 1);
2570         assert_eq!(nodes[0].node.list_channels().len(), 0);
2571         assert_eq!(nodes[1].node.list_channels().len(), 0);
2572 }
2573
2574 #[test]
2575 fn revoked_output_claim() {
2576         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2577         // transaction is broadcast by its counterparty
2578         let chanmon_cfgs = create_chanmon_cfgs(2);
2579         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2580         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2581         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2582         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2583         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2584         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2585         assert_eq!(revoked_local_txn.len(), 1);
2586         // Only output is the full channel value back to nodes[0]:
2587         assert_eq!(revoked_local_txn[0].output.len(), 1);
2588         // Send a payment through, updating everyone's latest commitment txn
2589         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2590
2591         // Inform nodes[1] that nodes[0] broadcast a stale tx
2592         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2593         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2594         check_added_monitors!(nodes[1], 1);
2595         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2596         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2597
2598         check_spends!(node_txn[0], revoked_local_txn[0]);
2599         check_spends!(node_txn[1], chan_1.3);
2600
2601         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2602         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2603         get_announce_close_broadcast_events(&nodes, 0, 1);
2604         check_added_monitors!(nodes[0], 1)
2605 }
2606
2607 #[test]
2608 fn claim_htlc_outputs_shared_tx() {
2609         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2610         let chanmon_cfgs = create_chanmon_cfgs(2);
2611         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2613         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2614
2615         // Create some new channel:
2616         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2617
2618         // Rebalance the network to generate htlc in the two directions
2619         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2620         // 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
2621         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2622         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2623
2624         // Get the will-be-revoked local txn from node[0]
2625         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2626         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2627         assert_eq!(revoked_local_txn[0].input.len(), 1);
2628         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2629         assert_eq!(revoked_local_txn[1].input.len(), 1);
2630         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2631         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2632         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2633
2634         //Revoke the old state
2635         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2636
2637         {
2638                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2639                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2640                 check_added_monitors!(nodes[0], 1);
2641                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2642                 check_added_monitors!(nodes[1], 1);
2643                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2644                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2645
2646                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2647                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2648
2649                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2650                 check_spends!(node_txn[0], revoked_local_txn[0]);
2651
2652                 let mut witness_lens = BTreeSet::new();
2653                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2654                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2655                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2656                 assert_eq!(witness_lens.len(), 3);
2657                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2658                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2659                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2660
2661                 // Next nodes[1] broadcasts its current local tx state:
2662                 assert_eq!(node_txn[1].input.len(), 1);
2663                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2664
2665                 assert_eq!(node_txn[2].input.len(), 1);
2666                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2667                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2668                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2669                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2670                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2671         }
2672         get_announce_close_broadcast_events(&nodes, 0, 1);
2673         assert_eq!(nodes[0].node.list_channels().len(), 0);
2674         assert_eq!(nodes[1].node.list_channels().len(), 0);
2675 }
2676
2677 #[test]
2678 fn claim_htlc_outputs_single_tx() {
2679         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2680         let chanmon_cfgs = create_chanmon_cfgs(2);
2681         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2682         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2683         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2684
2685         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2686
2687         // Rebalance the network to generate htlc in the two directions
2688         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2689         // 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
2690         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2691         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2692         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2693
2694         // Get the will-be-revoked local txn from node[0]
2695         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2696
2697         //Revoke the old state
2698         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2699
2700         {
2701                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2702                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2703                 check_added_monitors!(nodes[0], 1);
2704                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2705                 check_added_monitors!(nodes[1], 1);
2706                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2707
2708                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2709                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2710
2711                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2712                 assert_eq!(node_txn.len(), 9);
2713                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2714                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2715                 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2716                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2717
2718                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2719                 assert_eq!(node_txn[2].input.len(), 1);
2720                 check_spends!(node_txn[2], chan_1.3);
2721                 assert_eq!(node_txn[3].input.len(), 1);
2722                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2723                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2724                 check_spends!(node_txn[3], node_txn[2]);
2725
2726                 // Justice transactions are indices 1-2-4
2727                 assert_eq!(node_txn[0].input.len(), 1);
2728                 assert_eq!(node_txn[1].input.len(), 1);
2729                 assert_eq!(node_txn[4].input.len(), 1);
2730
2731                 check_spends!(node_txn[0], revoked_local_txn[0]);
2732                 check_spends!(node_txn[1], revoked_local_txn[0]);
2733                 check_spends!(node_txn[4], revoked_local_txn[0]);
2734
2735                 let mut witness_lens = BTreeSet::new();
2736                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2737                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2738                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2739                 assert_eq!(witness_lens.len(), 3);
2740                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2741                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2742                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2743         }
2744         get_announce_close_broadcast_events(&nodes, 0, 1);
2745         assert_eq!(nodes[0].node.list_channels().len(), 0);
2746         assert_eq!(nodes[1].node.list_channels().len(), 0);
2747 }
2748
2749 #[test]
2750 fn test_htlc_on_chain_success() {
2751         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2752         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2753         // broadcasting the right event to other nodes in payment path.
2754         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2755         // A --------------------> B ----------------------> C (preimage)
2756         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2757         // commitment transaction was broadcast.
2758         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2759         // towards B.
2760         // B should be able to claim via preimage if A then broadcasts its local tx.
2761         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2762         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2763         // PaymentSent event).
2764
2765         let chanmon_cfgs = create_chanmon_cfgs(3);
2766         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2767         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2768         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2769
2770         // Create some initial channels
2771         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2772         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2773
2774         // Rebalance the network a bit by relaying one payment through all the channels...
2775         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2776         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2777
2778         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2779         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2780         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2781
2782         // Broadcast legit commitment tx from C on B's chain
2783         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2784         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2785         assert_eq!(commitment_tx.len(), 1);
2786         check_spends!(commitment_tx[0], chan_2.3);
2787         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2788         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2789         check_added_monitors!(nodes[2], 2);
2790         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2791         assert!(updates.update_add_htlcs.is_empty());
2792         assert!(updates.update_fail_htlcs.is_empty());
2793         assert!(updates.update_fail_malformed_htlcs.is_empty());
2794         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2795
2796         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2797         check_closed_broadcast!(nodes[2], false);
2798         check_added_monitors!(nodes[2], 1);
2799         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2800         assert_eq!(node_txn.len(), 5);
2801         assert_eq!(node_txn[0], node_txn[3]);
2802         assert_eq!(node_txn[1], node_txn[4]);
2803         assert_eq!(node_txn[2], commitment_tx[0]);
2804         check_spends!(node_txn[0], commitment_tx[0]);
2805         check_spends!(node_txn[1], commitment_tx[0]);
2806         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2807         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2808         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2809         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2810         assert_eq!(node_txn[0].lock_time, 0);
2811         assert_eq!(node_txn[1].lock_time, 0);
2812
2813         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2814         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2815         {
2816                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2817                 assert_eq!(added_monitors.len(), 1);
2818                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2819                 added_monitors.clear();
2820         }
2821         let events = nodes[1].node.get_and_clear_pending_msg_events();
2822         {
2823                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2824                 assert_eq!(added_monitors.len(), 2);
2825                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2826                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2827                 added_monitors.clear();
2828         }
2829         assert_eq!(events.len(), 2);
2830         match events[0] {
2831                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2832                 _ => panic!("Unexpected event"),
2833         }
2834         match events[1] {
2835                 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, .. } } => {
2836                         assert!(update_add_htlcs.is_empty());
2837                         assert!(update_fail_htlcs.is_empty());
2838                         assert_eq!(update_fulfill_htlcs.len(), 1);
2839                         assert!(update_fail_malformed_htlcs.is_empty());
2840                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2841                 },
2842                 _ => panic!("Unexpected event"),
2843         };
2844         macro_rules! check_tx_local_broadcast {
2845                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2846                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2847                         assert_eq!(node_txn.len(), 5);
2848                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2849                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2850                         check_spends!(node_txn[0], $commitment_tx);
2851                         check_spends!(node_txn[1], $commitment_tx);
2852                         assert_ne!(node_txn[0].lock_time, 0);
2853                         assert_ne!(node_txn[1].lock_time, 0);
2854                         if $htlc_offered {
2855                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2856                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2857                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2858                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2859                         } else {
2860                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2861                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2862                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2863                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2864                         }
2865                         check_spends!(node_txn[2], $chan_tx);
2866                         check_spends!(node_txn[3], node_txn[2]);
2867                         check_spends!(node_txn[4], node_txn[2]);
2868                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2869                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2870                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2871                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2872                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2873                         assert_ne!(node_txn[3].lock_time, 0);
2874                         assert_ne!(node_txn[4].lock_time, 0);
2875                         node_txn.clear();
2876                 } }
2877         }
2878         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2879         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2880         // timeout-claim of the output that nodes[2] just claimed via success.
2881         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2882
2883         // Broadcast legit commitment tx from A on B's chain
2884         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2885         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2886         check_spends!(commitment_tx[0], chan_1.3);
2887         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2888         check_closed_broadcast!(nodes[1], false);
2889         check_added_monitors!(nodes[1], 1);
2890         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2891         assert_eq!(node_txn.len(), 4);
2892         check_spends!(node_txn[0], commitment_tx[0]);
2893         assert_eq!(node_txn[0].input.len(), 2);
2894         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2895         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2896         assert_eq!(node_txn[0].lock_time, 0);
2897         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2898         check_spends!(node_txn[1], chan_1.3);
2899         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2900         check_spends!(node_txn[2], node_txn[1]);
2901         check_spends!(node_txn[3], node_txn[1]);
2902         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2903         // we already checked the same situation with A.
2904
2905         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2906         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2907         check_closed_broadcast!(nodes[0], false);
2908         check_added_monitors!(nodes[0], 1);
2909         let events = nodes[0].node.get_and_clear_pending_events();
2910         assert_eq!(events.len(), 2);
2911         let mut first_claimed = false;
2912         for event in events {
2913                 match event {
2914                         Event::PaymentSent { payment_preimage } => {
2915                                 if payment_preimage == our_payment_preimage {
2916                                         assert!(!first_claimed);
2917                                         first_claimed = true;
2918                                 } else {
2919                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2920                                 }
2921                         },
2922                         _ => panic!("Unexpected event"),
2923                 }
2924         }
2925         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2926 }
2927
2928 #[test]
2929 fn test_htlc_on_chain_timeout() {
2930         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2931         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2932         // broadcasting the right event to other nodes in payment path.
2933         // A ------------------> B ----------------------> C (timeout)
2934         //    B's commitment tx                 C's commitment tx
2935         //            \                                  \
2936         //         B's HTLC timeout tx               B's timeout tx
2937
2938         let chanmon_cfgs = create_chanmon_cfgs(3);
2939         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2940         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2941         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2942
2943         // Create some intial channels
2944         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2945         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2946
2947         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2948         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2949         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2950
2951         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2952         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2953
2954         // Broadcast legit commitment tx from C on B's chain
2955         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2956         check_spends!(commitment_tx[0], chan_2.3);
2957         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2958         check_added_monitors!(nodes[2], 0);
2959         expect_pending_htlcs_forwardable!(nodes[2]);
2960         check_added_monitors!(nodes[2], 1);
2961
2962         let events = nodes[2].node.get_and_clear_pending_msg_events();
2963         assert_eq!(events.len(), 1);
2964         match events[0] {
2965                 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, .. } } => {
2966                         assert!(update_add_htlcs.is_empty());
2967                         assert!(!update_fail_htlcs.is_empty());
2968                         assert!(update_fulfill_htlcs.is_empty());
2969                         assert!(update_fail_malformed_htlcs.is_empty());
2970                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2971                 },
2972                 _ => panic!("Unexpected event"),
2973         };
2974         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2975         check_closed_broadcast!(nodes[2], false);
2976         check_added_monitors!(nodes[2], 1);
2977         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2978         assert_eq!(node_txn.len(), 1);
2979         check_spends!(node_txn[0], chan_2.3);
2980         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2981
2982         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2983         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2984         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2985         let timeout_tx;
2986         {
2987                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2988                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2989                 assert_eq!(node_txn[1], node_txn[3]);
2990                 assert_eq!(node_txn[2], node_txn[4]);
2991
2992                 check_spends!(node_txn[0], commitment_tx[0]);
2993                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2994
2995                 check_spends!(node_txn[1], chan_2.3);
2996                 check_spends!(node_txn[2], node_txn[1]);
2997                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2998                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2999
3000                 timeout_tx = node_txn[0].clone();
3001                 node_txn.clear();
3002         }
3003
3004         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
3005         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3006         check_added_monitors!(nodes[1], 1);
3007         check_closed_broadcast!(nodes[1], false);
3008
3009         expect_pending_htlcs_forwardable!(nodes[1]);
3010         check_added_monitors!(nodes[1], 1);
3011         let events = nodes[1].node.get_and_clear_pending_msg_events();
3012         assert_eq!(events.len(), 1);
3013         match events[0] {
3014                 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, .. } } => {
3015                         assert!(update_add_htlcs.is_empty());
3016                         assert!(!update_fail_htlcs.is_empty());
3017                         assert!(update_fulfill_htlcs.is_empty());
3018                         assert!(update_fail_malformed_htlcs.is_empty());
3019                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3020                 },
3021                 _ => panic!("Unexpected event"),
3022         };
3023         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
3024         assert_eq!(node_txn.len(), 0);
3025
3026         // Broadcast legit commitment tx from B on A's chain
3027         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3028         check_spends!(commitment_tx[0], chan_1.3);
3029
3030         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3031         check_closed_broadcast!(nodes[0], false);
3032         check_added_monitors!(nodes[0], 1);
3033         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3034         assert_eq!(node_txn.len(), 3);
3035         check_spends!(node_txn[0], commitment_tx[0]);
3036         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3037         check_spends!(node_txn[1], chan_1.3);
3038         check_spends!(node_txn[2], node_txn[1]);
3039         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3040         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3041 }
3042
3043 #[test]
3044 fn test_simple_commitment_revoked_fail_backward() {
3045         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3046         // and fail backward accordingly.
3047
3048         let chanmon_cfgs = create_chanmon_cfgs(3);
3049         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3050         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3051         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3052
3053         // Create some initial channels
3054         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3055         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3056
3057         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3058         // Get the will-be-revoked local txn from nodes[2]
3059         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3060         // Revoke the old state
3061         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3062
3063         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3064
3065         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3066         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3067         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3068         check_added_monitors!(nodes[1], 1);
3069         check_closed_broadcast!(nodes[1], false);
3070
3071         expect_pending_htlcs_forwardable!(nodes[1]);
3072         check_added_monitors!(nodes[1], 1);
3073         let events = nodes[1].node.get_and_clear_pending_msg_events();
3074         assert_eq!(events.len(), 1);
3075         match events[0] {
3076                 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, .. } } => {
3077                         assert!(update_add_htlcs.is_empty());
3078                         assert_eq!(update_fail_htlcs.len(), 1);
3079                         assert!(update_fulfill_htlcs.is_empty());
3080                         assert!(update_fail_malformed_htlcs.is_empty());
3081                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3082
3083                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3084                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3085
3086                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3087                         assert_eq!(events.len(), 1);
3088                         match events[0] {
3089                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3090                                 _ => panic!("Unexpected event"),
3091                         }
3092                         expect_payment_failed!(nodes[0], payment_hash, false);
3093                 },
3094                 _ => panic!("Unexpected event"),
3095         }
3096 }
3097
3098 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3099         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3100         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3101         // commitment transaction anymore.
3102         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3103         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3104         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3105         // technically disallowed and we should probably handle it reasonably.
3106         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3107         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3108         // transactions:
3109         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3110         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3111         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3112         //   and once they revoke the previous commitment transaction (allowing us to send a new
3113         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3114         let chanmon_cfgs = create_chanmon_cfgs(3);
3115         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3116         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3117         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3118
3119         // Create some initial channels
3120         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3121         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3122
3123         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3124         // Get the will-be-revoked local txn from nodes[2]
3125         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3126         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3127         // Revoke the old state
3128         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3129
3130         let value = if use_dust {
3131                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3132                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3133                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3134         } else { 3000000 };
3135
3136         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3137         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3138         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3139
3140         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3141         expect_pending_htlcs_forwardable!(nodes[2]);
3142         check_added_monitors!(nodes[2], 1);
3143         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3144         assert!(updates.update_add_htlcs.is_empty());
3145         assert!(updates.update_fulfill_htlcs.is_empty());
3146         assert!(updates.update_fail_malformed_htlcs.is_empty());
3147         assert_eq!(updates.update_fail_htlcs.len(), 1);
3148         assert!(updates.update_fee.is_none());
3149         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3150         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3151         // Drop the last RAA from 3 -> 2
3152
3153         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3154         expect_pending_htlcs_forwardable!(nodes[2]);
3155         check_added_monitors!(nodes[2], 1);
3156         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3157         assert!(updates.update_add_htlcs.is_empty());
3158         assert!(updates.update_fulfill_htlcs.is_empty());
3159         assert!(updates.update_fail_malformed_htlcs.is_empty());
3160         assert_eq!(updates.update_fail_htlcs.len(), 1);
3161         assert!(updates.update_fee.is_none());
3162         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3163         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3164         check_added_monitors!(nodes[1], 1);
3165         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3166         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3167         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3168         check_added_monitors!(nodes[2], 1);
3169
3170         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3171         expect_pending_htlcs_forwardable!(nodes[2]);
3172         check_added_monitors!(nodes[2], 1);
3173         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3174         assert!(updates.update_add_htlcs.is_empty());
3175         assert!(updates.update_fulfill_htlcs.is_empty());
3176         assert!(updates.update_fail_malformed_htlcs.is_empty());
3177         assert_eq!(updates.update_fail_htlcs.len(), 1);
3178         assert!(updates.update_fee.is_none());
3179         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3180         // At this point first_payment_hash has dropped out of the latest two commitment
3181         // transactions that nodes[1] is tracking...
3182         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3183         check_added_monitors!(nodes[1], 1);
3184         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3185         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3186         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3187         check_added_monitors!(nodes[2], 1);
3188
3189         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3190         // on nodes[2]'s RAA.
3191         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3192         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3193         let logger = test_utils::TestLogger::new();
3194         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3195         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3196         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3197         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3198         check_added_monitors!(nodes[1], 0);
3199
3200         if deliver_bs_raa {
3201                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3202                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3203                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3204                 check_added_monitors!(nodes[1], 1);
3205                 let events = nodes[1].node.get_and_clear_pending_events();
3206                 assert_eq!(events.len(), 1);
3207                 match events[0] {
3208                         Event::PendingHTLCsForwardable { .. } => { },
3209                         _ => panic!("Unexpected event"),
3210                 };
3211                 // Deliberately don't process the pending fail-back so they all fail back at once after
3212                 // block connection just like the !deliver_bs_raa case
3213         }
3214
3215         let mut failed_htlcs = HashSet::new();
3216         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3217
3218         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3219         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3220         check_added_monitors!(nodes[1], 1);
3221         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3222
3223         let events = nodes[1].node.get_and_clear_pending_events();
3224         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3225         match events[0] {
3226                 Event::PaymentFailed { ref payment_hash, .. } => {
3227                         assert_eq!(*payment_hash, fourth_payment_hash);
3228                 },
3229                 _ => panic!("Unexpected event"),
3230         }
3231         if !deliver_bs_raa {
3232                 match events[1] {
3233                         Event::PendingHTLCsForwardable { .. } => { },
3234                         _ => panic!("Unexpected event"),
3235                 };
3236         }
3237         nodes[1].node.process_pending_htlc_forwards();
3238         check_added_monitors!(nodes[1], 1);
3239
3240         let events = nodes[1].node.get_and_clear_pending_msg_events();
3241         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3242         match events[if deliver_bs_raa { 1 } else { 0 }] {
3243                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3244                 _ => panic!("Unexpected event"),
3245         }
3246         if deliver_bs_raa {
3247                 match events[0] {
3248                         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, .. } } => {
3249                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3250                                 assert_eq!(update_add_htlcs.len(), 1);
3251                                 assert!(update_fulfill_htlcs.is_empty());
3252                                 assert!(update_fail_htlcs.is_empty());
3253                                 assert!(update_fail_malformed_htlcs.is_empty());
3254                         },
3255                         _ => panic!("Unexpected event"),
3256                 }
3257         }
3258         match events[if deliver_bs_raa { 2 } else { 1 }] {
3259                 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, .. } } => {
3260                         assert!(update_add_htlcs.is_empty());
3261                         assert_eq!(update_fail_htlcs.len(), 3);
3262                         assert!(update_fulfill_htlcs.is_empty());
3263                         assert!(update_fail_malformed_htlcs.is_empty());
3264                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3265
3266                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3267                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3268                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3269
3270                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3271
3272                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3273                         // If we delivered B's RAA we got an unknown preimage error, not something
3274                         // that we should update our routing table for.
3275                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3276                         for event in events {
3277                                 match event {
3278                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3279                                         _ => panic!("Unexpected event"),
3280                                 }
3281                         }
3282                         let events = nodes[0].node.get_and_clear_pending_events();
3283                         assert_eq!(events.len(), 3);
3284                         match events[0] {
3285                                 Event::PaymentFailed { ref payment_hash, .. } => {
3286                                         assert!(failed_htlcs.insert(payment_hash.0));
3287                                 },
3288                                 _ => panic!("Unexpected event"),
3289                         }
3290                         match events[1] {
3291                                 Event::PaymentFailed { ref payment_hash, .. } => {
3292                                         assert!(failed_htlcs.insert(payment_hash.0));
3293                                 },
3294                                 _ => panic!("Unexpected event"),
3295                         }
3296                         match events[2] {
3297                                 Event::PaymentFailed { ref payment_hash, .. } => {
3298                                         assert!(failed_htlcs.insert(payment_hash.0));
3299                                 },
3300                                 _ => panic!("Unexpected event"),
3301                         }
3302                 },
3303                 _ => panic!("Unexpected event"),
3304         }
3305
3306         assert!(failed_htlcs.contains(&first_payment_hash.0));
3307         assert!(failed_htlcs.contains(&second_payment_hash.0));
3308         assert!(failed_htlcs.contains(&third_payment_hash.0));
3309 }
3310
3311 #[test]
3312 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3313         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3314         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3315         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3316         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3317 }
3318
3319 #[test]
3320 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3321         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3322         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3323         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3324         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3325 }
3326
3327 #[test]
3328 fn fail_backward_pending_htlc_upon_channel_failure() {
3329         let chanmon_cfgs = create_chanmon_cfgs(2);
3330         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3331         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3332         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3333         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3334         let logger = test_utils::TestLogger::new();
3335
3336         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3337         {
3338                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3339                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3340                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3341                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3342                 check_added_monitors!(nodes[0], 1);
3343
3344                 let payment_event = {
3345                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3346                         assert_eq!(events.len(), 1);
3347                         SendEvent::from_event(events.remove(0))
3348                 };
3349                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3350                 assert_eq!(payment_event.msgs.len(), 1);
3351         }
3352
3353         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3354         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3355         {
3356                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3357                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3358                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3359                 check_added_monitors!(nodes[0], 0);
3360
3361                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3362         }
3363
3364         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3365         {
3366                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3367
3368                 let secp_ctx = Secp256k1::new();
3369                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3370                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3371                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3372                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3373                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3374                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3375                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3376
3377                 // Send a 0-msat update_add_htlc to fail the channel.
3378                 let update_add_htlc = msgs::UpdateAddHTLC {
3379                         channel_id: chan.2,
3380                         htlc_id: 0,
3381                         amount_msat: 0,
3382                         payment_hash,
3383                         cltv_expiry,
3384                         onion_routing_packet,
3385                 };
3386                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3387         }
3388
3389         // Check that Alice fails backward the pending HTLC from the second payment.
3390         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3391         check_closed_broadcast!(nodes[0], true);
3392         check_added_monitors!(nodes[0], 1);
3393 }
3394
3395 #[test]
3396 fn test_htlc_ignore_latest_remote_commitment() {
3397         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3398         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3399         let chanmon_cfgs = create_chanmon_cfgs(2);
3400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3402         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3403         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3404
3405         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3406         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3407         check_closed_broadcast!(nodes[0], false);
3408         check_added_monitors!(nodes[0], 1);
3409
3410         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3411         assert_eq!(node_txn.len(), 2);
3412
3413         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3414         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3415         check_closed_broadcast!(nodes[1], false);
3416         check_added_monitors!(nodes[1], 1);
3417
3418         // Duplicate the block_connected call since this may happen due to other listeners
3419         // registering new transactions
3420         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3421 }
3422
3423 #[test]
3424 fn test_force_close_fail_back() {
3425         // Check which HTLCs are failed-backwards on channel force-closure
3426         let chanmon_cfgs = create_chanmon_cfgs(3);
3427         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3428         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3429         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3430         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3431         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3432         let logger = test_utils::TestLogger::new();
3433
3434         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3435
3436         let mut payment_event = {
3437                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3438                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3439                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3440                 check_added_monitors!(nodes[0], 1);
3441
3442                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3443                 assert_eq!(events.len(), 1);
3444                 SendEvent::from_event(events.remove(0))
3445         };
3446
3447         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3448         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3449
3450         expect_pending_htlcs_forwardable!(nodes[1]);
3451
3452         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3453         assert_eq!(events_2.len(), 1);
3454         payment_event = SendEvent::from_event(events_2.remove(0));
3455         assert_eq!(payment_event.msgs.len(), 1);
3456
3457         check_added_monitors!(nodes[1], 1);
3458         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3459         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3460         check_added_monitors!(nodes[2], 1);
3461         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3462
3463         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3464         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3465         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3466
3467         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3468         check_closed_broadcast!(nodes[2], false);
3469         check_added_monitors!(nodes[2], 1);
3470         let tx = {
3471                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3472                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3473                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3474                 // back to nodes[1] upon timeout otherwise.
3475                 assert_eq!(node_txn.len(), 1);
3476                 node_txn.remove(0)
3477         };
3478
3479         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3480         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3481
3482         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3483         check_closed_broadcast!(nodes[1], false);
3484         check_added_monitors!(nodes[1], 1);
3485
3486         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3487         {
3488                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3489                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3490                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3491         }
3492         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3493         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3494         assert_eq!(node_txn.len(), 1);
3495         assert_eq!(node_txn[0].input.len(), 1);
3496         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3497         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3498         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3499
3500         check_spends!(node_txn[0], tx);
3501 }
3502
3503 #[test]
3504 fn test_unconf_chan() {
3505         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3506         let chanmon_cfgs = create_chanmon_cfgs(2);
3507         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3508         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3509         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3510         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3511
3512         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3513         assert_eq!(channel_state.by_id.len(), 1);
3514         assert_eq!(channel_state.short_to_id.len(), 1);
3515         mem::drop(channel_state);
3516
3517         let mut headers = Vec::new();
3518         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3519         headers.push(header.clone());
3520         for _i in 2..100 {
3521                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3522                 headers.push(header.clone());
3523         }
3524         let mut height = 99;
3525         while !headers.is_empty() {
3526                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3527                 height -= 1;
3528         }
3529         check_closed_broadcast!(nodes[0], false);
3530         check_added_monitors!(nodes[0], 1);
3531         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3532         assert_eq!(channel_state.by_id.len(), 0);
3533         assert_eq!(channel_state.short_to_id.len(), 0);
3534 }
3535
3536 #[test]
3537 fn test_simple_peer_disconnect() {
3538         // Test that we can reconnect when there are no lost messages
3539         let chanmon_cfgs = create_chanmon_cfgs(3);
3540         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3541         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3542         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3543         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3544         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3545
3546         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3547         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3548         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3549
3550         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3551         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3552         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3553         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3554
3555         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3556         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3558
3559         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3560         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3561         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3562         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3563
3564         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3565         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3566
3567         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3568         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3569
3570         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3571         {
3572                 let events = nodes[0].node.get_and_clear_pending_events();
3573                 assert_eq!(events.len(), 2);
3574                 match events[0] {
3575                         Event::PaymentSent { payment_preimage } => {
3576                                 assert_eq!(payment_preimage, payment_preimage_3);
3577                         },
3578                         _ => panic!("Unexpected event"),
3579                 }
3580                 match events[1] {
3581                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3582                                 assert_eq!(payment_hash, payment_hash_5);
3583                                 assert!(rejected_by_dest);
3584                         },
3585                         _ => panic!("Unexpected event"),
3586                 }
3587         }
3588
3589         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3590         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3591 }
3592
3593 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3594         // Test that we can reconnect when in-flight HTLC updates get dropped
3595         let chanmon_cfgs = create_chanmon_cfgs(2);
3596         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3597         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3598         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3599         if messages_delivered == 0 {
3600                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3601                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3602         } else {
3603                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3604         }
3605
3606         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3607
3608         let logger = test_utils::TestLogger::new();
3609         let payment_event = {
3610                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3611                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3612                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3613                 check_added_monitors!(nodes[0], 1);
3614
3615                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3616                 assert_eq!(events.len(), 1);
3617                 SendEvent::from_event(events.remove(0))
3618         };
3619         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3620
3621         if messages_delivered < 2 {
3622                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3623         } else {
3624                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3625                 if messages_delivered >= 3 {
3626                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3627                         check_added_monitors!(nodes[1], 1);
3628                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3629
3630                         if messages_delivered >= 4 {
3631                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3632                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3633                                 check_added_monitors!(nodes[0], 1);
3634
3635                                 if messages_delivered >= 5 {
3636                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3637                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3638                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3639                                         check_added_monitors!(nodes[0], 1);
3640
3641                                         if messages_delivered >= 6 {
3642                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3643                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3644                                                 check_added_monitors!(nodes[1], 1);
3645                                         }
3646                                 }
3647                         }
3648                 }
3649         }
3650
3651         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3652         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3653         if messages_delivered < 3 {
3654                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3655                 // received on either side, both sides will need to resend them.
3656                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3657         } else if messages_delivered == 3 {
3658                 // nodes[0] still wants its RAA + commitment_signed
3659                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3660         } else if messages_delivered == 4 {
3661                 // nodes[0] still wants its commitment_signed
3662                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3663         } else if messages_delivered == 5 {
3664                 // nodes[1] still wants its final RAA
3665                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3666         } else if messages_delivered == 6 {
3667                 // Everything was delivered...
3668                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3669         }
3670
3671         let events_1 = nodes[1].node.get_and_clear_pending_events();
3672         assert_eq!(events_1.len(), 1);
3673         match events_1[0] {
3674                 Event::PendingHTLCsForwardable { .. } => { },
3675                 _ => panic!("Unexpected event"),
3676         };
3677
3678         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3679         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3680         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3681
3682         nodes[1].node.process_pending_htlc_forwards();
3683
3684         let events_2 = nodes[1].node.get_and_clear_pending_events();
3685         assert_eq!(events_2.len(), 1);
3686         match events_2[0] {
3687                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3688                         assert_eq!(payment_hash_1, *payment_hash);
3689                         assert_eq!(*payment_secret, None);
3690                         assert_eq!(amt, 1000000);
3691                 },
3692                 _ => panic!("Unexpected event"),
3693         }
3694
3695         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3696         check_added_monitors!(nodes[1], 1);
3697
3698         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3699         assert_eq!(events_3.len(), 1);
3700         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3701                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3702                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3703                         assert!(updates.update_add_htlcs.is_empty());
3704                         assert!(updates.update_fail_htlcs.is_empty());
3705                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3706                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3707                         assert!(updates.update_fee.is_none());
3708                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3709                 },
3710                 _ => panic!("Unexpected event"),
3711         };
3712
3713         if messages_delivered >= 1 {
3714                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3715
3716                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3717                 assert_eq!(events_4.len(), 1);
3718                 match events_4[0] {
3719                         Event::PaymentSent { ref payment_preimage } => {
3720                                 assert_eq!(payment_preimage_1, *payment_preimage);
3721                         },
3722                         _ => panic!("Unexpected event"),
3723                 }
3724
3725                 if messages_delivered >= 2 {
3726                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3727                         check_added_monitors!(nodes[0], 1);
3728                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3729
3730                         if messages_delivered >= 3 {
3731                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3732                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3733                                 check_added_monitors!(nodes[1], 1);
3734
3735                                 if messages_delivered >= 4 {
3736                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3737                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3738                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3739                                         check_added_monitors!(nodes[1], 1);
3740
3741                                         if messages_delivered >= 5 {
3742                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3743                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3744                                                 check_added_monitors!(nodes[0], 1);
3745                                         }
3746                                 }
3747                         }
3748                 }
3749         }
3750
3751         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3752         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3753         if messages_delivered < 2 {
3754                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3755                 //TODO: Deduplicate PaymentSent events, then enable this if:
3756                 //if messages_delivered < 1 {
3757                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3758                         assert_eq!(events_4.len(), 1);
3759                         match events_4[0] {
3760                                 Event::PaymentSent { ref payment_preimage } => {
3761                                         assert_eq!(payment_preimage_1, *payment_preimage);
3762                                 },
3763                                 _ => panic!("Unexpected event"),
3764                         }
3765                 //}
3766         } else if messages_delivered == 2 {
3767                 // nodes[0] still wants its RAA + commitment_signed
3768                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3769         } else if messages_delivered == 3 {
3770                 // nodes[0] still wants its commitment_signed
3771                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3772         } else if messages_delivered == 4 {
3773                 // nodes[1] still wants its final RAA
3774                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3775         } else if messages_delivered == 5 {
3776                 // Everything was delivered...
3777                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3778         }
3779
3780         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3781         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3782         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3783
3784         // Channel should still work fine...
3785         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3786         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3787         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3788         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3789 }
3790
3791 #[test]
3792 fn test_drop_messages_peer_disconnect_a() {
3793         do_test_drop_messages_peer_disconnect(0);
3794         do_test_drop_messages_peer_disconnect(1);
3795         do_test_drop_messages_peer_disconnect(2);
3796         do_test_drop_messages_peer_disconnect(3);
3797 }
3798
3799 #[test]
3800 fn test_drop_messages_peer_disconnect_b() {
3801         do_test_drop_messages_peer_disconnect(4);
3802         do_test_drop_messages_peer_disconnect(5);
3803         do_test_drop_messages_peer_disconnect(6);
3804 }
3805
3806 #[test]
3807 fn test_funding_peer_disconnect() {
3808         // Test that we can lock in our funding tx while disconnected
3809         let chanmon_cfgs = create_chanmon_cfgs(2);
3810         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3811         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3812         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3813         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3814
3815         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3816         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3817
3818         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3819         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3820         assert_eq!(events_1.len(), 1);
3821         match events_1[0] {
3822                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3823                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3824                 },
3825                 _ => panic!("Unexpected event"),
3826         }
3827
3828         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3829
3830         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3831         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3832
3833         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3834         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3835         assert_eq!(events_2.len(), 2);
3836         let funding_locked = match events_2[0] {
3837                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3838                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3839                         msg.clone()
3840                 },
3841                 _ => panic!("Unexpected event"),
3842         };
3843         let bs_announcement_sigs = match events_2[1] {
3844                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3845                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3846                         msg.clone()
3847                 },
3848                 _ => panic!("Unexpected event"),
3849         };
3850
3851         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3852
3853         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3854         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3855         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3856         assert_eq!(events_3.len(), 2);
3857         let as_announcement_sigs = match events_3[0] {
3858                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3859                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3860                         msg.clone()
3861                 },
3862                 _ => panic!("Unexpected event"),
3863         };
3864         let (as_announcement, as_update) = match events_3[1] {
3865                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3866                         (msg.clone(), update_msg.clone())
3867                 },
3868                 _ => panic!("Unexpected event"),
3869         };
3870
3871         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3872         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3873         assert_eq!(events_4.len(), 1);
3874         let (_, bs_update) = match events_4[0] {
3875                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3876                         (msg.clone(), update_msg.clone())
3877                 },
3878                 _ => panic!("Unexpected event"),
3879         };
3880
3881         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3882         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3883         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3884
3885         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3886         let logger = test_utils::TestLogger::new();
3887         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3888         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3889         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3890 }
3891
3892 #[test]
3893 fn test_drop_messages_peer_disconnect_dual_htlc() {
3894         // Test that we can handle reconnecting when both sides of a channel have pending
3895         // commitment_updates when we disconnect.
3896         let chanmon_cfgs = create_chanmon_cfgs(2);
3897         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3898         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3899         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3900         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3901         let logger = test_utils::TestLogger::new();
3902
3903         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3904
3905         // Now try to send a second payment which will fail to send
3906         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3907         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3908         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3909         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3910         check_added_monitors!(nodes[0], 1);
3911
3912         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3913         assert_eq!(events_1.len(), 1);
3914         match events_1[0] {
3915                 MessageSendEvent::UpdateHTLCs { .. } => {},
3916                 _ => panic!("Unexpected event"),
3917         }
3918
3919         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3920         check_added_monitors!(nodes[1], 1);
3921
3922         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3923         assert_eq!(events_2.len(), 1);
3924         match events_2[0] {
3925                 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 } } => {
3926                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3927                         assert!(update_add_htlcs.is_empty());
3928                         assert_eq!(update_fulfill_htlcs.len(), 1);
3929                         assert!(update_fail_htlcs.is_empty());
3930                         assert!(update_fail_malformed_htlcs.is_empty());
3931                         assert!(update_fee.is_none());
3932
3933                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3934                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3935                         assert_eq!(events_3.len(), 1);
3936                         match events_3[0] {
3937                                 Event::PaymentSent { ref payment_preimage } => {
3938                                         assert_eq!(*payment_preimage, payment_preimage_1);
3939                                 },
3940                                 _ => panic!("Unexpected event"),
3941                         }
3942
3943                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3944                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3945                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3946                         check_added_monitors!(nodes[0], 1);
3947                 },
3948                 _ => panic!("Unexpected event"),
3949         }
3950
3951         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3952         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3953
3954         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3955         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3956         assert_eq!(reestablish_1.len(), 1);
3957         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3958         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3959         assert_eq!(reestablish_2.len(), 1);
3960
3961         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3962         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3963         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3964         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3965
3966         assert!(as_resp.0.is_none());
3967         assert!(bs_resp.0.is_none());
3968
3969         assert!(bs_resp.1.is_none());
3970         assert!(bs_resp.2.is_none());
3971
3972         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3973
3974         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3975         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3976         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3977         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3978         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3979         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3980         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3981         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3982         // No commitment_signed so get_event_msg's assert(len == 1) passes
3983         check_added_monitors!(nodes[1], 1);
3984
3985         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3986         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3987         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3988         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3989         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3990         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3991         assert!(bs_second_commitment_signed.update_fee.is_none());
3992         check_added_monitors!(nodes[1], 1);
3993
3994         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3995         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3996         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3997         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3998         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3999         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4000         assert!(as_commitment_signed.update_fee.is_none());
4001         check_added_monitors!(nodes[0], 1);
4002
4003         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4004         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4005         // No commitment_signed so get_event_msg's assert(len == 1) passes
4006         check_added_monitors!(nodes[0], 1);
4007
4008         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4009         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4010         // No commitment_signed so get_event_msg's assert(len == 1) passes
4011         check_added_monitors!(nodes[1], 1);
4012
4013         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4014         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4015         check_added_monitors!(nodes[1], 1);
4016
4017         expect_pending_htlcs_forwardable!(nodes[1]);
4018
4019         let events_5 = nodes[1].node.get_and_clear_pending_events();
4020         assert_eq!(events_5.len(), 1);
4021         match events_5[0] {
4022                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4023                         assert_eq!(payment_hash_2, *payment_hash);
4024                         assert_eq!(*payment_secret, None);
4025                 },
4026                 _ => panic!("Unexpected event"),
4027         }
4028
4029         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4030         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4031         check_added_monitors!(nodes[0], 1);
4032
4033         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4034 }
4035
4036 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4037         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4038         // to avoid our counterparty failing the channel.
4039         let chanmon_cfgs = create_chanmon_cfgs(2);
4040         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4041         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4042         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4043
4044         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4045         let logger = test_utils::TestLogger::new();
4046
4047         let our_payment_hash = if send_partial_mpp {
4048                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4049                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4050                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4051                 let payment_secret = PaymentSecret([0xdb; 32]);
4052                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4053                 // indicates there are more HTLCs coming.
4054                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4055                 check_added_monitors!(nodes[0], 1);
4056                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4057                 assert_eq!(events.len(), 1);
4058                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4059                 // hop should *not* yet generate any PaymentReceived event(s).
4060                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4061                 our_payment_hash
4062         } else {
4063                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4064         };
4065
4066         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4067         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4068         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4069         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4070                 header.prev_blockhash = header.bitcoin_hash();
4071                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
4072                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4073         }
4074
4075         expect_pending_htlcs_forwardable!(nodes[1]);
4076
4077         check_added_monitors!(nodes[1], 1);
4078         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4079         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4080         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4081         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4082         assert!(htlc_timeout_updates.update_fee.is_none());
4083
4084         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4085         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4086         // 100_000 msat as u64, followed by a height of 123 as u32
4087         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4088         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4089         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4090 }
4091
4092 #[test]
4093 fn test_htlc_timeout() {
4094         do_test_htlc_timeout(true);
4095         do_test_htlc_timeout(false);
4096 }
4097
4098 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4099         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4100         let chanmon_cfgs = create_chanmon_cfgs(3);
4101         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4102         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4103         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4104         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4105         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4106         let logger = test_utils::TestLogger::new();
4107
4108         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4109         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4110         {
4111                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4112                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4113                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4114         }
4115         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4116         check_added_monitors!(nodes[1], 1);
4117
4118         // Now attempt to route a second payment, which should be placed in the holding cell
4119         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4120         if forwarded_htlc {
4121                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4122                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4123                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4124                 check_added_monitors!(nodes[0], 1);
4125                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4126                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4127                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4128                 expect_pending_htlcs_forwardable!(nodes[1]);
4129                 check_added_monitors!(nodes[1], 0);
4130         } else {
4131                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4132                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4133                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4134                 check_added_monitors!(nodes[1], 0);
4135         }
4136
4137         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4138         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4139         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4140                 header.prev_blockhash = header.bitcoin_hash();
4141                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4142         }
4143
4144         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4145         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4146
4147         header.prev_blockhash = header.bitcoin_hash();
4148         nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
4149
4150         if forwarded_htlc {
4151                 expect_pending_htlcs_forwardable!(nodes[1]);
4152                 check_added_monitors!(nodes[1], 1);
4153                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4154                 assert_eq!(fail_commit.len(), 1);
4155                 match fail_commit[0] {
4156                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4157                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4158                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4159                         },
4160                         _ => unreachable!(),
4161                 }
4162                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4163                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4164                         match update {
4165                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4166                                 _ => panic!("Unexpected event"),
4167                         }
4168                 } else {
4169                         panic!("Unexpected event");
4170                 }
4171         } else {
4172                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4173         }
4174 }
4175
4176 #[test]
4177 fn test_holding_cell_htlc_add_timeouts() {
4178         do_test_holding_cell_htlc_add_timeouts(false);
4179         do_test_holding_cell_htlc_add_timeouts(true);
4180 }
4181
4182 #[test]
4183 fn test_invalid_channel_announcement() {
4184         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4185         let secp_ctx = Secp256k1::new();
4186         let chanmon_cfgs = create_chanmon_cfgs(2);
4187         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4188         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4189         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4190
4191         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4192
4193         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4194         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4195         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4196         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4197
4198         nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4199
4200         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4201         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4202
4203         let as_network_key = nodes[0].node.get_our_node_id();
4204         let bs_network_key = nodes[1].node.get_our_node_id();
4205
4206         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4207
4208         let mut chan_announcement;
4209
4210         macro_rules! dummy_unsigned_msg {
4211                 () => {
4212                         msgs::UnsignedChannelAnnouncement {
4213                                 features: ChannelFeatures::known(),
4214                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4215                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4216                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4217                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4218                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4219                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4220                                 excess_data: Vec::new(),
4221                         };
4222                 }
4223         }
4224
4225         macro_rules! sign_msg {
4226                 ($unsigned_msg: expr) => {
4227                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4228                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4229                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4230                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4231                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4232                         chan_announcement = msgs::ChannelAnnouncement {
4233                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4234                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4235                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4236                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4237                                 contents: $unsigned_msg
4238                         }
4239                 }
4240         }
4241
4242         let unsigned_msg = dummy_unsigned_msg!();
4243         sign_msg!(unsigned_msg);
4244         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4245         let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4246
4247         // Configured with Network::Testnet
4248         let mut unsigned_msg = dummy_unsigned_msg!();
4249         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4250         sign_msg!(unsigned_msg);
4251         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4252
4253         let mut unsigned_msg = dummy_unsigned_msg!();
4254         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4255         sign_msg!(unsigned_msg);
4256         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4257 }
4258
4259 #[test]
4260 fn test_no_txn_manager_serialize_deserialize() {
4261         let chanmon_cfgs = create_chanmon_cfgs(2);
4262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4264         let logger: test_utils::TestLogger;
4265         let fee_estimator: test_utils::TestFeeEstimator;
4266         let new_chan_monitor: test_utils::TestChannelMonitor;
4267         let keys_manager: test_utils::TestKeysInterface;
4268         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4269         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4270
4271         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4272
4273         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4274
4275         let nodes_0_serialized = nodes[0].node.encode();
4276         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4277         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4278
4279         logger = test_utils::TestLogger::new();
4280         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4281         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4282         nodes[0].chan_monitor = &new_chan_monitor;
4283         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4284         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4285         assert!(chan_0_monitor_read.is_empty());
4286
4287         let mut nodes_0_read = &nodes_0_serialized[..];
4288         let config = UserConfig::default();
4289         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4290         let (_, nodes_0_deserialized_tmp) = {
4291                 let mut channel_monitors = HashMap::new();
4292                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4293                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4294                         default_config: config,
4295                         keys_manager: &keys_manager,
4296                         fee_estimator: &fee_estimator,
4297                         monitor: nodes[0].chan_monitor,
4298                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4299                         logger: &logger,
4300                         channel_monitors: &mut channel_monitors,
4301                 }).unwrap()
4302         };
4303         nodes_0_deserialized = nodes_0_deserialized_tmp;
4304         assert!(nodes_0_read.is_empty());
4305
4306         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4307         nodes[0].node = &nodes_0_deserialized;
4308         nodes[0].block_notifier.register_listener(nodes[0].node);
4309         assert_eq!(nodes[0].node.list_channels().len(), 1);
4310         check_added_monitors!(nodes[0], 1);
4311
4312         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4313         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4314         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4315         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4316
4317         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4318         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4319         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4320         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4321
4322         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4323         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4324         for node in nodes.iter() {
4325                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4326                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4327                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4328         }
4329
4330         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4331 }
4332
4333 #[test]
4334 fn test_manager_serialize_deserialize_events() {
4335         // This test makes sure the events field in ChannelManager survives de/serialization
4336         let chanmon_cfgs = create_chanmon_cfgs(2);
4337         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4339         let fee_estimator: test_utils::TestFeeEstimator;
4340         let logger: test_utils::TestLogger;
4341         let new_chan_monitor: test_utils::TestChannelMonitor;
4342         let keys_manager: test_utils::TestKeysInterface;
4343         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4344         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4345
4346         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4347         let channel_value = 100000;
4348         let push_msat = 10001;
4349         let a_flags = InitFeatures::known();
4350         let b_flags = InitFeatures::known();
4351         let node_a = nodes.pop().unwrap();
4352         let node_b = nodes.pop().unwrap();
4353         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4354         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4355         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4356
4357         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4358
4359         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4360         check_added_monitors!(node_a, 0);
4361
4362         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4363         {
4364                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4365                 assert_eq!(added_monitors.len(), 1);
4366                 assert_eq!(added_monitors[0].0, funding_output);
4367                 added_monitors.clear();
4368         }
4369
4370         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4371         {
4372                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4373                 assert_eq!(added_monitors.len(), 1);
4374                 assert_eq!(added_monitors[0].0, funding_output);
4375                 added_monitors.clear();
4376         }
4377         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4378
4379         nodes.push(node_a);
4380         nodes.push(node_b);
4381
4382         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4383         let nodes_0_serialized = nodes[0].node.encode();
4384         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4385         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4386
4387         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4388         logger = test_utils::TestLogger::new();
4389         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4390         nodes[0].chan_monitor = &new_chan_monitor;
4391         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4392         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4393         assert!(chan_0_monitor_read.is_empty());
4394
4395         let mut nodes_0_read = &nodes_0_serialized[..];
4396         let config = UserConfig::default();
4397         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4398         let (_, nodes_0_deserialized_tmp) = {
4399                 let mut channel_monitors = HashMap::new();
4400                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4401                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4402                         default_config: config,
4403                         keys_manager: &keys_manager,
4404                         fee_estimator: &fee_estimator,
4405                         monitor: nodes[0].chan_monitor,
4406                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4407                         logger: &logger,
4408                         channel_monitors: &mut channel_monitors,
4409                 }).unwrap()
4410         };
4411         nodes_0_deserialized = nodes_0_deserialized_tmp;
4412         assert!(nodes_0_read.is_empty());
4413
4414         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4415
4416         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4417         nodes[0].node = &nodes_0_deserialized;
4418
4419         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4420         let events_4 = nodes[0].node.get_and_clear_pending_events();
4421         assert_eq!(events_4.len(), 1);
4422         match events_4[0] {
4423                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4424                         assert_eq!(user_channel_id, 42);
4425                         assert_eq!(*funding_txo, funding_output);
4426                 },
4427                 _ => panic!("Unexpected event"),
4428         };
4429
4430         // Make sure the channel is functioning as though the de/serialization never happened
4431         nodes[0].block_notifier.register_listener(nodes[0].node);
4432         assert_eq!(nodes[0].node.list_channels().len(), 1);
4433         check_added_monitors!(nodes[0], 1);
4434
4435         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4436         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4437         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4438         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4439
4440         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4441         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4442         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4443         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4444
4445         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4446         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4447         for node in nodes.iter() {
4448                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4449                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4450                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4451         }
4452
4453         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4454 }
4455
4456 #[test]
4457 fn test_simple_manager_serialize_deserialize() {
4458         let chanmon_cfgs = create_chanmon_cfgs(2);
4459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4461         let logger: test_utils::TestLogger;
4462         let fee_estimator: test_utils::TestFeeEstimator;
4463         let new_chan_monitor: test_utils::TestChannelMonitor;
4464         let keys_manager: test_utils::TestKeysInterface;
4465         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4466         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4467         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4468
4469         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4470         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4471
4472         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4473
4474         let nodes_0_serialized = nodes[0].node.encode();
4475         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4476         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4477
4478         logger = test_utils::TestLogger::new();
4479         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4480         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4481         nodes[0].chan_monitor = &new_chan_monitor;
4482         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4483         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4484         assert!(chan_0_monitor_read.is_empty());
4485
4486         let mut nodes_0_read = &nodes_0_serialized[..];
4487         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4488         let (_, nodes_0_deserialized_tmp) = {
4489                 let mut channel_monitors = HashMap::new();
4490                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4491                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4492                         default_config: UserConfig::default(),
4493                         keys_manager: &keys_manager,
4494                         fee_estimator: &fee_estimator,
4495                         monitor: nodes[0].chan_monitor,
4496                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4497                         logger: &logger,
4498                         channel_monitors: &mut channel_monitors,
4499                 }).unwrap()
4500         };
4501         nodes_0_deserialized = nodes_0_deserialized_tmp;
4502         assert!(nodes_0_read.is_empty());
4503
4504         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4505         nodes[0].node = &nodes_0_deserialized;
4506         check_added_monitors!(nodes[0], 1);
4507
4508         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4509
4510         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4511         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4512 }
4513
4514 #[test]
4515 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4516         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4517         let chanmon_cfgs = create_chanmon_cfgs(4);
4518         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4519         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4520         let logger: test_utils::TestLogger;
4521         let fee_estimator: test_utils::TestFeeEstimator;
4522         let new_chan_monitor: test_utils::TestChannelMonitor;
4523         let keys_manager: test_utils::TestKeysInterface;
4524         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4525         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4526         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4527         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4528         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4529
4530         let mut node_0_stale_monitors_serialized = Vec::new();
4531         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4532                 let mut writer = test_utils::TestVecWriter(Vec::new());
4533                 monitor.1.write_for_disk(&mut writer).unwrap();
4534                 node_0_stale_monitors_serialized.push(writer.0);
4535         }
4536
4537         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4538
4539         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4540         let nodes_0_serialized = nodes[0].node.encode();
4541
4542         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4543         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4544         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4545         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4546
4547         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4548         // nodes[3])
4549         let mut node_0_monitors_serialized = Vec::new();
4550         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4551                 let mut writer = test_utils::TestVecWriter(Vec::new());
4552                 monitor.1.write_for_disk(&mut writer).unwrap();
4553                 node_0_monitors_serialized.push(writer.0);
4554         }
4555
4556         logger = test_utils::TestLogger::new();
4557         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4558         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4559         nodes[0].chan_monitor = &new_chan_monitor;
4560
4561         let mut node_0_stale_monitors = Vec::new();
4562         for serialized in node_0_stale_monitors_serialized.iter() {
4563                 let mut read = &serialized[..];
4564                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4565                 assert!(read.is_empty());
4566                 node_0_stale_monitors.push(monitor);
4567         }
4568
4569         let mut node_0_monitors = Vec::new();
4570         for serialized in node_0_monitors_serialized.iter() {
4571                 let mut read = &serialized[..];
4572                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4573                 assert!(read.is_empty());
4574                 node_0_monitors.push(monitor);
4575         }
4576
4577         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4578
4579         let mut nodes_0_read = &nodes_0_serialized[..];
4580         if let Err(msgs::DecodeError::InvalidValue) =
4581                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4582                 default_config: UserConfig::default(),
4583                 keys_manager: &keys_manager,
4584                 fee_estimator: &fee_estimator,
4585                 monitor: nodes[0].chan_monitor,
4586                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4587                 logger: &logger,
4588                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4589         }) { } else {
4590                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4591         };
4592
4593         let mut nodes_0_read = &nodes_0_serialized[..];
4594         let (_, nodes_0_deserialized_tmp) =
4595                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4596                 default_config: UserConfig::default(),
4597                 keys_manager: &keys_manager,
4598                 fee_estimator: &fee_estimator,
4599                 monitor: nodes[0].chan_monitor,
4600                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4601                 logger: &logger,
4602                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4603         }).unwrap();
4604         nodes_0_deserialized = nodes_0_deserialized_tmp;
4605         assert!(nodes_0_read.is_empty());
4606
4607         { // Channel close should result in a commitment tx and an HTLC tx
4608                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4609                 assert_eq!(txn.len(), 2);
4610                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4611                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4612         }
4613
4614         for monitor in node_0_monitors.drain(..) {
4615                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4616                 check_added_monitors!(nodes[0], 1);
4617         }
4618         nodes[0].node = &nodes_0_deserialized;
4619
4620         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4621         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4622         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4623         //... and we can even still claim the payment!
4624         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4625
4626         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4627         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4628         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4629         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4630         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4631         assert_eq!(msg_events.len(), 1);
4632         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4633                 match action {
4634                         &ErrorAction::SendErrorMessage { ref msg } => {
4635                                 assert_eq!(msg.channel_id, channel_id);
4636                         },
4637                         _ => panic!("Unexpected event!"),
4638                 }
4639         }
4640 }
4641
4642 macro_rules! check_spendable_outputs {
4643         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4644                 {
4645                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4646                         let mut txn = Vec::new();
4647                         for event in events {
4648                                 match event {
4649                                         Event::SpendableOutputs { ref outputs } => {
4650                                                 for outp in outputs {
4651                                                         match *outp {
4652                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4653                                                                         let input = TxIn {
4654                                                                                 previous_output: outpoint.clone(),
4655                                                                                 script_sig: Script::new(),
4656                                                                                 sequence: 0,
4657                                                                                 witness: Vec::new(),
4658                                                                         };
4659                                                                         let outp = TxOut {
4660                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4661                                                                                 value: output.value,
4662                                                                         };
4663                                                                         let mut spend_tx = Transaction {
4664                                                                                 version: 2,
4665                                                                                 lock_time: 0,
4666                                                                                 input: vec![input],
4667                                                                                 output: vec![outp],
4668                                                                         };
4669                                                                         let secp_ctx = Secp256k1::new();
4670                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4671                                                                         let remotepubkey = keys.pubkeys().payment_point;
4672                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4673                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4674                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4675                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4676                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4677                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4678                                                                         txn.push(spend_tx);
4679                                                                 },
4680                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4681                                                                         let input = TxIn {
4682                                                                                 previous_output: outpoint.clone(),
4683                                                                                 script_sig: Script::new(),
4684                                                                                 sequence: *to_self_delay as u32,
4685                                                                                 witness: Vec::new(),
4686                                                                         };
4687                                                                         let outp = TxOut {
4688                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4689                                                                                 value: output.value,
4690                                                                         };
4691                                                                         let mut spend_tx = Transaction {
4692                                                                                 version: 2,
4693                                                                                 lock_time: 0,
4694                                                                                 input: vec![input],
4695                                                                                 output: vec![outp],
4696                                                                         };
4697                                                                         let secp_ctx = Secp256k1::new();
4698                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4699                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4700
4701                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4702                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4703                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4704                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4705                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4706                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4707                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4708                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4709                                                                         } else { panic!() }
4710                                                                         txn.push(spend_tx);
4711                                                                 },
4712                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4713                                                                         let secp_ctx = Secp256k1::new();
4714                                                                         let input = TxIn {
4715                                                                                 previous_output: outpoint.clone(),
4716                                                                                 script_sig: Script::new(),
4717                                                                                 sequence: 0,
4718                                                                                 witness: Vec::new(),
4719                                                                         };
4720                                                                         let outp = TxOut {
4721                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4722                                                                                 value: output.value,
4723                                                                         };
4724                                                                         let mut spend_tx = Transaction {
4725                                                                                 version: 2,
4726                                                                                 lock_time: 0,
4727                                                                                 input: vec![input],
4728                                                                                 output: vec![outp.clone()],
4729                                                                         };
4730                                                                         let secret = {
4731                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4732                                                                                         Ok(master_key) => {
4733                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4734                                                                                                         Ok(key) => key,
4735                                                                                                         Err(_) => panic!("Your RNG is busted"),
4736                                                                                                 }
4737                                                                                         }
4738                                                                                         Err(_) => panic!("Your rng is busted"),
4739                                                                                 }
4740                                                                         };
4741                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4742                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4743                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4744                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4745                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4746                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4747                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4748                                                                         txn.push(spend_tx);
4749                                                                 },
4750                                                         }
4751                                                 }
4752                                         },
4753                                         _ => panic!("Unexpected event"),
4754                                 };
4755                         }
4756                         txn
4757                 }
4758         }
4759 }
4760
4761 #[test]
4762 fn test_claim_sizeable_push_msat() {
4763         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4764         let chanmon_cfgs = create_chanmon_cfgs(2);
4765         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4766         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4767         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4768
4769         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4770         nodes[1].node.force_close_channel(&chan.2);
4771         check_closed_broadcast!(nodes[1], false);
4772         check_added_monitors!(nodes[1], 1);
4773         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4774         assert_eq!(node_txn.len(), 1);
4775         check_spends!(node_txn[0], chan.3);
4776         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
4777
4778         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4779         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4780         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4781
4782         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4783         assert_eq!(spend_txn.len(), 1);
4784         check_spends!(spend_txn[0], node_txn[0]);
4785 }
4786
4787 #[test]
4788 fn test_claim_on_remote_sizeable_push_msat() {
4789         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4790         // to_remote output is encumbered by a P2WPKH
4791         let chanmon_cfgs = create_chanmon_cfgs(2);
4792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4794         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4795
4796         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4797         nodes[0].node.force_close_channel(&chan.2);
4798         check_closed_broadcast!(nodes[0], false);
4799         check_added_monitors!(nodes[0], 1);
4800
4801         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4802         assert_eq!(node_txn.len(), 1);
4803         check_spends!(node_txn[0], chan.3);
4804         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
4805
4806         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4807         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4808         check_closed_broadcast!(nodes[1], false);
4809         check_added_monitors!(nodes[1], 1);
4810         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4811
4812         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4813         assert_eq!(spend_txn.len(), 2);
4814         assert_eq!(spend_txn[0], spend_txn[1]);
4815         check_spends!(spend_txn[0], node_txn[0]);
4816 }
4817
4818 #[test]
4819 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4820         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4821         // to_remote output is encumbered by a P2WPKH
4822
4823         let chanmon_cfgs = create_chanmon_cfgs(2);
4824         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4825         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4826         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4827
4828         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4829         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4830         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4831         assert_eq!(revoked_local_txn[0].input.len(), 1);
4832         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4833
4834         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4835         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4836         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4837         check_closed_broadcast!(nodes[1], false);
4838         check_added_monitors!(nodes[1], 1);
4839
4840         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4841         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4842         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4843         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4844
4845         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4846         assert_eq!(spend_txn.len(), 3);
4847         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4848         check_spends!(spend_txn[0], revoked_local_txn[0]);
4849         check_spends!(spend_txn[2], node_txn[0]);
4850 }
4851
4852 #[test]
4853 fn test_static_spendable_outputs_preimage_tx() {
4854         let chanmon_cfgs = create_chanmon_cfgs(2);
4855         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4856         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4857         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4858
4859         // Create some initial channels
4860         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4861
4862         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4863
4864         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4865         assert_eq!(commitment_tx[0].input.len(), 1);
4866         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4867
4868         // Settle A's commitment tx on B's chain
4869         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4870         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4871         check_added_monitors!(nodes[1], 1);
4872         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4873         check_added_monitors!(nodes[1], 1);
4874         let events = nodes[1].node.get_and_clear_pending_msg_events();
4875         match events[0] {
4876                 MessageSendEvent::UpdateHTLCs { .. } => {},
4877                 _ => panic!("Unexpected event"),
4878         }
4879         match events[1] {
4880                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4881                 _ => panic!("Unexepected event"),
4882         }
4883
4884         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4885         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4886         assert_eq!(node_txn.len(), 3);
4887         check_spends!(node_txn[0], commitment_tx[0]);
4888         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4889         check_spends!(node_txn[1], chan_1.3);
4890         check_spends!(node_txn[2], node_txn[1]);
4891
4892         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4893         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4894         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4895
4896         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4897         assert_eq!(spend_txn.len(), 1);
4898         check_spends!(spend_txn[0], node_txn[0]);
4899 }
4900
4901 #[test]
4902 fn test_static_spendable_outputs_timeout_tx() {
4903         let chanmon_cfgs = create_chanmon_cfgs(2);
4904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4907
4908         // Create some initial channels
4909         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4910
4911         // Rebalance the network a bit by relaying one payment through all the channels ...
4912         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4913
4914         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4915
4916         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4917         assert_eq!(commitment_tx[0].input.len(), 1);
4918         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4919
4920         // Settle A's commitment tx on B' chain
4921         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4922         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4923         check_added_monitors!(nodes[1], 1);
4924         let events = nodes[1].node.get_and_clear_pending_msg_events();
4925         match events[0] {
4926                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4927                 _ => panic!("Unexpected event"),
4928         }
4929
4930         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4931         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4932         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4933         check_spends!(node_txn[0],  commitment_tx[0].clone());
4934         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4935         check_spends!(node_txn[1], chan_1.3.clone());
4936         check_spends!(node_txn[2], node_txn[1]);
4937
4938         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4939         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4940         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4941         expect_payment_failed!(nodes[1], our_payment_hash, true);
4942
4943         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4944         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4945         check_spends!(spend_txn[2], node_txn[0].clone());
4946 }
4947
4948 #[test]
4949 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4950         let chanmon_cfgs = create_chanmon_cfgs(2);
4951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4953         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4954
4955         // Create some initial channels
4956         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4957
4958         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4959         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4960         assert_eq!(revoked_local_txn[0].input.len(), 1);
4961         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4962
4963         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4964
4965         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4966         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4967         check_closed_broadcast!(nodes[1], false);
4968         check_added_monitors!(nodes[1], 1);
4969
4970         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4971         assert_eq!(node_txn.len(), 2);
4972         assert_eq!(node_txn[0].input.len(), 2);
4973         check_spends!(node_txn[0], revoked_local_txn[0]);
4974
4975         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4976         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4977         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4978
4979         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4980         assert_eq!(spend_txn.len(), 1);
4981         check_spends!(spend_txn[0], node_txn[0]);
4982 }
4983
4984 #[test]
4985 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4986         let chanmon_cfgs = create_chanmon_cfgs(2);
4987         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4988         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4989         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4990
4991         // Create some initial channels
4992         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4993
4994         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4995         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4996         assert_eq!(revoked_local_txn[0].input.len(), 1);
4997         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4998
4999         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5000
5001         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5002         // A will generate HTLC-Timeout from revoked commitment tx
5003         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5004         check_closed_broadcast!(nodes[0], false);
5005         check_added_monitors!(nodes[0], 1);
5006
5007         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5008         assert_eq!(revoked_htlc_txn.len(), 2);
5009         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5010         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5011         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5012         check_spends!(revoked_htlc_txn[1], chan_1.3);
5013
5014         // B will generate justice tx from A's revoked commitment/HTLC tx
5015         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5016         check_closed_broadcast!(nodes[1], false);
5017         check_added_monitors!(nodes[1], 1);
5018
5019         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5020         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
5021         assert_eq!(node_txn[0].input.len(), 2);
5022         check_spends!(node_txn[0], revoked_local_txn[0]);
5023         check_spends!(node_txn[1], chan_1.3);
5024         assert_eq!(node_txn[2].input.len(), 1);
5025         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5026         assert_eq!(node_txn[3].input.len(), 1);
5027         check_spends!(node_txn[3], revoked_local_txn[0]);
5028
5029         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5030         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5031         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5032
5033         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5034         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5035         assert_eq!(spend_txn.len(), 2);
5036         check_spends!(spend_txn[0], node_txn[0]);
5037         check_spends!(spend_txn[1], node_txn[2]);
5038 }
5039
5040 #[test]
5041 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5042         let chanmon_cfgs = create_chanmon_cfgs(2);
5043         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5044         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5045         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5046
5047         // Create some initial channels
5048         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5049
5050         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5051         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5052         assert_eq!(revoked_local_txn[0].input.len(), 1);
5053         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5054
5055         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5056
5057         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5058         // B will generate HTLC-Success from revoked commitment tx
5059         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5060         check_closed_broadcast!(nodes[1], false);
5061         check_added_monitors!(nodes[1], 1);
5062         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5063
5064         assert_eq!(revoked_htlc_txn.len(), 2);
5065         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5066         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5067         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5068
5069         // A will generate justice tx from B's revoked commitment/HTLC tx
5070         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5071         check_closed_broadcast!(nodes[0], false);
5072         check_added_monitors!(nodes[0], 1);
5073
5074         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5075         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5076         assert_eq!(node_txn[2].input.len(), 1);
5077         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5078
5079         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5080         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5081         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5082
5083         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5084         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5085         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5086         assert_eq!(spend_txn[0], spend_txn[1]);
5087         assert_eq!(spend_txn[0], spend_txn[2]);
5088         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5089         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5090         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5091 }
5092
5093 #[test]
5094 fn test_onchain_to_onchain_claim() {
5095         // Test that in case of channel closure, we detect the state of output thanks to
5096         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5097         // First, have C claim an HTLC against its own latest commitment transaction.
5098         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5099         // channel.
5100         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5101         // gets broadcast.
5102
5103         let chanmon_cfgs = create_chanmon_cfgs(3);
5104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5106         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5107
5108         // Create some initial channels
5109         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5110         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5111
5112         // Rebalance the network a bit by relaying one payment through all the channels ...
5113         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5114         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5115
5116         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5117         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5118         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5119         check_spends!(commitment_tx[0], chan_2.3);
5120         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5121         check_added_monitors!(nodes[2], 1);
5122         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5123         assert!(updates.update_add_htlcs.is_empty());
5124         assert!(updates.update_fail_htlcs.is_empty());
5125         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5126         assert!(updates.update_fail_malformed_htlcs.is_empty());
5127
5128         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5129         check_closed_broadcast!(nodes[2], false);
5130         check_added_monitors!(nodes[2], 1);
5131
5132         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5133         assert_eq!(c_txn.len(), 3);
5134         assert_eq!(c_txn[0], c_txn[2]);
5135         assert_eq!(commitment_tx[0], c_txn[1]);
5136         check_spends!(c_txn[1], chan_2.3);
5137         check_spends!(c_txn[2], c_txn[1]);
5138         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5139         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5140         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5141         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5142
5143         // 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
5144         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5145         {
5146                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5147                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5148                 assert_eq!(b_txn.len(), 3);
5149                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5150                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5151                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5152                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5153                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5154                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5155                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5156                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5157                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5158                 b_txn.clear();
5159         }
5160         check_added_monitors!(nodes[1], 1);
5161         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5162         check_added_monitors!(nodes[1], 1);
5163         match msg_events[0] {
5164                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5165                 _ => panic!("Unexpected event"),
5166         }
5167         match msg_events[1] {
5168                 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, .. } } => {
5169                         assert!(update_add_htlcs.is_empty());
5170                         assert!(update_fail_htlcs.is_empty());
5171                         assert_eq!(update_fulfill_htlcs.len(), 1);
5172                         assert!(update_fail_malformed_htlcs.is_empty());
5173                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5174                 },
5175                 _ => panic!("Unexpected event"),
5176         };
5177         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5178         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5179         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5180         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5181         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5182         assert_eq!(b_txn.len(), 3);
5183         check_spends!(b_txn[1], chan_1.3);
5184         check_spends!(b_txn[2], b_txn[1]);
5185         check_spends!(b_txn[0], commitment_tx[0]);
5186         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5187         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5188         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5189
5190         check_closed_broadcast!(nodes[1], false);
5191         check_added_monitors!(nodes[1], 1);
5192 }
5193
5194 #[test]
5195 fn test_duplicate_payment_hash_one_failure_one_success() {
5196         // Topology : A --> B --> C
5197         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5198         let chanmon_cfgs = create_chanmon_cfgs(3);
5199         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5200         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5201         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5202
5203         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5204         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5205
5206         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5207         *nodes[0].network_payment_count.borrow_mut() -= 1;
5208         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5209
5210         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5211         assert_eq!(commitment_txn[0].input.len(), 1);
5212         check_spends!(commitment_txn[0], chan_2.3);
5213
5214         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5215         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5216         check_closed_broadcast!(nodes[1], false);
5217         check_added_monitors!(nodes[1], 1);
5218
5219         let htlc_timeout_tx;
5220         { // Extract one of the two HTLC-Timeout transaction
5221                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5222                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5223                 assert_eq!(node_txn.len(), 5);
5224                 check_spends!(node_txn[0], commitment_txn[0]);
5225                 assert_eq!(node_txn[0].input.len(), 1);
5226                 check_spends!(node_txn[1], commitment_txn[0]);
5227                 assert_eq!(node_txn[1].input.len(), 1);
5228                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5229                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5230                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5231                 check_spends!(node_txn[2], chan_2.3);
5232                 check_spends!(node_txn[3], node_txn[2]);
5233                 check_spends!(node_txn[4], node_txn[2]);
5234                 htlc_timeout_tx = node_txn[1].clone();
5235         }
5236
5237         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5238         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5239         check_added_monitors!(nodes[2], 3);
5240         let events = nodes[2].node.get_and_clear_pending_msg_events();
5241         match events[0] {
5242                 MessageSendEvent::UpdateHTLCs { .. } => {},
5243                 _ => panic!("Unexpected event"),
5244         }
5245         match events[1] {
5246                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5247                 _ => panic!("Unexepected event"),
5248         }
5249         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5250         assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
5251         check_spends!(htlc_success_txn[2], chan_2.3);
5252         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5253         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5254         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5255         assert_eq!(htlc_success_txn[0].input.len(), 1);
5256         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5257         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5258         assert_eq!(htlc_success_txn[1].input.len(), 1);
5259         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5260         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5261         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5262         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5263
5264         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5265         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5266         expect_pending_htlcs_forwardable!(nodes[1]);
5267         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5268         assert!(htlc_updates.update_add_htlcs.is_empty());
5269         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5270         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5271         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5272         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5273         check_added_monitors!(nodes[1], 1);
5274
5275         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5276         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5277         {
5278                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5279                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5280                 assert_eq!(events.len(), 1);
5281                 match events[0] {
5282                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5283                         },
5284                         _ => { panic!("Unexpected event"); }
5285                 }
5286         }
5287         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5288
5289         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5290         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5291         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5292         assert!(updates.update_add_htlcs.is_empty());
5293         assert!(updates.update_fail_htlcs.is_empty());
5294         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5295         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5296         assert!(updates.update_fail_malformed_htlcs.is_empty());
5297         check_added_monitors!(nodes[1], 1);
5298
5299         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5300         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5301
5302         let events = nodes[0].node.get_and_clear_pending_events();
5303         match events[0] {
5304                 Event::PaymentSent { ref payment_preimage } => {
5305                         assert_eq!(*payment_preimage, our_payment_preimage);
5306                 }
5307                 _ => panic!("Unexpected event"),
5308         }
5309 }
5310
5311 #[test]
5312 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5313         let chanmon_cfgs = create_chanmon_cfgs(2);
5314         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5315         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5316         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5317
5318         // Create some initial channels
5319         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5320
5321         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5322         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5323         assert_eq!(local_txn[0].input.len(), 1);
5324         check_spends!(local_txn[0], chan_1.3);
5325
5326         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5327         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5328         check_added_monitors!(nodes[1], 1);
5329         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5330         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5331         check_added_monitors!(nodes[1], 1);
5332         let events = nodes[1].node.get_and_clear_pending_msg_events();
5333         match events[0] {
5334                 MessageSendEvent::UpdateHTLCs { .. } => {},
5335                 _ => panic!("Unexpected event"),
5336         }
5337         match events[1] {
5338                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5339                 _ => panic!("Unexepected event"),
5340         }
5341         let node_txn = {
5342                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5343                 assert_eq!(node_txn[0].input.len(), 1);
5344                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5345                 check_spends!(node_txn[0], local_txn[0]);
5346                 vec![node_txn[0].clone(), node_txn[2].clone()]
5347         };
5348
5349         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5350         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5351         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5352
5353         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5354         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5355         assert_eq!(spend_txn.len(), 2);
5356         check_spends!(spend_txn[0], node_txn[0]);
5357         check_spends!(spend_txn[1], node_txn[1]);
5358 }
5359
5360 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5361         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5362         // unrevoked commitment transaction.
5363         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5364         // a remote RAA before they could be failed backwards (and combinations thereof).
5365         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5366         // use the same payment hashes.
5367         // Thus, we use a six-node network:
5368         //
5369         // A \         / E
5370         //    - C - D -
5371         // B /         \ F
5372         // And test where C fails back to A/B when D announces its latest commitment transaction
5373         let chanmon_cfgs = create_chanmon_cfgs(6);
5374         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5375         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5376         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5377         let logger = test_utils::TestLogger::new();
5378
5379         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5380         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5381         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5382         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5383         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5384
5385         // Rebalance and check output sanity...
5386         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5387         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5388         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5389
5390         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5391         // 0th HTLC:
5392         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
5393         // 1st HTLC:
5394         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
5395         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5396         let our_node_id = &nodes[1].node.get_our_node_id();
5397         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5398         // 2nd HTLC:
5399         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
5400         // 3rd HTLC:
5401         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
5402         // 4th HTLC:
5403         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5404         // 5th HTLC:
5405         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5406         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5407         // 6th HTLC:
5408         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5409         // 7th HTLC:
5410         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5411
5412         // 8th HTLC:
5413         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5414         // 9th HTLC:
5415         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5416         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
5417
5418         // 10th HTLC:
5419         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
5420         // 11th HTLC:
5421         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5422         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5423
5424         // Double-check that six of the new HTLC were added
5425         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5426         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5427         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5428         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5429
5430         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5431         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5432         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5433         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5434         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5435         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5436         check_added_monitors!(nodes[4], 0);
5437         expect_pending_htlcs_forwardable!(nodes[4]);
5438         check_added_monitors!(nodes[4], 1);
5439
5440         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5441         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5442         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5443         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5444         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5445         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5446
5447         // Fail 3rd below-dust and 7th above-dust HTLCs
5448         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5449         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5450         check_added_monitors!(nodes[5], 0);
5451         expect_pending_htlcs_forwardable!(nodes[5]);
5452         check_added_monitors!(nodes[5], 1);
5453
5454         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5455         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5456         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5457         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5458
5459         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5460
5461         expect_pending_htlcs_forwardable!(nodes[3]);
5462         check_added_monitors!(nodes[3], 1);
5463         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5465         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5466         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5467         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5468         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5469         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5470         if deliver_last_raa {
5471                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5472         } else {
5473                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5474         }
5475
5476         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5477         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5478         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5479         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5480         //
5481         // We now broadcast the latest commitment transaction, which *should* result in failures for
5482         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5483         // the non-broadcast above-dust HTLCs.
5484         //
5485         // Alternatively, we may broadcast the previous commitment transaction, which should only
5486         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5487         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5488
5489         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5490         if announce_latest {
5491                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5492         } else {
5493                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5494         }
5495         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5496         check_closed_broadcast!(nodes[2], false);
5497         expect_pending_htlcs_forwardable!(nodes[2]);
5498         check_added_monitors!(nodes[2], 3);
5499
5500         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5501         assert_eq!(cs_msgs.len(), 2);
5502         let mut a_done = false;
5503         for msg in cs_msgs {
5504                 match msg {
5505                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5506                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5507                                 // should be failed-backwards here.
5508                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5509                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5510                                         for htlc in &updates.update_fail_htlcs {
5511                                                 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 });
5512                                         }
5513                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5514                                         assert!(!a_done);
5515                                         a_done = true;
5516                                         &nodes[0]
5517                                 } else {
5518                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5519                                         for htlc in &updates.update_fail_htlcs {
5520                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5521                                         }
5522                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5523                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5524                                         &nodes[1]
5525                                 };
5526                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5527                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5528                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5529                                 if announce_latest {
5530                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5531                                         if *node_id == nodes[0].node.get_our_node_id() {
5532                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5533                                         }
5534                                 }
5535                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5536                         },
5537                         _ => panic!("Unexpected event"),
5538                 }
5539         }
5540
5541         let as_events = nodes[0].node.get_and_clear_pending_events();
5542         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5543         let mut as_failds = HashSet::new();
5544         for event in as_events.iter() {
5545                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5546                         assert!(as_failds.insert(*payment_hash));
5547                         if *payment_hash != payment_hash_2 {
5548                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5549                         } else {
5550                                 assert!(!rejected_by_dest);
5551                         }
5552                 } else { panic!("Unexpected event"); }
5553         }
5554         assert!(as_failds.contains(&payment_hash_1));
5555         assert!(as_failds.contains(&payment_hash_2));
5556         if announce_latest {
5557                 assert!(as_failds.contains(&payment_hash_3));
5558                 assert!(as_failds.contains(&payment_hash_5));
5559         }
5560         assert!(as_failds.contains(&payment_hash_6));
5561
5562         let bs_events = nodes[1].node.get_and_clear_pending_events();
5563         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5564         let mut bs_failds = HashSet::new();
5565         for event in bs_events.iter() {
5566                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5567                         assert!(bs_failds.insert(*payment_hash));
5568                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5569                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5570                         } else {
5571                                 assert!(!rejected_by_dest);
5572                         }
5573                 } else { panic!("Unexpected event"); }
5574         }
5575         assert!(bs_failds.contains(&payment_hash_1));
5576         assert!(bs_failds.contains(&payment_hash_2));
5577         if announce_latest {
5578                 assert!(bs_failds.contains(&payment_hash_4));
5579         }
5580         assert!(bs_failds.contains(&payment_hash_5));
5581
5582         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5583         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5584         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5585         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5586         // PaymentFailureNetworkUpdates.
5587         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5588         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5589         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5590         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5591         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5592                 match event {
5593                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5594                         _ => panic!("Unexpected event"),
5595                 }
5596         }
5597 }
5598
5599 #[test]
5600 fn test_fail_backwards_latest_remote_announce_a() {
5601         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5602 }
5603
5604 #[test]
5605 fn test_fail_backwards_latest_remote_announce_b() {
5606         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5607 }
5608
5609 #[test]
5610 fn test_fail_backwards_previous_remote_announce() {
5611         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5612         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5613         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5614 }
5615
5616 #[test]
5617 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5618         let chanmon_cfgs = create_chanmon_cfgs(2);
5619         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5620         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5621         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5622
5623         // Create some initial channels
5624         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5625
5626         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5627         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5628         assert_eq!(local_txn[0].input.len(), 1);
5629         check_spends!(local_txn[0], chan_1.3);
5630
5631         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5632         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5633         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5634         check_closed_broadcast!(nodes[0], false);
5635         check_added_monitors!(nodes[0], 1);
5636
5637         let htlc_timeout = {
5638                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5639                 assert_eq!(node_txn[0].input.len(), 1);
5640                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5641                 check_spends!(node_txn[0], local_txn[0]);
5642                 node_txn[0].clone()
5643         };
5644
5645         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5646         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5647         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5648         expect_payment_failed!(nodes[0], our_payment_hash, true);
5649
5650         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5651         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5652         assert_eq!(spend_txn.len(), 3);
5653         assert_eq!(spend_txn[0], spend_txn[1]);
5654         check_spends!(spend_txn[0], local_txn[0]);
5655         check_spends!(spend_txn[2], htlc_timeout);
5656 }
5657
5658 #[test]
5659 fn test_key_derivation_params() {
5660         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5661         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5662         // let us re-derive the channel key set to then derive a delayed_payment_key.
5663
5664         let chanmon_cfgs = create_chanmon_cfgs(3);
5665
5666         // We manually create the node configuration to backup the seed.
5667         let seed = [42; 32];
5668         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5669         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5670         let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5671         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5672         node_cfgs.remove(0);
5673         node_cfgs.insert(0, node);
5674
5675         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5676         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5677
5678         // Create some initial channels
5679         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5680         // for node 0
5681         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5682         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5683         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5684
5685         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5686         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5687         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5688         assert_eq!(local_txn_1[0].input.len(), 1);
5689         check_spends!(local_txn_1[0], chan_1.3);
5690
5691         // We check funding pubkey are unique
5692         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5693         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5694         if from_0_funding_key_0 == from_1_funding_key_0
5695             || from_0_funding_key_0 == from_1_funding_key_1
5696             || from_0_funding_key_1 == from_1_funding_key_0
5697             || from_0_funding_key_1 == from_1_funding_key_1 {
5698                 panic!("Funding pubkeys aren't unique");
5699         }
5700
5701         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5702         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5703         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5704         check_closed_broadcast!(nodes[0], false);
5705         check_added_monitors!(nodes[0], 1);
5706
5707         let htlc_timeout = {
5708                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5709                 assert_eq!(node_txn[0].input.len(), 1);
5710                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5711                 check_spends!(node_txn[0], local_txn_1[0]);
5712                 node_txn[0].clone()
5713         };
5714
5715         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5716         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5717         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5718         expect_payment_failed!(nodes[0], our_payment_hash, true);
5719
5720         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5721         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5722         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5723         assert_eq!(spend_txn.len(), 3);
5724         assert_eq!(spend_txn[0], spend_txn[1]);
5725         check_spends!(spend_txn[0], local_txn_1[0]);
5726         check_spends!(spend_txn[2], htlc_timeout);
5727 }
5728
5729 #[test]
5730 fn test_static_output_closing_tx() {
5731         let chanmon_cfgs = create_chanmon_cfgs(2);
5732         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5733         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5734         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5735
5736         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5737
5738         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5739         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5740
5741         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5742         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5743         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5744
5745         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5746         assert_eq!(spend_txn.len(), 1);
5747         check_spends!(spend_txn[0], closing_tx);
5748
5749         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5750         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5751
5752         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5753         assert_eq!(spend_txn.len(), 1);
5754         check_spends!(spend_txn[0], closing_tx);
5755 }
5756
5757 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5758         let chanmon_cfgs = create_chanmon_cfgs(2);
5759         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5760         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5761         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5762         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5763
5764         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5765
5766         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5767         // present in B's local commitment transaction, but none of A's commitment transactions.
5768         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5769         check_added_monitors!(nodes[1], 1);
5770
5771         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5772         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5773         let events = nodes[0].node.get_and_clear_pending_events();
5774         assert_eq!(events.len(), 1);
5775         match events[0] {
5776                 Event::PaymentSent { payment_preimage } => {
5777                         assert_eq!(payment_preimage, our_payment_preimage);
5778                 },
5779                 _ => panic!("Unexpected event"),
5780         }
5781
5782         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5783         check_added_monitors!(nodes[0], 1);
5784         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5785         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5786         check_added_monitors!(nodes[1], 1);
5787
5788         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5789         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5790                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5791                 header.prev_blockhash = header.bitcoin_hash();
5792         }
5793         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5794         check_closed_broadcast!(nodes[1], false);
5795         check_added_monitors!(nodes[1], 1);
5796 }
5797
5798 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5799         let chanmon_cfgs = create_chanmon_cfgs(2);
5800         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5801         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5802         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5803         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5804         let logger = test_utils::TestLogger::new();
5805
5806         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5807         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5808         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5809         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5810         check_added_monitors!(nodes[0], 1);
5811
5812         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5813
5814         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5815         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5816         // to "time out" the HTLC.
5817
5818         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5819
5820         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5821                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5822                 header.prev_blockhash = header.bitcoin_hash();
5823         }
5824         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5825         check_closed_broadcast!(nodes[0], false);
5826         check_added_monitors!(nodes[0], 1);
5827 }
5828
5829 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5830         let chanmon_cfgs = create_chanmon_cfgs(3);
5831         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5832         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5833         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5834         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5835
5836         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5837         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5838         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5839         // actually revoked.
5840         let htlc_value = if use_dust { 50000 } else { 3000000 };
5841         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5842         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5843         expect_pending_htlcs_forwardable!(nodes[1]);
5844         check_added_monitors!(nodes[1], 1);
5845
5846         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5847         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5848         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5849         check_added_monitors!(nodes[0], 1);
5850         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5851         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5852         check_added_monitors!(nodes[1], 1);
5853         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5854         check_added_monitors!(nodes[1], 1);
5855         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5856
5857         if check_revoke_no_close {
5858                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5859                 check_added_monitors!(nodes[0], 1);
5860         }
5861
5862         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5863         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5864                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5865                 header.prev_blockhash = header.bitcoin_hash();
5866         }
5867         if !check_revoke_no_close {
5868                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5869                 check_closed_broadcast!(nodes[0], false);
5870                 check_added_monitors!(nodes[0], 1);
5871         } else {
5872                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5873         }
5874 }
5875
5876 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5877 // There are only a few cases to test here:
5878 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5879 //    broadcastable commitment transactions result in channel closure,
5880 //  * its included in an unrevoked-but-previous remote commitment transaction,
5881 //  * its included in the latest remote or local commitment transactions.
5882 // We test each of the three possible commitment transactions individually and use both dust and
5883 // non-dust HTLCs.
5884 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5885 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5886 // tested for at least one of the cases in other tests.
5887 #[test]
5888 fn htlc_claim_single_commitment_only_a() {
5889         do_htlc_claim_local_commitment_only(true);
5890         do_htlc_claim_local_commitment_only(false);
5891
5892         do_htlc_claim_current_remote_commitment_only(true);
5893         do_htlc_claim_current_remote_commitment_only(false);
5894 }
5895
5896 #[test]
5897 fn htlc_claim_single_commitment_only_b() {
5898         do_htlc_claim_previous_remote_commitment_only(true, false);
5899         do_htlc_claim_previous_remote_commitment_only(false, false);
5900         do_htlc_claim_previous_remote_commitment_only(true, true);
5901         do_htlc_claim_previous_remote_commitment_only(false, true);
5902 }
5903
5904 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>)
5905         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5906                                 F2: FnMut(),
5907 {
5908         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);
5909 }
5910
5911 // test_case
5912 // 0: node1 fails backward
5913 // 1: final node fails backward
5914 // 2: payment completed but the user rejects the payment
5915 // 3: final node fails backward (but tamper onion payloads from node0)
5916 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5917 // 200: trigger error in the final node and tamper returning fail_htlc
5918 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>)
5919         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5920                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5921                                 F3: FnMut(),
5922 {
5923
5924         // reset block height
5925         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5926         for ix in 0..nodes.len() {
5927                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5928         }
5929
5930         macro_rules! expect_event {
5931                 ($node: expr, $event_type: path) => {{
5932                         let events = $node.node.get_and_clear_pending_events();
5933                         assert_eq!(events.len(), 1);
5934                         match events[0] {
5935                                 $event_type { .. } => {},
5936                                 _ => panic!("Unexpected event"),
5937                         }
5938                 }}
5939         }
5940
5941         macro_rules! expect_htlc_forward {
5942                 ($node: expr) => {{
5943                         expect_event!($node, Event::PendingHTLCsForwardable);
5944                         $node.node.process_pending_htlc_forwards();
5945                 }}
5946         }
5947
5948         // 0 ~~> 2 send payment
5949         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5950         check_added_monitors!(nodes[0], 1);
5951         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5952         // temper update_add (0 => 1)
5953         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5954         if test_case == 0 || test_case == 3 || test_case == 100 {
5955                 callback_msg(&mut update_add_0);
5956                 callback_node();
5957         }
5958         // 0 => 1 update_add & CS
5959         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5960         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5961
5962         let update_1_0 = match test_case {
5963                 0|100 => { // intermediate node failure; fail backward to 0
5964                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5965                         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));
5966                         update_1_0
5967                 },
5968                 1|2|3|200 => { // final node failure; forwarding to 2
5969                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5970                         // forwarding on 1
5971                         if test_case != 200 {
5972                                 callback_node();
5973                         }
5974                         expect_htlc_forward!(&nodes[1]);
5975
5976                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5977                         check_added_monitors!(&nodes[1], 1);
5978                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5979                         // tamper update_add (1 => 2)
5980                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5981                         if test_case != 3 && test_case != 200 {
5982                                 callback_msg(&mut update_add_1);
5983                         }
5984
5985                         // 1 => 2
5986                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5987                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5988
5989                         if test_case == 2 || test_case == 200 {
5990                                 expect_htlc_forward!(&nodes[2]);
5991                                 expect_event!(&nodes[2], Event::PaymentReceived);
5992                                 callback_node();
5993                                 expect_pending_htlcs_forwardable!(nodes[2]);
5994                         }
5995
5996                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5997                         if test_case == 2 || test_case == 200 {
5998                                 check_added_monitors!(&nodes[2], 1);
5999                         }
6000                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6001
6002                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6003                         if test_case == 200 {
6004                                 callback_fail(&mut fail_msg);
6005                         }
6006
6007                         // 2 => 1
6008                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
6009                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6010
6011                         // backward fail on 1
6012                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6013                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6014                         update_1_0
6015                 },
6016                 _ => unreachable!(),
6017         };
6018
6019         // 1 => 0 commitment_signed_dance
6020         if update_1_0.update_fail_htlcs.len() > 0 {
6021                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6022                 if test_case == 100 {
6023                         callback_fail(&mut fail_msg);
6024                 }
6025                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6026         } else {
6027                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6028         };
6029
6030         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6031
6032         let events = nodes[0].node.get_and_clear_pending_events();
6033         assert_eq!(events.len(), 1);
6034         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6035                 assert_eq!(*rejected_by_dest, !expected_retryable);
6036                 assert_eq!(*error_code, expected_error_code);
6037         } else {
6038                 panic!("Uexpected event");
6039         }
6040
6041         let events = nodes[0].node.get_and_clear_pending_msg_events();
6042         if expected_channel_update.is_some() {
6043                 assert_eq!(events.len(), 1);
6044                 match events[0] {
6045                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6046                                 match update {
6047                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6048                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6049                                                         panic!("channel_update not found!");
6050                                                 }
6051                                         },
6052                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6053                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6054                                                         assert!(*short_channel_id == *expected_short_channel_id);
6055                                                         assert!(*is_permanent == *expected_is_permanent);
6056                                                 } else {
6057                                                         panic!("Unexpected message event");
6058                                                 }
6059                                         },
6060                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6061                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6062                                                         assert!(*node_id == *expected_node_id);
6063                                                         assert!(*is_permanent == *expected_is_permanent);
6064                                                 } else {
6065                                                         panic!("Unexpected message event");
6066                                                 }
6067                                         },
6068                                 }
6069                         },
6070                         _ => panic!("Unexpected message event"),
6071                 }
6072         } else {
6073                 assert_eq!(events.len(), 0);
6074         }
6075 }
6076
6077 impl msgs::ChannelUpdate {
6078         fn dummy() -> msgs::ChannelUpdate {
6079                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6080                 use bitcoin::secp256k1::Signature;
6081                 msgs::ChannelUpdate {
6082                         signature: Signature::from(FFISignature::new()),
6083                         contents: msgs::UnsignedChannelUpdate {
6084                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6085                                 short_channel_id: 0,
6086                                 timestamp: 0,
6087                                 flags: 0,
6088                                 cltv_expiry_delta: 0,
6089                                 htlc_minimum_msat: 0,
6090                                 htlc_maximum_msat: OptionalField::Absent,
6091                                 fee_base_msat: 0,
6092                                 fee_proportional_millionths: 0,
6093                                 excess_data: vec![],
6094                         }
6095                 }
6096         }
6097 }
6098
6099 struct BogusOnionHopData {
6100         data: Vec<u8>
6101 }
6102 impl BogusOnionHopData {
6103         fn new(orig: msgs::OnionHopData) -> Self {
6104                 Self { data: orig.encode() }
6105         }
6106 }
6107 impl Writeable for BogusOnionHopData {
6108         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6109                 writer.write_all(&self.data[..])
6110         }
6111 }
6112
6113 #[test]
6114 fn test_onion_failure() {
6115         use ln::msgs::ChannelUpdate;
6116         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6117         use bitcoin::secp256k1;
6118
6119         const BADONION: u16 = 0x8000;
6120         const PERM: u16 = 0x4000;
6121         const NODE: u16 = 0x2000;
6122         const UPDATE: u16 = 0x1000;
6123
6124         let chanmon_cfgs = create_chanmon_cfgs(3);
6125         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6126         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6127         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6128         for node in nodes.iter() {
6129                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6130         }
6131         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
6132         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6133         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6134         let logger = test_utils::TestLogger::new();
6135         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
6136         // positve case
6137         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6138
6139         // intermediate node failure
6140         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6141                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6142                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6143                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6144                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6145                 let mut new_payloads = Vec::new();
6146                 for payload in onion_payloads.drain(..) {
6147                         new_payloads.push(BogusOnionHopData::new(payload));
6148                 }
6149                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6150                 // describing a length-1 TLV payload, which is obviously bogus.
6151                 new_payloads[0].data[0] = 1;
6152                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6153         }, ||{}, 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
6154
6155         // final node failure
6156         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6157                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6158                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6159                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6160                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6161                 let mut new_payloads = Vec::new();
6162                 for payload in onion_payloads.drain(..) {
6163                         new_payloads.push(BogusOnionHopData::new(payload));
6164                 }
6165                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6166                 // length-1 TLV payload, which is obviously bogus.
6167                 new_payloads[1].data[0] = 1;
6168                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6169         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6170
6171         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6172         // receiving simulated fail messages
6173         // intermediate node failure
6174         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6175                 // trigger error
6176                 msg.amount_msat -= 1;
6177         }, |msg| {
6178                 // and tamper returning error message
6179                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6180                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6181                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6182         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6183
6184         // final node failure
6185         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6186                 // and tamper returning error message
6187                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6188                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6189                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6190         }, ||{
6191                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6192         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6193
6194         // intermediate node failure
6195         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6196                 msg.amount_msat -= 1;
6197         }, |msg| {
6198                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6199                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6200                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6201         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6202
6203         // final node failure
6204         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6205                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6206                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6207                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6208         }, ||{
6209                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6210         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6211
6212         // intermediate node failure
6213         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6214                 msg.amount_msat -= 1;
6215         }, |msg| {
6216                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6217                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6218                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6219         }, ||{
6220                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6221         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6222
6223         // final node failure
6224         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6225                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6226                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6227                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6228         }, ||{
6229                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6230         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6231
6232         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6233                 Some(BADONION|PERM|4), None);
6234
6235         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6236                 Some(BADONION|PERM|5), None);
6237
6238         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6239                 Some(BADONION|PERM|6), None);
6240
6241         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6242                 msg.amount_msat -= 1;
6243         }, |msg| {
6244                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6245                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6246                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6247         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6248
6249         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6250                 msg.amount_msat -= 1;
6251         }, |msg| {
6252                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6253                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6254                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6255                 // short_channel_id from the processing node
6256         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6257
6258         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6259                 msg.amount_msat -= 1;
6260         }, |msg| {
6261                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6262                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6263                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6264                 // short_channel_id from the processing node
6265         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6266
6267         let mut bogus_route = route.clone();
6268         bogus_route.paths[0][1].short_channel_id -= 1;
6269         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6270           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6271
6272         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6273         let mut bogus_route = route.clone();
6274         let route_len = bogus_route.paths[0].len();
6275         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6276         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6277
6278         //TODO: with new config API, we will be able to generate both valid and
6279         //invalid channel_update cases.
6280         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6281                 msg.amount_msat -= 1;
6282         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6283
6284         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6285                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6286                 msg.cltv_expiry -= 1;
6287         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6288
6289         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6290                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6291                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6292
6293                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6294         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6295
6296         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6297                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6298         }, false, Some(PERM|15), None);
6299
6300         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6301                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6302                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6303
6304                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6305         }, || {}, true, Some(17), None);
6306
6307         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6308                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6309                         for f in pending_forwards.iter_mut() {
6310                                 match f {
6311                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6312                                                 forward_info.outgoing_cltv_value += 1,
6313                                         _ => {},
6314                                 }
6315                         }
6316                 }
6317         }, true, Some(18), None);
6318
6319         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6320                 // violate amt_to_forward > msg.amount_msat
6321                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6322                         for f in pending_forwards.iter_mut() {
6323                                 match f {
6324                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6325                                                 forward_info.amt_to_forward -= 1,
6326                                         _ => {},
6327                                 }
6328                         }
6329                 }
6330         }, true, Some(19), None);
6331
6332         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6333                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6334                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6335                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6336         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6337         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6338
6339         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6340                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6341                 let mut route = route.clone();
6342                 let height = 1;
6343                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6344                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6345                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6346                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6347                 msg.cltv_expiry = htlc_cltv;
6348                 msg.onion_routing_packet = onion_packet;
6349         }, ||{}, true, Some(21), None);
6350 }
6351
6352 #[test]
6353 #[should_panic]
6354 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6355         let chanmon_cfgs = create_chanmon_cfgs(2);
6356         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6357         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6358         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6359         //Force duplicate channel ids
6360         for node in nodes.iter() {
6361                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6362         }
6363
6364         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6365         let channel_value_satoshis=10000;
6366         let push_msat=10001;
6367         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6368         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6369         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6370
6371         //Create a second channel with a channel_id collision
6372         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6373 }
6374
6375 #[test]
6376 fn bolt2_open_channel_sending_node_checks_part2() {
6377         let chanmon_cfgs = create_chanmon_cfgs(2);
6378         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6379         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6380         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6381
6382         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6383         let channel_value_satoshis=2^24;
6384         let push_msat=10001;
6385         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6386
6387         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6388         let channel_value_satoshis=10000;
6389         // Test when push_msat is equal to 1000 * funding_satoshis.
6390         let push_msat=1000*channel_value_satoshis+1;
6391         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6392
6393         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6394         let channel_value_satoshis=10000;
6395         let push_msat=10001;
6396         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
6397         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6398         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6399
6400         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6401         // 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
6402         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6403
6404         // 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.
6405         assert!(BREAKDOWN_TIMEOUT>0);
6406         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6407
6408         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6409         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6410         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6411
6412         // 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.
6413         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6414         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6415         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6416         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6417         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6418 }
6419
6420 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6421 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6422 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6423 // is no longer affordable once it's freed.
6424 #[test]
6425 fn test_fail_holding_cell_htlc_upon_free() {
6426         let chanmon_cfgs = create_chanmon_cfgs(2);
6427         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6428         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6429         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6430         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6431         let logger = test_utils::TestLogger::new();
6432
6433         // First nodes[0] generates an update_fee, setting the channel's
6434         // pending_update_fee.
6435         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6436         check_added_monitors!(nodes[0], 1);
6437
6438         let events = nodes[0].node.get_and_clear_pending_msg_events();
6439         assert_eq!(events.len(), 1);
6440         let (update_msg, commitment_signed) = match events[0] {
6441                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6442                         (update_fee.as_ref(), commitment_signed)
6443                 },
6444                 _ => panic!("Unexpected event"),
6445         };
6446
6447         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6448
6449         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6450         let channel_reserve = chan_stat.channel_reserve_msat;
6451         let feerate = get_feerate!(nodes[0], chan.2);
6452
6453         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6454         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6455         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6456         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6457         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6458
6459         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6460         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6461         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6462         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6463
6464         // Flush the pending fee update.
6465         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6466         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6467         check_added_monitors!(nodes[1], 1);
6468         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6469         check_added_monitors!(nodes[0], 1);
6470
6471         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6472         // HTLC, but now that the fee has been raised the payment will now fail, causing
6473         // us to surface its failure to the user.
6474         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6475         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6476         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6477         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6478         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6479
6480         // Check that the payment failed to be sent out.
6481         let events = nodes[0].node.get_and_clear_pending_events();
6482         assert_eq!(events.len(), 1);
6483         match &events[0] {
6484                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6485                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6486                         assert_eq!(*rejected_by_dest, false);
6487                         assert_eq!(*error_code, None);
6488                         assert_eq!(*error_data, None);
6489                 },
6490                 _ => panic!("Unexpected event"),
6491         }
6492 }
6493
6494 // Test that if multiple HTLCs are released from the holding cell and one is
6495 // valid but the other is no longer valid upon release, the valid HTLC can be
6496 // successfully completed while the other one fails as expected.
6497 #[test]
6498 fn test_free_and_fail_holding_cell_htlcs() {
6499         let chanmon_cfgs = create_chanmon_cfgs(2);
6500         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6501         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6502         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6503         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6504         let logger = test_utils::TestLogger::new();
6505
6506         // First nodes[0] generates an update_fee, setting the channel's
6507         // pending_update_fee.
6508         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6509         check_added_monitors!(nodes[0], 1);
6510
6511         let events = nodes[0].node.get_and_clear_pending_msg_events();
6512         assert_eq!(events.len(), 1);
6513         let (update_msg, commitment_signed) = match events[0] {
6514                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6515                         (update_fee.as_ref(), commitment_signed)
6516                 },
6517                 _ => panic!("Unexpected event"),
6518         };
6519
6520         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6521
6522         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6523         let channel_reserve = chan_stat.channel_reserve_msat;
6524         let feerate = get_feerate!(nodes[0], chan.2);
6525
6526         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6527         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6528         let amt_1 = 20000;
6529         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6530         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6531         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6532         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6533         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6534
6535         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6536         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6537         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6538         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6539         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6540         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6541         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6542
6543         // Flush the pending fee update.
6544         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6545         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6546         check_added_monitors!(nodes[1], 1);
6547         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6548         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6549         check_added_monitors!(nodes[0], 2);
6550
6551         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6552         // but now that the fee has been raised the second payment will now fail, causing us
6553         // to surface its failure to the user. The first payment should succeed.
6554         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6555         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6556         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6557         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6558         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6559
6560         // Check that the second payment failed to be sent out.
6561         let events = nodes[0].node.get_and_clear_pending_events();
6562         assert_eq!(events.len(), 1);
6563         match &events[0] {
6564                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6565                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6566                         assert_eq!(*rejected_by_dest, false);
6567                         assert_eq!(*error_code, None);
6568                         assert_eq!(*error_data, None);
6569                 },
6570                 _ => panic!("Unexpected event"),
6571         }
6572
6573         // Complete the first payment and the RAA from the fee update.
6574         let (payment_event, send_raa_event) = {
6575                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6576                 assert_eq!(msgs.len(), 2);
6577                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6578         };
6579         let raa = match send_raa_event {
6580                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6581                 _ => panic!("Unexpected event"),
6582         };
6583         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6584         check_added_monitors!(nodes[1], 1);
6585         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6586         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6587         let events = nodes[1].node.get_and_clear_pending_events();
6588         assert_eq!(events.len(), 1);
6589         match events[0] {
6590                 Event::PendingHTLCsForwardable { .. } => {},
6591                 _ => panic!("Unexpected event"),
6592         }
6593         nodes[1].node.process_pending_htlc_forwards();
6594         let events = nodes[1].node.get_and_clear_pending_events();
6595         assert_eq!(events.len(), 1);
6596         match events[0] {
6597                 Event::PaymentReceived { .. } => {},
6598                 _ => panic!("Unexpected event"),
6599         }
6600         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6601         check_added_monitors!(nodes[1], 1);
6602         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6603         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6604         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6605         let events = nodes[0].node.get_and_clear_pending_events();
6606         assert_eq!(events.len(), 1);
6607         match events[0] {
6608                 Event::PaymentSent { ref payment_preimage } => {
6609                         assert_eq!(*payment_preimage, payment_preimage_1);
6610                 }
6611                 _ => panic!("Unexpected event"),
6612         }
6613 }
6614
6615 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6616 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6617 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6618 // once it's freed.
6619 #[test]
6620 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6621         let chanmon_cfgs = create_chanmon_cfgs(3);
6622         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6623         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6624         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6625         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6626         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6627         let logger = test_utils::TestLogger::new();
6628
6629         // First nodes[1] generates an update_fee, setting the channel's
6630         // pending_update_fee.
6631         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6632         check_added_monitors!(nodes[1], 1);
6633
6634         let events = nodes[1].node.get_and_clear_pending_msg_events();
6635         assert_eq!(events.len(), 1);
6636         let (update_msg, commitment_signed) = match events[0] {
6637                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6638                         (update_fee.as_ref(), commitment_signed)
6639                 },
6640                 _ => panic!("Unexpected event"),
6641         };
6642
6643         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6644
6645         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6646         let channel_reserve = chan_stat.channel_reserve_msat;
6647         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6648
6649         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6650         let feemsat = 239;
6651         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6652         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6653         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6654         let payment_event = {
6655                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6656                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6657                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6658                 check_added_monitors!(nodes[0], 1);
6659
6660                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6661                 assert_eq!(events.len(), 1);
6662
6663                 SendEvent::from_event(events.remove(0))
6664         };
6665         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6666         check_added_monitors!(nodes[1], 0);
6667         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6668         expect_pending_htlcs_forwardable!(nodes[1]);
6669
6670         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6671         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6672
6673         // Flush the pending fee update.
6674         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6675         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6676         check_added_monitors!(nodes[2], 1);
6677         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6678         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6679         check_added_monitors!(nodes[1], 2);
6680
6681         // A final RAA message is generated to finalize the fee update.
6682         let events = nodes[1].node.get_and_clear_pending_msg_events();
6683         assert_eq!(events.len(), 1);
6684
6685         let raa_msg = match &events[0] {
6686                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6687                         msg.clone()
6688                 },
6689                 _ => panic!("Unexpected event"),
6690         };
6691
6692         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6693         check_added_monitors!(nodes[2], 1);
6694         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6695
6696         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6697         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6698         assert_eq!(process_htlc_forwards_event.len(), 1);
6699         match &process_htlc_forwards_event[0] {
6700                 &Event::PendingHTLCsForwardable { .. } => {},
6701                 _ => panic!("Unexpected event"),
6702         }
6703
6704         // In response, we call ChannelManager's process_pending_htlc_forwards
6705         nodes[1].node.process_pending_htlc_forwards();
6706         check_added_monitors!(nodes[1], 1);
6707
6708         // This causes the HTLC to be failed backwards.
6709         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6710         assert_eq!(fail_event.len(), 1);
6711         let (fail_msg, commitment_signed) = match &fail_event[0] {
6712                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6713                         assert_eq!(updates.update_add_htlcs.len(), 0);
6714                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6715                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6716                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6717                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6718                 },
6719                 _ => panic!("Unexpected event"),
6720         };
6721
6722         // Pass the failure messages back to nodes[0].
6723         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6724         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6725
6726         // Complete the HTLC failure+removal process.
6727         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6728         check_added_monitors!(nodes[0], 1);
6729         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6730         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6731         check_added_monitors!(nodes[1], 2);
6732         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6733         assert_eq!(final_raa_event.len(), 1);
6734         let raa = match &final_raa_event[0] {
6735                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6736                 _ => panic!("Unexpected event"),
6737         };
6738         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6739         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6740         assert_eq!(fail_msg_event.len(), 1);
6741         match &fail_msg_event[0] {
6742                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6743                 _ => panic!("Unexpected event"),
6744         }
6745         let failure_event = nodes[0].node.get_and_clear_pending_events();
6746         assert_eq!(failure_event.len(), 1);
6747         match &failure_event[0] {
6748                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6749                         assert!(!rejected_by_dest);
6750                 },
6751                 _ => panic!("Unexpected event"),
6752         }
6753         check_added_monitors!(nodes[0], 1);
6754 }
6755
6756 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6757 // 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.
6758 //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.
6759
6760 #[test]
6761 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6762         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6763         let chanmon_cfgs = create_chanmon_cfgs(2);
6764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6765         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6766         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6767         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6768
6769         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6770         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6771         let logger = test_utils::TestLogger::new();
6772         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6773         route.paths[0][0].fee_msat = 100;
6774
6775         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6776                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6777         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6778         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6779 }
6780
6781 #[test]
6782 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6783         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6784         let chanmon_cfgs = create_chanmon_cfgs(2);
6785         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6786         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6787         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6788         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6789         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6790
6791         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6792         let logger = test_utils::TestLogger::new();
6793         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6794         route.paths[0][0].fee_msat = 0;
6795         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6796                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6797
6798         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6799         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6800 }
6801
6802 #[test]
6803 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6804         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6805         let chanmon_cfgs = create_chanmon_cfgs(2);
6806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6809         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6810
6811         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6812         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6813         let logger = test_utils::TestLogger::new();
6814         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6815         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6816         check_added_monitors!(nodes[0], 1);
6817         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6818         updates.update_add_htlcs[0].amount_msat = 0;
6819
6820         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6821         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6822         check_closed_broadcast!(nodes[1], true).unwrap();
6823         check_added_monitors!(nodes[1], 1);
6824 }
6825
6826 #[test]
6827 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6828         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6829         //It is enforced when constructing a route.
6830         let chanmon_cfgs = create_chanmon_cfgs(2);
6831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6833         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6834         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6835         let logger = test_utils::TestLogger::new();
6836
6837         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6838
6839         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6840         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001, &logger).unwrap();
6841         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6842                 assert_eq!(err, &"Channel CLTV overflowed?"));
6843 }
6844
6845 #[test]
6846 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6847         //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.
6848         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6849         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6850         let chanmon_cfgs = create_chanmon_cfgs(2);
6851         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6852         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6853         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6854         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6855         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6856
6857         let logger = test_utils::TestLogger::new();
6858         for i in 0..max_accepted_htlcs {
6859                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6860                 let payment_event = {
6861                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6862                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6863                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6864                         check_added_monitors!(nodes[0], 1);
6865
6866                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6867                         assert_eq!(events.len(), 1);
6868                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6869                                 assert_eq!(htlcs[0].htlc_id, i);
6870                         } else {
6871                                 assert!(false);
6872                         }
6873                         SendEvent::from_event(events.remove(0))
6874                 };
6875                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6876                 check_added_monitors!(nodes[1], 0);
6877                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6878
6879                 expect_pending_htlcs_forwardable!(nodes[1]);
6880                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6881         }
6882         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6883         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6884         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6885         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6886                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6887
6888         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6889         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6890 }
6891
6892 #[test]
6893 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6894         //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.
6895         let chanmon_cfgs = create_chanmon_cfgs(2);
6896         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6897         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6898         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6899         let channel_value = 100000;
6900         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6901         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6902
6903         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6904
6905         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6906         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6907         let logger = test_utils::TestLogger::new();
6908         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6909         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6910                 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
6911
6912         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6913         nodes[0].logger.assert_log_contains("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);
6914
6915         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6916 }
6917
6918 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6919 #[test]
6920 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6921         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6922         let chanmon_cfgs = create_chanmon_cfgs(2);
6923         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6924         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6925         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6926         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6927         let htlc_minimum_msat: u64;
6928         {
6929                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6930                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6931                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6932         }
6933
6934         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6935         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6936         let logger = test_utils::TestLogger::new();
6937         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6938         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6939         check_added_monitors!(nodes[0], 1);
6940         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6941         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6942         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6943         assert!(nodes[1].node.list_channels().is_empty());
6944         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6945         assert!(regex::Regex::new(r"Remote side tried to send less than our minimum HTLC value\. Lower limit: \(\d+\)\. Actual: \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6946         check_added_monitors!(nodes[1], 1);
6947 }
6948
6949 #[test]
6950 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6951         //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
6952         let chanmon_cfgs = create_chanmon_cfgs(2);
6953         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6954         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6955         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6956         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6957         let logger = test_utils::TestLogger::new();
6958
6959         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6960         let channel_reserve = chan_stat.channel_reserve_msat;
6961         let feerate = get_feerate!(nodes[0], chan.2);
6962         // The 2* and +1 are for the fee spike reserve.
6963         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6964
6965         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6966         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6967         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6968         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6969         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6970         check_added_monitors!(nodes[0], 1);
6971         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6972
6973         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6974         // at this time channel-initiatee receivers are not required to enforce that senders
6975         // respect the fee_spike_reserve.
6976         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6977         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6978
6979         assert!(nodes[1].node.list_channels().is_empty());
6980         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6981         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6982         check_added_monitors!(nodes[1], 1);
6983 }
6984
6985 #[test]
6986 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6987         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6988         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6989         let chanmon_cfgs = create_chanmon_cfgs(2);
6990         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6991         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6992         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6993         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6994         let logger = test_utils::TestLogger::new();
6995
6996         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6997         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6998
6999         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7000         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
7001
7002         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
7003         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
7004         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
7005         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
7006
7007         let mut msg = msgs::UpdateAddHTLC {
7008                 channel_id: chan.2,
7009                 htlc_id: 0,
7010                 amount_msat: 1000,
7011                 payment_hash: our_payment_hash,
7012                 cltv_expiry: htlc_cltv,
7013                 onion_routing_packet: onion_packet.clone(),
7014         };
7015
7016         for i in 0..super::channel::OUR_MAX_HTLCS {
7017                 msg.htlc_id = i as u64;
7018                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
7019         }
7020         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
7021         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
7022
7023         assert!(nodes[1].node.list_channels().is_empty());
7024         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7025         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
7026         check_added_monitors!(nodes[1], 1);
7027 }
7028
7029 #[test]
7030 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
7031         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
7032         let chanmon_cfgs = create_chanmon_cfgs(2);
7033         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7034         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7035         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7036         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7037         let logger = test_utils::TestLogger::new();
7038
7039         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7040         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7041         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7042         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7043         check_added_monitors!(nodes[0], 1);
7044         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7045         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
7046         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7047
7048         assert!(nodes[1].node.list_channels().is_empty());
7049         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7050         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
7051         check_added_monitors!(nodes[1], 1);
7052 }
7053
7054 #[test]
7055 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
7056         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
7057         let chanmon_cfgs = create_chanmon_cfgs(2);
7058         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7059         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7060         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7061         let logger = test_utils::TestLogger::new();
7062
7063         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
7064         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7065         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7066         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7067         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7068         check_added_monitors!(nodes[0], 1);
7069         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7070         updates.update_add_htlcs[0].cltv_expiry = 500000000;
7071         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7072
7073         assert!(nodes[1].node.list_channels().is_empty());
7074         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7075         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
7076         check_added_monitors!(nodes[1], 1);
7077 }
7078
7079 #[test]
7080 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
7081         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
7082         // We test this by first testing that that repeated HTLCs pass commitment signature checks
7083         // after disconnect and that non-sequential htlc_ids result in a channel failure.
7084         let chanmon_cfgs = create_chanmon_cfgs(2);
7085         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7086         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7087         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7088         let logger = test_utils::TestLogger::new();
7089
7090         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7091         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7092         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7093         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7094         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7095         check_added_monitors!(nodes[0], 1);
7096         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7097         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7098
7099         //Disconnect and Reconnect
7100         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7101         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7102         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7103         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7104         assert_eq!(reestablish_1.len(), 1);
7105         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7106         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7107         assert_eq!(reestablish_2.len(), 1);
7108         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7109         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7110         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7111         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7112
7113         //Resend HTLC
7114         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7115         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
7116         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
7117         check_added_monitors!(nodes[1], 1);
7118         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7119
7120         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7121
7122         assert!(nodes[1].node.list_channels().is_empty());
7123         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7124         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
7125         check_added_monitors!(nodes[1], 1);
7126 }
7127
7128 #[test]
7129 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
7130         //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.
7131
7132         let chanmon_cfgs = create_chanmon_cfgs(2);
7133         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7134         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7135         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7136         let logger = test_utils::TestLogger::new();
7137         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7138         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7139         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7140         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7141         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7142
7143         check_added_monitors!(nodes[0], 1);
7144         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7145         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7146
7147         let update_msg = msgs::UpdateFulfillHTLC{
7148                 channel_id: chan.2,
7149                 htlc_id: 0,
7150                 payment_preimage: our_payment_preimage,
7151         };
7152
7153         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7154
7155         assert!(nodes[0].node.list_channels().is_empty());
7156         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7157         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
7158         check_added_monitors!(nodes[0], 1);
7159 }
7160
7161 #[test]
7162 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
7163         //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.
7164
7165         let chanmon_cfgs = create_chanmon_cfgs(2);
7166         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7167         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7168         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7169         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7170         let logger = test_utils::TestLogger::new();
7171
7172         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7173         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7174         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7175         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7176         check_added_monitors!(nodes[0], 1);
7177         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7178         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7179
7180         let update_msg = msgs::UpdateFailHTLC{
7181                 channel_id: chan.2,
7182                 htlc_id: 0,
7183                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7184         };
7185
7186         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7187
7188         assert!(nodes[0].node.list_channels().is_empty());
7189         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7190         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
7191         check_added_monitors!(nodes[0], 1);
7192 }
7193
7194 #[test]
7195 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7196         //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.
7197
7198         let chanmon_cfgs = create_chanmon_cfgs(2);
7199         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7200         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7201         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7202         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7203         let logger = test_utils::TestLogger::new();
7204
7205         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7206         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7207         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7208         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7209         check_added_monitors!(nodes[0], 1);
7210         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7211         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7212
7213         let update_msg = msgs::UpdateFailMalformedHTLC{
7214                 channel_id: chan.2,
7215                 htlc_id: 0,
7216                 sha256_of_onion: [1; 32],
7217                 failure_code: 0x8000,
7218         };
7219
7220         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7221
7222         assert!(nodes[0].node.list_channels().is_empty());
7223         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7224         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
7225         check_added_monitors!(nodes[0], 1);
7226 }
7227
7228 #[test]
7229 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7230         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7231
7232         let chanmon_cfgs = create_chanmon_cfgs(2);
7233         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7234         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7235         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7236         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7237
7238         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7239
7240         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7241         check_added_monitors!(nodes[1], 1);
7242
7243         let events = nodes[1].node.get_and_clear_pending_msg_events();
7244         assert_eq!(events.len(), 1);
7245         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7246                 match events[0] {
7247                         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, .. } } => {
7248                                 assert!(update_add_htlcs.is_empty());
7249                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7250                                 assert!(update_fail_htlcs.is_empty());
7251                                 assert!(update_fail_malformed_htlcs.is_empty());
7252                                 assert!(update_fee.is_none());
7253                                 update_fulfill_htlcs[0].clone()
7254                         },
7255                         _ => panic!("Unexpected event"),
7256                 }
7257         };
7258
7259         update_fulfill_msg.htlc_id = 1;
7260
7261         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7262
7263         assert!(nodes[0].node.list_channels().is_empty());
7264         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7265         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7266         check_added_monitors!(nodes[0], 1);
7267 }
7268
7269 #[test]
7270 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7271         //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.
7272
7273         let chanmon_cfgs = create_chanmon_cfgs(2);
7274         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7275         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7276         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7277         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7278
7279         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7280
7281         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7282         check_added_monitors!(nodes[1], 1);
7283
7284         let events = nodes[1].node.get_and_clear_pending_msg_events();
7285         assert_eq!(events.len(), 1);
7286         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7287                 match events[0] {
7288                         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, .. } } => {
7289                                 assert!(update_add_htlcs.is_empty());
7290                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7291                                 assert!(update_fail_htlcs.is_empty());
7292                                 assert!(update_fail_malformed_htlcs.is_empty());
7293                                 assert!(update_fee.is_none());
7294                                 update_fulfill_htlcs[0].clone()
7295                         },
7296                         _ => panic!("Unexpected event"),
7297                 }
7298         };
7299
7300         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7301
7302         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7303
7304         assert!(nodes[0].node.list_channels().is_empty());
7305         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7306         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7307         check_added_monitors!(nodes[0], 1);
7308 }
7309
7310 #[test]
7311 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7312         //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.
7313
7314         let chanmon_cfgs = create_chanmon_cfgs(2);
7315         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7316         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7317         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7318         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7319         let logger = test_utils::TestLogger::new();
7320
7321         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7322         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7323         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7324         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7325         check_added_monitors!(nodes[0], 1);
7326
7327         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7328         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7329
7330         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7331         check_added_monitors!(nodes[1], 0);
7332         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7333
7334         let events = nodes[1].node.get_and_clear_pending_msg_events();
7335
7336         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7337                 match events[0] {
7338                         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, .. } } => {
7339                                 assert!(update_add_htlcs.is_empty());
7340                                 assert!(update_fulfill_htlcs.is_empty());
7341                                 assert!(update_fail_htlcs.is_empty());
7342                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7343                                 assert!(update_fee.is_none());
7344                                 update_fail_malformed_htlcs[0].clone()
7345                         },
7346                         _ => panic!("Unexpected event"),
7347                 }
7348         };
7349         update_msg.failure_code &= !0x8000;
7350         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7351
7352         assert!(nodes[0].node.list_channels().is_empty());
7353         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7354         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7355         check_added_monitors!(nodes[0], 1);
7356 }
7357
7358 #[test]
7359 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7360         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7361         //    * 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.
7362
7363         let chanmon_cfgs = create_chanmon_cfgs(3);
7364         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7365         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7366         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7367         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7368         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7369         let logger = test_utils::TestLogger::new();
7370
7371         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7372
7373         //First hop
7374         let mut payment_event = {
7375                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7376                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7377                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7378                 check_added_monitors!(nodes[0], 1);
7379                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7380                 assert_eq!(events.len(), 1);
7381                 SendEvent::from_event(events.remove(0))
7382         };
7383         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7384         check_added_monitors!(nodes[1], 0);
7385         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7386         expect_pending_htlcs_forwardable!(nodes[1]);
7387         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7388         assert_eq!(events_2.len(), 1);
7389         check_added_monitors!(nodes[1], 1);
7390         payment_event = SendEvent::from_event(events_2.remove(0));
7391         assert_eq!(payment_event.msgs.len(), 1);
7392
7393         //Second Hop
7394         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7395         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7396         check_added_monitors!(nodes[2], 0);
7397         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7398
7399         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7400         assert_eq!(events_3.len(), 1);
7401         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7402                 match events_3[0] {
7403                         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 } } => {
7404                                 assert!(update_add_htlcs.is_empty());
7405                                 assert!(update_fulfill_htlcs.is_empty());
7406                                 assert!(update_fail_htlcs.is_empty());
7407                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7408                                 assert!(update_fee.is_none());
7409                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7410                         },
7411                         _ => panic!("Unexpected event"),
7412                 }
7413         };
7414
7415         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7416
7417         check_added_monitors!(nodes[1], 0);
7418         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7419         expect_pending_htlcs_forwardable!(nodes[1]);
7420         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7421         assert_eq!(events_4.len(), 1);
7422
7423         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7424         match events_4[0] {
7425                 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, .. } } => {
7426                         assert!(update_add_htlcs.is_empty());
7427                         assert!(update_fulfill_htlcs.is_empty());
7428                         assert_eq!(update_fail_htlcs.len(), 1);
7429                         assert!(update_fail_malformed_htlcs.is_empty());
7430                         assert!(update_fee.is_none());
7431                 },
7432                 _ => panic!("Unexpected event"),
7433         };
7434
7435         check_added_monitors!(nodes[1], 1);
7436 }
7437
7438 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7439         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7440         // 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
7441         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7442
7443         let chanmon_cfgs = create_chanmon_cfgs(2);
7444         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7445         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7446         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7447         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7448
7449         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7450
7451         // We route 2 dust-HTLCs between A and B
7452         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7453         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7454         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7455
7456         // Cache one local commitment tx as previous
7457         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7458
7459         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7460         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7461         check_added_monitors!(nodes[1], 0);
7462         expect_pending_htlcs_forwardable!(nodes[1]);
7463         check_added_monitors!(nodes[1], 1);
7464
7465         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7466         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7467         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7468         check_added_monitors!(nodes[0], 1);
7469
7470         // Cache one local commitment tx as lastest
7471         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7472
7473         let events = nodes[0].node.get_and_clear_pending_msg_events();
7474         match events[0] {
7475                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7476                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7477                 },
7478                 _ => panic!("Unexpected event"),
7479         }
7480         match events[1] {
7481                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7482                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7483                 },
7484                 _ => panic!("Unexpected event"),
7485         }
7486
7487         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7488         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7489         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7490
7491         if announce_latest {
7492                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7493         } else {
7494                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7495         }
7496
7497         check_closed_broadcast!(nodes[0], false);
7498         check_added_monitors!(nodes[0], 1);
7499
7500         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7501         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7502         let events = nodes[0].node.get_and_clear_pending_events();
7503         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7504         assert_eq!(events.len(), 2);
7505         let mut first_failed = false;
7506         for event in events {
7507                 match event {
7508                         Event::PaymentFailed { payment_hash, .. } => {
7509                                 if payment_hash == payment_hash_1 {
7510                                         assert!(!first_failed);
7511                                         first_failed = true;
7512                                 } else {
7513                                         assert_eq!(payment_hash, payment_hash_2);
7514                                 }
7515                         }
7516                         _ => panic!("Unexpected event"),
7517                 }
7518         }
7519 }
7520
7521 #[test]
7522 fn test_failure_delay_dust_htlc_local_commitment() {
7523         do_test_failure_delay_dust_htlc_local_commitment(true);
7524         do_test_failure_delay_dust_htlc_local_commitment(false);
7525 }
7526
7527 #[test]
7528 fn test_no_failure_dust_htlc_local_commitment() {
7529         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7530         // prone to error, we test here that a dummy transaction don't fail them.
7531
7532         let chanmon_cfgs = create_chanmon_cfgs(2);
7533         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7534         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7535         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7536         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7537
7538         // Rebalance a bit
7539         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7540
7541         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7542         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7543
7544         // We route 2 dust-HTLCs between A and B
7545         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7546         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7547
7548         // Build a dummy invalid transaction trying to spend a commitment tx
7549         let input = TxIn {
7550                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7551                 script_sig: Script::new(),
7552                 sequence: 0,
7553                 witness: Vec::new(),
7554         };
7555
7556         let outp = TxOut {
7557                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7558                 value: 10000,
7559         };
7560
7561         let dummy_tx = Transaction {
7562                 version: 2,
7563                 lock_time: 0,
7564                 input: vec![input],
7565                 output: vec![outp]
7566         };
7567
7568         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7569         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7570         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7571         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7572         // We broadcast a few more block to check everything is all right
7573         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
7574         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7575         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7576
7577         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7578         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7579 }
7580
7581 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7582         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7583         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7584         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7585         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7586         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7587         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7588
7589         let chanmon_cfgs = create_chanmon_cfgs(3);
7590         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7591         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7592         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7593         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7594
7595         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7596
7597         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7598         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7599
7600         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7601         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7602
7603         // We revoked bs_commitment_tx
7604         if revoked {
7605                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7606                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7607         }
7608
7609         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7610         let mut timeout_tx = Vec::new();
7611         if local {
7612                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7613                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7614                 check_closed_broadcast!(nodes[0], false);
7615                 check_added_monitors!(nodes[0], 1);
7616                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7617                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7618                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7619                 expect_payment_failed!(nodes[0], dust_hash, true);
7620                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7621                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7622                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7623                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7624                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7625                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7626                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7627                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7628         } else {
7629                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7630                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7631                 check_closed_broadcast!(nodes[0], false);
7632                 check_added_monitors!(nodes[0], 1);
7633                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7634                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7635                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7636                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7637                 if !revoked {
7638                         expect_payment_failed!(nodes[0], dust_hash, true);
7639                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7640                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7641                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7642                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7643                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7644                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7645                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7646                 } else {
7647                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7648                         // commitment tx
7649                         let events = nodes[0].node.get_and_clear_pending_events();
7650                         assert_eq!(events.len(), 2);
7651                         let first;
7652                         match events[0] {
7653                                 Event::PaymentFailed { payment_hash, .. } => {
7654                                         if payment_hash == dust_hash { first = true; }
7655                                         else { first = false; }
7656                                 },
7657                                 _ => panic!("Unexpected event"),
7658                         }
7659                         match events[1] {
7660                                 Event::PaymentFailed { payment_hash, .. } => {
7661                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7662                                         else { assert_eq!(payment_hash, dust_hash); }
7663                                 },
7664                                 _ => panic!("Unexpected event"),
7665                         }
7666                 }
7667         }
7668 }
7669
7670 #[test]
7671 fn test_sweep_outbound_htlc_failure_update() {
7672         do_test_sweep_outbound_htlc_failure_update(false, true);
7673         do_test_sweep_outbound_htlc_failure_update(false, false);
7674         do_test_sweep_outbound_htlc_failure_update(true, false);
7675 }
7676
7677 #[test]
7678 fn test_upfront_shutdown_script() {
7679         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7680         // enforce it at shutdown message
7681
7682         let mut config = UserConfig::default();
7683         config.channel_options.announced_channel = true;
7684         config.peer_channel_config_limits.force_announced_channel_preference = false;
7685         config.channel_options.commit_upfront_shutdown_pubkey = false;
7686         let user_cfgs = [None, Some(config), None];
7687         let chanmon_cfgs = create_chanmon_cfgs(3);
7688         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7689         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7690         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7691
7692         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7693         let flags = InitFeatures::known();
7694         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7695         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7696         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7697         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7698         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7699         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7700     assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7701         check_added_monitors!(nodes[2], 1);
7702
7703         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7704         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7705         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7706         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7707         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7708         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7709         let events = nodes[2].node.get_and_clear_pending_msg_events();
7710         assert_eq!(events.len(), 1);
7711         match events[0] {
7712                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7713                 _ => panic!("Unexpected event"),
7714         }
7715
7716         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7717         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7718         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7719         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7720         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7721         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7722         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7723         let events = nodes[1].node.get_and_clear_pending_msg_events();
7724         assert_eq!(events.len(), 1);
7725         match events[0] {
7726                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7727                 _ => panic!("Unexpected event"),
7728         }
7729
7730         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7731         // channel smoothly, opt-out is from channel initiator here
7732         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7733         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7734         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7735         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7736         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7737         let events = nodes[0].node.get_and_clear_pending_msg_events();
7738         assert_eq!(events.len(), 1);
7739         match events[0] {
7740                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7741                 _ => panic!("Unexpected event"),
7742         }
7743
7744         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7745         //// channel smoothly
7746         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7747         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7748         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7749         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7750         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7751         let events = nodes[0].node.get_and_clear_pending_msg_events();
7752         assert_eq!(events.len(), 2);
7753         match events[0] {
7754                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7755                 _ => panic!("Unexpected event"),
7756         }
7757         match events[1] {
7758                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7759                 _ => panic!("Unexpected event"),
7760         }
7761 }
7762
7763 #[test]
7764 fn test_user_configurable_csv_delay() {
7765         // We test our channel constructors yield errors when we pass them absurd csv delay
7766
7767         let mut low_our_to_self_config = UserConfig::default();
7768         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7769         let mut high_their_to_self_config = UserConfig::default();
7770         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7771         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7772         let chanmon_cfgs = create_chanmon_cfgs(2);
7773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7775         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7776
7777         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7778         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7779         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, &low_our_to_self_config) {
7780                 match error {
7781                         APIError::APIMisuseError { err } => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
7782                         _ => panic!("Unexpected event"),
7783                 }
7784         } else { assert!(false) }
7785
7786         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7787         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7788         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7789         open_channel.to_self_delay = 200;
7790         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::known(), &open_channel, 0, &low_our_to_self_config) {
7791                 match error {
7792                         ChannelError::Close(err) => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str()));  },
7793                         _ => panic!("Unexpected event"),
7794                 }
7795         } else { assert!(false); }
7796
7797         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7798         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7799         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7800         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7801         accept_channel.to_self_delay = 200;
7802         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7803         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7804                 match action {
7805                         &ErrorAction::SendErrorMessage { ref msg } => {
7806                                 assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(msg.data.as_str()));
7807                         },
7808                         _ => { assert!(false); }
7809                 }
7810         } else { assert!(false); }
7811
7812         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7813         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7814         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7815         open_channel.to_self_delay = 200;
7816         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::known(), &open_channel, 0, &high_their_to_self_config) {
7817                 match error {
7818                         ChannelError::Close(err) => { assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(err.as_str())); },
7819                         _ => panic!("Unexpected event"),
7820                 }
7821         } else { assert!(false); }
7822 }
7823
7824 #[test]
7825 fn test_data_loss_protect() {
7826         // We want to be sure that :
7827         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7828         // * we close channel in case of detecting other being fallen behind
7829         // * we are able to claim our own outputs thanks to to_remote being static
7830         let keys_manager;
7831         let logger;
7832         let fee_estimator;
7833         let tx_broadcaster;
7834         let chain_monitor;
7835         let monitor;
7836         let node_state_0;
7837         let chanmon_cfgs = create_chanmon_cfgs(2);
7838         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7840         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7841
7842         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7843
7844         // Cache node A state before any channel update
7845         let previous_node_state = nodes[0].node.encode();
7846         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7847         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7848
7849         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7850         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7851
7852         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7853         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7854
7855         // Restore node A from previous state
7856         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7857         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7858         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7859         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7860         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7861         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7862         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7863         node_state_0 = {
7864                 let mut channel_monitors = HashMap::new();
7865                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7866                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7867                         keys_manager: &keys_manager,
7868                         fee_estimator: &fee_estimator,
7869                         monitor: &monitor,
7870                         logger: &logger,
7871                         tx_broadcaster: &tx_broadcaster,
7872                         default_config: UserConfig::default(),
7873                         channel_monitors: &mut channel_monitors,
7874                 }).unwrap().1
7875         };
7876         nodes[0].node = &node_state_0;
7877         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7878         nodes[0].chan_monitor = &monitor;
7879         nodes[0].chain_monitor = &chain_monitor;
7880
7881         nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7882         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7883         nodes[0].block_notifier.register_listener(nodes[0].node);
7884
7885         check_added_monitors!(nodes[0], 1);
7886
7887         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7888         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7889
7890         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7891
7892         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7893         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7894         check_added_monitors!(nodes[0], 1);
7895
7896         {
7897                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7898                 assert_eq!(node_txn.len(), 0);
7899         }
7900
7901         let mut reestablish_1 = Vec::with_capacity(1);
7902         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7903                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7904                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7905                         reestablish_1.push(msg.clone());
7906                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7907                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7908                         match action {
7909                                 &ErrorAction::SendErrorMessage { ref msg } => {
7910                                         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");
7911                                 },
7912                                 _ => panic!("Unexpected event!"),
7913                         }
7914                 } else {
7915                         panic!("Unexpected event")
7916                 }
7917         }
7918
7919         // Check we close channel detecting A is fallen-behind
7920         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7921         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7922         check_added_monitors!(nodes[1], 1);
7923
7924
7925         // Check A is able to claim to_remote output
7926         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7927         assert_eq!(node_txn.len(), 1);
7928         check_spends!(node_txn[0], chan.3);
7929         assert_eq!(node_txn[0].output.len(), 2);
7930         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7931         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7932         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7933         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7934         assert_eq!(spend_txn.len(), 1);
7935         check_spends!(spend_txn[0], node_txn[0]);
7936 }
7937
7938 #[test]
7939 fn test_check_htlc_underpaying() {
7940         // Send payment through A -> B but A is maliciously
7941         // sending a probe payment (i.e less than expected value0
7942         // to B, B should refuse payment.
7943
7944         let chanmon_cfgs = create_chanmon_cfgs(2);
7945         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7947         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7948
7949         // Create some initial channels
7950         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7951
7952         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7953
7954         // Node 3 is expecting payment of 100_000 but receive 10_000,
7955         // fail htlc like we didn't know the preimage.
7956         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7957         nodes[1].node.process_pending_htlc_forwards();
7958
7959         let events = nodes[1].node.get_and_clear_pending_msg_events();
7960         assert_eq!(events.len(), 1);
7961         let (update_fail_htlc, commitment_signed) = match events[0] {
7962                 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 } } => {
7963                         assert!(update_add_htlcs.is_empty());
7964                         assert!(update_fulfill_htlcs.is_empty());
7965                         assert_eq!(update_fail_htlcs.len(), 1);
7966                         assert!(update_fail_malformed_htlcs.is_empty());
7967                         assert!(update_fee.is_none());
7968                         (update_fail_htlcs[0].clone(), commitment_signed)
7969                 },
7970                 _ => panic!("Unexpected event"),
7971         };
7972         check_added_monitors!(nodes[1], 1);
7973
7974         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7975         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7976
7977         // 10_000 msat as u64, followed by a height of 99 as u32
7978         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7979         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7980         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7981         nodes[1].node.get_and_clear_pending_events();
7982 }
7983
7984 #[test]
7985 fn test_announce_disable_channels() {
7986         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7987         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7988
7989         let chanmon_cfgs = create_chanmon_cfgs(2);
7990         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7991         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7992         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7993
7994         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7995         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7996         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7997
7998         // Disconnect peers
7999         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8000         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8001
8002         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
8003         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
8004         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
8005         assert_eq!(msg_events.len(), 3);
8006         for e in msg_events {
8007                 match e {
8008                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8009                                 let short_id = msg.contents.short_channel_id;
8010                                 // Check generated channel_update match list in PendingChannelUpdate
8011                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
8012                                         panic!("Generated ChannelUpdate for wrong chan!");
8013                                 }
8014                         },
8015                         _ => panic!("Unexpected event"),
8016                 }
8017         }
8018         // Reconnect peers
8019         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8020         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
8021         assert_eq!(reestablish_1.len(), 3);
8022         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8023         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
8024         assert_eq!(reestablish_2.len(), 3);
8025
8026         // Reestablish chan_1
8027         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
8028         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8029         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8030         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8031         // Reestablish chan_2
8032         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8033         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8034         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8035         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8036         // Reestablish chan_3
8037         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8038         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8039         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8040         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8041
8042         nodes[0].node.timer_chan_freshness_every_min();
8043         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8044 }
8045
8046 #[test]
8047 fn test_bump_penalty_txn_on_revoked_commitment() {
8048         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8049         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8050
8051         let chanmon_cfgs = create_chanmon_cfgs(2);
8052         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8053         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8054         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8055
8056         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8057         let logger = test_utils::TestLogger::new();
8058
8059
8060         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8061         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8062         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
8063         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8064
8065         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8066         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8067         assert_eq!(revoked_txn[0].output.len(), 4);
8068         assert_eq!(revoked_txn[0].input.len(), 1);
8069         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8070         let revoked_txid = revoked_txn[0].txid();
8071
8072         let mut penalty_sum = 0;
8073         for outp in revoked_txn[0].output.iter() {
8074                 if outp.script_pubkey.is_v0_p2wsh() {
8075                         penalty_sum += outp.value;
8076                 }
8077         }
8078
8079         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8080         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
8081
8082         // Actually revoke tx by claiming a HTLC
8083         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8084         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8085         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
8086         check_added_monitors!(nodes[1], 1);
8087
8088         // One or more justice tx should have been broadcast, check it
8089         let penalty_1;
8090         let feerate_1;
8091         {
8092                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8093                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
8094                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8095                 assert_eq!(node_txn[0].output.len(), 1);
8096                 check_spends!(node_txn[0], revoked_txn[0]);
8097                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8098                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8099                 penalty_1 = node_txn[0].txid();
8100                 node_txn.clear();
8101         };
8102
8103         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8104         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
8105         let mut penalty_2 = penalty_1;
8106         let mut feerate_2 = 0;
8107         {
8108                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8109                 assert_eq!(node_txn.len(), 1);
8110                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8111                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8112                         assert_eq!(node_txn[0].output.len(), 1);
8113                         check_spends!(node_txn[0], revoked_txn[0]);
8114                         penalty_2 = node_txn[0].txid();
8115                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8116                         assert_ne!(penalty_2, penalty_1);
8117                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8118                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8119                         // Verify 25% bump heuristic
8120                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8121                         node_txn.clear();
8122                 }
8123         }
8124         assert_ne!(feerate_2, 0);
8125
8126         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8127         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
8128         let penalty_3;
8129         let mut feerate_3 = 0;
8130         {
8131                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8132                 assert_eq!(node_txn.len(), 1);
8133                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8134                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8135                         assert_eq!(node_txn[0].output.len(), 1);
8136                         check_spends!(node_txn[0], revoked_txn[0]);
8137                         penalty_3 = node_txn[0].txid();
8138                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8139                         assert_ne!(penalty_3, penalty_2);
8140                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8141                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8142                         // Verify 25% bump heuristic
8143                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8144                         node_txn.clear();
8145                 }
8146         }
8147         assert_ne!(feerate_3, 0);
8148
8149         nodes[1].node.get_and_clear_pending_events();
8150         nodes[1].node.get_and_clear_pending_msg_events();
8151 }
8152
8153 #[test]
8154 fn test_bump_penalty_txn_on_revoked_htlcs() {
8155         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8156         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8157
8158         let chanmon_cfgs = create_chanmon_cfgs(2);
8159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8161         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8162
8163         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8164         // Lock HTLC in both directions
8165         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
8166         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8167
8168         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8169         assert_eq!(revoked_local_txn[0].input.len(), 1);
8170         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8171
8172         // Revoke local commitment tx
8173         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8174
8175         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8176         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8177         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8178         check_closed_broadcast!(nodes[1], false);
8179         check_added_monitors!(nodes[1], 1);
8180
8181         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8182         assert_eq!(revoked_htlc_txn.len(), 4);
8183         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8184                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8185                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8186                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8187                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8188                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8189         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8190                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8191                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8192                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8193                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8194                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8195         }
8196
8197         // Broadcast set of revoked txn on A
8198         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
8199         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8200
8201         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8202         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);
8203         let first;
8204         let feerate_1;
8205         let penalty_txn;
8206         {
8207                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8208                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8209                 // Verify claim tx are spending revoked HTLC txn
8210                 assert_eq!(node_txn[4].input.len(), 2);
8211                 assert_eq!(node_txn[4].output.len(), 1);
8212                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8213                 first = node_txn[4].txid();
8214                 // Store both feerates for later comparison
8215                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8216                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8217                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8218                 node_txn.clear();
8219         }
8220
8221         // Connect three more block to see if bumped penalty are issued for HTLC txn
8222         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8223         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8224         {
8225                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8226                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8227
8228                 check_spends!(node_txn[0], revoked_local_txn[0]);
8229                 check_spends!(node_txn[1], revoked_local_txn[0]);
8230
8231                 node_txn.clear();
8232         };
8233
8234         // Few more blocks to confirm penalty txn
8235         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
8236         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8237         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
8238         let node_txn = {
8239                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8240                 assert_eq!(node_txn.len(), 1);
8241
8242                 assert_eq!(node_txn[0].input.len(), 2);
8243                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8244                 // Verify bumped tx is different and 25% bump heuristic
8245                 assert_ne!(first, node_txn[0].txid());
8246                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8247                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8248                 assert!(feerate_2 * 100 > feerate_1 * 125);
8249                 let txn = vec![node_txn[0].clone()];
8250                 node_txn.clear();
8251                 txn
8252         };
8253         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8254         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8255         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
8256         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
8257         {
8258                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8259                 // We verify than no new transaction has been broadcast because previously
8260                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8261                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8262                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8263                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8264                 // up bumped justice generation.
8265                 assert_eq!(node_txn.len(), 0);
8266                 node_txn.clear();
8267         }
8268         check_closed_broadcast!(nodes[0], false);
8269         check_added_monitors!(nodes[0], 1);
8270 }
8271
8272 #[test]
8273 fn test_bump_penalty_txn_on_remote_commitment() {
8274         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8275         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8276
8277         // Create 2 HTLCs
8278         // Provide preimage for one
8279         // Check aggregation
8280
8281         let chanmon_cfgs = create_chanmon_cfgs(2);
8282         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8283         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8284         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8285
8286         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8287         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8288         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8289
8290         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8291         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8292         assert_eq!(remote_txn[0].output.len(), 4);
8293         assert_eq!(remote_txn[0].input.len(), 1);
8294         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8295
8296         // Claim a HTLC without revocation (provide B monitor with preimage)
8297         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
8298         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8299         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
8300         check_added_monitors!(nodes[1], 2);
8301
8302         // One or more claim tx should have been broadcast, check it
8303         let timeout;
8304         let preimage;
8305         let feerate_timeout;
8306         let feerate_preimage;
8307         {
8308                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8309                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8310                 assert_eq!(node_txn[0].input.len(), 1);
8311                 assert_eq!(node_txn[1].input.len(), 1);
8312                 check_spends!(node_txn[0], remote_txn[0]);
8313                 check_spends!(node_txn[1], remote_txn[0]);
8314                 check_spends!(node_txn[2], chan.3);
8315                 check_spends!(node_txn[3], node_txn[2]);
8316                 check_spends!(node_txn[4], node_txn[2]);
8317                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8318                         timeout = node_txn[0].txid();
8319                         let index = node_txn[0].input[0].previous_output.vout;
8320                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8321                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8322
8323                         preimage = node_txn[1].txid();
8324                         let index = node_txn[1].input[0].previous_output.vout;
8325                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8326                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8327                 } else {
8328                         timeout = node_txn[1].txid();
8329                         let index = node_txn[1].input[0].previous_output.vout;
8330                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8331                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8332
8333                         preimage = node_txn[0].txid();
8334                         let index = node_txn[0].input[0].previous_output.vout;
8335                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8336                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8337                 }
8338                 node_txn.clear();
8339         };
8340         assert_ne!(feerate_timeout, 0);
8341         assert_ne!(feerate_preimage, 0);
8342
8343         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8344         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
8345         {
8346                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8347                 assert_eq!(node_txn.len(), 2);
8348                 assert_eq!(node_txn[0].input.len(), 1);
8349                 assert_eq!(node_txn[1].input.len(), 1);
8350                 check_spends!(node_txn[0], remote_txn[0]);
8351                 check_spends!(node_txn[1], remote_txn[0]);
8352                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8353                         let index = node_txn[0].input[0].previous_output.vout;
8354                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8355                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8356                         assert!(new_feerate * 100 > feerate_timeout * 125);
8357                         assert_ne!(timeout, node_txn[0].txid());
8358
8359                         let index = node_txn[1].input[0].previous_output.vout;
8360                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8361                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8362                         assert!(new_feerate * 100 > feerate_preimage * 125);
8363                         assert_ne!(preimage, node_txn[1].txid());
8364                 } else {
8365                         let index = node_txn[1].input[0].previous_output.vout;
8366                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8367                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8368                         assert!(new_feerate * 100 > feerate_timeout * 125);
8369                         assert_ne!(timeout, node_txn[1].txid());
8370
8371                         let index = node_txn[0].input[0].previous_output.vout;
8372                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8373                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8374                         assert!(new_feerate * 100 > feerate_preimage * 125);
8375                         assert_ne!(preimage, node_txn[0].txid());
8376                 }
8377                 node_txn.clear();
8378         }
8379
8380         nodes[1].node.get_and_clear_pending_events();
8381         nodes[1].node.get_and_clear_pending_msg_events();
8382 }
8383
8384 #[test]
8385 fn test_set_outpoints_partial_claiming() {
8386         // - remote party claim tx, new bump tx
8387         // - disconnect remote claiming tx, new bump
8388         // - disconnect tx, see no tx anymore
8389         let chanmon_cfgs = create_chanmon_cfgs(2);
8390         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8391         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8392         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8393
8394         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8395         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8396         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8397
8398         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8399         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8400         assert_eq!(remote_txn.len(), 3);
8401         assert_eq!(remote_txn[0].output.len(), 4);
8402         assert_eq!(remote_txn[0].input.len(), 1);
8403         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8404         check_spends!(remote_txn[1], remote_txn[0]);
8405         check_spends!(remote_txn[2], remote_txn[0]);
8406
8407         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8408         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
8409         // Provide node A with both preimage
8410         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8411         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8412         check_added_monitors!(nodes[0], 2);
8413         nodes[0].node.get_and_clear_pending_events();
8414         nodes[0].node.get_and_clear_pending_msg_events();
8415
8416         // Connect blocks on node A commitment transaction
8417         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8418         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8419         check_closed_broadcast!(nodes[0], false);
8420         check_added_monitors!(nodes[0], 1);
8421         // Verify node A broadcast tx claiming both HTLCs
8422         {
8423                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8424                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8425                 assert_eq!(node_txn.len(), 4);
8426                 check_spends!(node_txn[0], remote_txn[0]);
8427                 check_spends!(node_txn[1], chan.3);
8428                 check_spends!(node_txn[2], node_txn[1]);
8429                 check_spends!(node_txn[3], node_txn[1]);
8430                 assert_eq!(node_txn[0].input.len(), 2);
8431                 node_txn.clear();
8432         }
8433
8434         // Connect blocks on node B
8435         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
8436         check_closed_broadcast!(nodes[1], false);
8437         check_added_monitors!(nodes[1], 1);
8438         // Verify node B broadcast 2 HTLC-timeout txn
8439         let partial_claim_tx = {
8440                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8441                 assert_eq!(node_txn.len(), 3);
8442                 check_spends!(node_txn[1], node_txn[0]);
8443                 check_spends!(node_txn[2], node_txn[0]);
8444                 assert_eq!(node_txn[1].input.len(), 1);
8445                 assert_eq!(node_txn[2].input.len(), 1);
8446                 node_txn[1].clone()
8447         };
8448
8449         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8450         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8451         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8452         {
8453                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8454                 assert_eq!(node_txn.len(), 1);
8455                 check_spends!(node_txn[0], remote_txn[0]);
8456                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8457                 node_txn.clear();
8458         }
8459         nodes[0].node.get_and_clear_pending_msg_events();
8460
8461         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8462         nodes[0].block_notifier.block_disconnected(&header, 102);
8463         {
8464                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8465                 assert_eq!(node_txn.len(), 1);
8466                 check_spends!(node_txn[0], remote_txn[0]);
8467                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8468                 node_txn.clear();
8469         }
8470
8471         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8472         nodes[0].block_notifier.block_disconnected(&header, 101);
8473         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
8474         {
8475                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8476                 assert_eq!(node_txn.len(), 0);
8477                 node_txn.clear();
8478         }
8479 }
8480
8481 #[test]
8482 fn test_counterparty_raa_skip_no_crash() {
8483         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8484         // commitment transaction, we would have happily carried on and provided them the next
8485         // commitment transaction based on one RAA forward. This would probably eventually have led to
8486         // channel closure, but it would not have resulted in funds loss. Still, our
8487         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8488         // check simply that the channel is closed in response to such an RAA, but don't check whether
8489         // we decide to punish our counterparty for revoking their funds (as we don't currently
8490         // implement that).
8491         let chanmon_cfgs = create_chanmon_cfgs(2);
8492         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8493         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8494         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8495         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8496
8497         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8498         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8499         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8500         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8501                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8502         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8503
8504         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8505                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8506         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8507         check_added_monitors!(nodes[1], 1);
8508 }
8509
8510 #[test]
8511 fn test_bump_txn_sanitize_tracking_maps() {
8512         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8513         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8514
8515         let chanmon_cfgs = create_chanmon_cfgs(2);
8516         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8517         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8518         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8519
8520         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8521         // Lock HTLC in both directions
8522         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8523         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8524
8525         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8526         assert_eq!(revoked_local_txn[0].input.len(), 1);
8527         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8528
8529         // Revoke local commitment tx
8530         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8531
8532         // Broadcast set of revoked txn on A
8533         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
8534         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8535
8536         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8537         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8538         check_closed_broadcast!(nodes[0], false);
8539         check_added_monitors!(nodes[0], 1);
8540         let penalty_txn = {
8541                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8542                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8543                 check_spends!(node_txn[0], revoked_local_txn[0]);
8544                 check_spends!(node_txn[1], revoked_local_txn[0]);
8545                 check_spends!(node_txn[2], revoked_local_txn[0]);
8546                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8547                 node_txn.clear();
8548                 penalty_txn
8549         };
8550         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8551         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8552         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8553         {
8554                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8555                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8556                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8557                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8558                 }
8559         }
8560 }
8561
8562 #[test]
8563 fn test_override_channel_config() {
8564         let chanmon_cfgs = create_chanmon_cfgs(2);
8565         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8566         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8567         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8568
8569         // Node0 initiates a channel to node1 using the override config.
8570         let mut override_config = UserConfig::default();
8571         override_config.own_channel_config.our_to_self_delay = 200;
8572
8573         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8574
8575         // Assert the channel created by node0 is using the override config.
8576         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8577         assert_eq!(res.channel_flags, 0);
8578         assert_eq!(res.to_self_delay, 200);
8579 }
8580
8581 #[test]
8582 fn test_override_0msat_htlc_minimum() {
8583         let mut zero_config = UserConfig::default();
8584         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8585         let chanmon_cfgs = create_chanmon_cfgs(2);
8586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8588         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8589
8590         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8591         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8592         assert_eq!(res.htlc_minimum_msat, 1);
8593
8594         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8595         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8596         assert_eq!(res.htlc_minimum_msat, 1);
8597 }
8598
8599 #[test]
8600 fn test_simple_payment_secret() {
8601         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8602         // features, however.
8603         let chanmon_cfgs = create_chanmon_cfgs(3);
8604         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8605         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8606         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8607
8608         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8609         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8610         let logger = test_utils::TestLogger::new();
8611
8612         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8613         let payment_secret = PaymentSecret([0xdb; 32]);
8614         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8615         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8616         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8617         // Claiming with all the correct values but the wrong secret should result in nothing...
8618         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8619         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8620         // ...but with the right secret we should be able to claim all the way back
8621         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8622 }
8623
8624 #[test]
8625 fn test_simple_mpp() {
8626         // Simple test of sending a multi-path payment.
8627         let chanmon_cfgs = create_chanmon_cfgs(4);
8628         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8629         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8630         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8631
8632         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8633         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8634         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8635         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8636         let logger = test_utils::TestLogger::new();
8637
8638         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8639         let payment_secret = PaymentSecret([0xdb; 32]);
8640         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8641         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8642         let path = route.paths[0].clone();
8643         route.paths.push(path);
8644         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8645         route.paths[0][0].short_channel_id = chan_1_id;
8646         route.paths[0][1].short_channel_id = chan_3_id;
8647         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8648         route.paths[1][0].short_channel_id = chan_2_id;
8649         route.paths[1][1].short_channel_id = chan_4_id;
8650         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8651         // Claiming with all the correct values but the wrong secret should result in nothing...
8652         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8653         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8654         // ...but with the right secret we should be able to claim all the way back
8655         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8656 }
8657
8658 #[test]
8659 fn test_update_err_monitor_lockdown() {
8660         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8661         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8662         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8663         //
8664         // This scenario may happen in a watchtower setup, where watchtower process a block height
8665         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8666         // commitment at same time.
8667
8668         let chanmon_cfgs = create_chanmon_cfgs(2);
8669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8672
8673         // Create some initial channel
8674         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8675         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8676
8677         // Rebalance the network to generate htlc in the two directions
8678         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8679
8680         // Route a HTLC from node 0 to node 1 (but don't settle)
8681         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8682
8683         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8684         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8685         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8686         let watchtower = {
8687                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8688                 let monitor = monitors.get(&outpoint).unwrap();
8689                 let mut w = test_utils::TestVecWriter(Vec::new());
8690                 monitor.write_for_disk(&mut w).unwrap();
8691                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8692                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8693                 assert!(new_monitor == *monitor);
8694                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8695                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8696                 watchtower
8697         };
8698         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8699         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8700
8701         // Try to update ChannelMonitor
8702         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8703         check_added_monitors!(nodes[1], 1);
8704         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8705         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8706         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8707         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8708                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8709                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8710                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8711                 } else { assert!(false); }
8712         } else { assert!(false); };
8713         // Our local monitor is in-sync and hasn't processed yet timeout
8714         check_added_monitors!(nodes[0], 1);
8715         let events = nodes[0].node.get_and_clear_pending_events();
8716         assert_eq!(events.len(), 1);
8717 }