_ 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;
  15 use chain::Listen;
  16 use chain::Watch;
  17 use chain::channelmonitor;
  18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  19 use chain::transaction::OutPoint;
  20 use chain::keysinterface::{KeysInterface, BaseSign};
  21 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  22 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  23 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  24 use ln::channel::{Channel, ChannelError};
  25 use ln::{chan_utils, onion_utils};
  26 use routing::router::{Route, RouteHop, get_route};
  27 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  28 use ln::msgs;
  29 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  30 use util::enforcing_trait_impls::EnforcingSigner;
  31 use util::{byte_utils, test_utils};
  32 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  33 use util::errors::APIError;
  34 use util::ser::{Writeable, ReadableArgs};
  35 use util::config::UserConfig;
  36
  37 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  38 use bitcoin::hash_types::{Txid, BlockHash};
  39 use bitcoin::blockdata::block::{Block, BlockHeader};
  40 use bitcoin::blockdata::script::Builder;
  41 use bitcoin::blockdata::opcodes;
  42 use bitcoin::blockdata::constants::genesis_block;
  43 use bitcoin::network::constants::Network;
  44
  45 use bitcoin::hashes::sha256::Hash as Sha256;
  46 use bitcoin::hashes::Hash;
  47
  48 use bitcoin::secp256k1::{Secp256k1, Message};
  49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  50
  51 use regex;
  52
  53 use prelude::*;
  54 use alloc::collections::BTreeSet;
  55 use std::collections::{HashMap, HashSet};
  56 use core::default::Default;
  57 use std::sync::Mutex;
  58
  59 use ln::functional_test_utils::*;
  60 use ln::chan_utils::CommitmentTransaction;
  61 use ln::msgs::OptionalField::Present;
  62
  63 #[test]
  64 fn test_insane_channel_opens() {
  65         // Stand up a network of 2 nodes
  66         let chanmon_cfgs = create_chanmon_cfgs(2);
  67         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  68         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  69         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  70
  71         // Instantiate channel parameters where we push the maximum msats given our
  72         // funding satoshis
  73         let channel_value_sat = 31337; // same as funding satoshis
  74         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  75         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  76
  77         // Have node0 initiate a channel to node1 with aforementioned parameters
  78         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  79
  80         // Extract the channel open message from node0 to node1
  81         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  82
  83         // Test helper that asserts we get the correct error string given a mutator
  84         // that supposedly makes the channel open message insane
  85         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  86                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  87                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  88                 assert_eq!(msg_events.len(), 1);
  89                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  90                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  91                         match action {
  92                                 &ErrorAction::SendErrorMessage { .. } => {
  93                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  94                                 },
  95                                 _ => panic!("unexpected event!"),
  96                         }
  97                 } else { assert!(false); }
  98         };
  99
 100         use ln::channel::MAX_FUNDING_SATOSHIS;
 101         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 102
 103         // Test all mutations that would make the channel open message insane
 104         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 });
 105
 106         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 107
 108         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 });
 109
 110         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 111
 112         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 });
 113
 114         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 });
 115
 116         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 });
 117
 118         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 119
 120         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 121 }
 122
 123 #[test]
 124 fn test_async_inbound_update_fee() {
 125         let chanmon_cfgs = create_chanmon_cfgs(2);
 126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 128         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 129         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 130         let logger = test_utils::TestLogger::new();
 131         let channel_id = chan.2;
 132
 133         // balancing
 134         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 135
 136         // A                                        B
 137         // update_fee                            ->
 138         // send (1) commitment_signed            -.
 139         //                                       <- update_add_htlc/commitment_signed
 140         // send (2) RAA (awaiting remote revoke) -.
 141         // (1) commitment_signed is delivered    ->
 142         //                                       .- send (3) RAA (awaiting remote revoke)
 143         // (2) RAA is delivered                  ->
 144         //                                       .- send (4) commitment_signed
 145         //                                       <- (3) RAA is delivered
 146         // send (5) commitment_signed            -.
 147         //                                       <- (4) commitment_signed is delivered
 148         // send (6) RAA                          -.
 149         // (5) commitment_signed is delivered    ->
 150         //                                       <- RAA
 151         // (6) RAA is delivered                  ->
 152
 153         // First nodes[0] generates an update_fee
 154         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 155         check_added_monitors!(nodes[0], 1);
 156
 157         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 158         assert_eq!(events_0.len(), 1);
 159         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 160                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 161                         (update_fee.as_ref(), commitment_signed)
 162                 },
 163                 _ => panic!("Unexpected event"),
 164         };
 165
 166         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 167
 168         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 169         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 170         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 171         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 172         check_added_monitors!(nodes[1], 1);
 173
 174         let payment_event = {
 175                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 176                 assert_eq!(events_1.len(), 1);
 177                 SendEvent::from_event(events_1.remove(0))
 178         };
 179         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 180         assert_eq!(payment_event.msgs.len(), 1);
 181
 182         // ...now when the messages get delivered everyone should be happy
 183         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 184         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 185         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 186         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 187         check_added_monitors!(nodes[0], 1);
 188
 189         // deliver(1), generate (3):
 190         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 191         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 192         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 193         check_added_monitors!(nodes[1], 1);
 194
 195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 196         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 197         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fee.is_none()); // (4)
 202         check_added_monitors!(nodes[1], 1);
 203
 204         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 205         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 206         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fee.is_none()); // (5)
 211         check_added_monitors!(nodes[0], 1);
 212
 213         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 214         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 215         // only (6) so get_event_msg's assert(len == 1) passes
 216         check_added_monitors!(nodes[0], 1);
 217
 218         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 219         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 220         check_added_monitors!(nodes[1], 1);
 221
 222         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 223         check_added_monitors!(nodes[0], 1);
 224
 225         let events_2 = nodes[0].node.get_and_clear_pending_events();
 226         assert_eq!(events_2.len(), 1);
 227         match events_2[0] {
 228                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 229                 _ => panic!("Unexpected event"),
 230         }
 231
 232         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 233         check_added_monitors!(nodes[1], 1);
 234 }
 235
 236 #[test]
 237 fn test_update_fee_unordered_raa() {
 238         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 239         // crash in an earlier version of the update_fee patch)
 240         let chanmon_cfgs = create_chanmon_cfgs(2);
 241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 243         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 244         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 245         let channel_id = chan.2;
 246         let logger = test_utils::TestLogger::new();
 247
 248         // balancing
 249         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 250
 251         // First nodes[0] generates an update_fee
 252         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 253         check_added_monitors!(nodes[0], 1);
 254
 255         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 256         assert_eq!(events_0.len(), 1);
 257         let update_msg = match events_0[0] { // (1)
 258                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 259                         update_fee.as_ref()
 260                 },
 261                 _ => panic!("Unexpected event"),
 262         };
 263
 264         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 265
 266         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 267         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 268         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 269         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 270         check_added_monitors!(nodes[1], 1);
 271
 272         let payment_event = {
 273                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 274                 assert_eq!(events_1.len(), 1);
 275                 SendEvent::from_event(events_1.remove(0))
 276         };
 277         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 278         assert_eq!(payment_event.msgs.len(), 1);
 279
 280         // ...now when the messages get delivered everyone should be happy
 281         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 282         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 283         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 284         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 285         check_added_monitors!(nodes[0], 1);
 286
 287         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 288         check_added_monitors!(nodes[1], 1);
 289
 290         // We can't continue, sadly, because our (1) now has a bogus signature
 291 }
 292
 293 #[test]
 294 fn test_multi_flight_update_fee() {
 295         let chanmon_cfgs = create_chanmon_cfgs(2);
 296         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 297         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 298         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 299         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 300         let channel_id = chan.2;
 301
 302         // A                                        B
 303         // update_fee/commitment_signed          ->
 304         //                                       .- send (1) RAA and (2) commitment_signed
 305         // update_fee (never committed)          ->
 306         // (3) update_fee                        ->
 307         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 308         // don't track which updates correspond to which revoke_and_ack responses so we're in
 309         // AwaitingRAA mode and will not generate the update_fee yet.
 310         //                                       <- (1) RAA delivered
 311         // (3) is generated and send (4) CS      -.
 312         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 313         // know the per_commitment_point to use for it.
 314         //                                       <- (2) commitment_signed delivered
 315         // revoke_and_ack                        ->
 316         //                                          B should send no response here
 317         // (4) commitment_signed delivered       ->
 318         //                                       <- RAA/commitment_signed delivered
 319         // revoke_and_ack                        ->
 320
 321         // First nodes[0] generates an update_fee
 322         let initial_feerate = get_feerate!(nodes[0], channel_id);
 323         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 324         check_added_monitors!(nodes[0], 1);
 325
 326         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 327         assert_eq!(events_0.len(), 1);
 328         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 329                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 330                         (update_fee.as_ref().unwrap(), commitment_signed)
 331                 },
 332                 _ => panic!("Unexpected event"),
 333         };
 334
 335         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 336         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 337         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 338         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 339         check_added_monitors!(nodes[1], 1);
 340
 341         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 342         // transaction:
 343         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 344         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 346
 347         // Create the (3) update_fee message that nodes[0] will generate before it does...
 348         let mut update_msg_2 = msgs::UpdateFee {
 349                 channel_id: update_msg_1.channel_id.clone(),
 350                 feerate_per_kw: (initial_feerate + 30) as u32,
 351         };
 352
 353         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 354
 355         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 356         // Deliver (3)
 357         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 358
 359         // Deliver (1), generating (3) and (4)
 360         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 361         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 362         check_added_monitors!(nodes[0], 1);
 363         assert!(as_second_update.update_add_htlcs.is_empty());
 364         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 365         assert!(as_second_update.update_fail_htlcs.is_empty());
 366         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 367         // Check that the update_fee newly generated matches what we delivered:
 368         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 369         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 370
 371         // Deliver (2) commitment_signed
 372         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 373         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 374         check_added_monitors!(nodes[0], 1);
 375         // No commitment_signed so get_event_msg's assert(len == 1) passes
 376
 377         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 378         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 379         check_added_monitors!(nodes[1], 1);
 380
 381         // Delever (4)
 382         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 383         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 384         check_added_monitors!(nodes[1], 1);
 385
 386         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 387         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 388         check_added_monitors!(nodes[0], 1);
 389
 390         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 391         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 392         // No commitment_signed so get_event_msg's assert(len == 1) passes
 393         check_added_monitors!(nodes[0], 1);
 394
 395         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 396         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 397         check_added_monitors!(nodes[1], 1);
 398 }
 399
 400 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 401         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 402         // tests that we properly send one in that case.
 403         let mut alice_config = UserConfig::default();
 404         alice_config.own_channel_config.minimum_depth = 1;
 405         alice_config.channel_options.announced_channel = true;
 406         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 407         let mut bob_config = UserConfig::default();
 408         bob_config.own_channel_config.minimum_depth = 1;
 409         bob_config.channel_options.announced_channel = true;
 410         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let chanmon_cfgs = create_chanmon_cfgs(2);
 412         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 413         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 414         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 415         *nodes[0].connect_style.borrow_mut() = connect_style;
 416
 417         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 418         mine_transaction(&nodes[1], &tx);
 419         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()));
 420
 421         mine_transaction(&nodes[0], &tx);
 422         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 423         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 424
 425         for node in nodes {
 426                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 427                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 428                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 429         }
 430 }
 431 #[test]
 432 fn test_1_conf_open() {
 433         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 434         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 435         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 436 }
 437
 438 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 439         // Previously, we had issues deserializing channels when we hadn't connected the first block
 440         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 441         // serialization round-trips and simply do steps towards opening a channel and then drop the
 442         // Node objects.
 443
 444         let chanmon_cfgs = create_chanmon_cfgs(2);
 445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 448
 449         if steps & 0b1000_0000 != 0{
 450                 let block = Block {
 451                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 452                         txdata: vec![],
 453                 };
 454                 connect_block(&nodes[0], &block);
 455                 connect_block(&nodes[1], &block);
 456         }
 457
 458         if steps & 0x0f == 0 { return; }
 459         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 460         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 461
 462         if steps & 0x0f == 1 { return; }
 463         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 464         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 465
 466         if steps & 0x0f == 2 { return; }
 467         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 468
 469         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 470
 471         if steps & 0x0f == 3 { return; }
 472         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 473         check_added_monitors!(nodes[0], 0);
 474         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 475
 476         if steps & 0x0f == 4 { return; }
 477         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 478         {
 479                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 485
 486         if steps & 0x0f == 5 { return; }
 487         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 488         {
 489                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494
 495         let events_4 = nodes[0].node.get_and_clear_pending_events();
 496         assert_eq!(events_4.len(), 0);
 497
 498         if steps & 0x0f == 6 { return; }
 499         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 500
 501         if steps & 0x0f == 7 { return; }
 502         confirm_transaction_at(&nodes[0], &tx, 2);
 503         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 504         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 505 }
 506
 507 #[test]
 508 fn test_sanity_on_in_flight_opens() {
 509         do_test_sanity_on_in_flight_opens(0);
 510         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(1);
 512         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(2);
 514         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(3);
 516         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(4);
 518         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(5);
 520         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(6);
 522         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(7);
 524         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(8);
 526         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 527 }
 528
 529 #[test]
 530 fn test_update_fee_vanilla() {
 531         let chanmon_cfgs = create_chanmon_cfgs(2);
 532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 535         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 536         let channel_id = chan.2;
 537
 538         let feerate = get_feerate!(nodes[0], channel_id);
 539         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 540         check_added_monitors!(nodes[0], 1);
 541
 542         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events_0.len(), 1);
 544         let (update_msg, commitment_signed) = match events_0[0] {
 545                         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 } } => {
 546                         (update_fee.as_ref(), commitment_signed)
 547                 },
 548                 _ => panic!("Unexpected event"),
 549         };
 550         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 551
 552         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 553         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 554         check_added_monitors!(nodes[1], 1);
 555
 556         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 561         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 562         // No commitment_signed so get_event_msg's assert(len == 1) passes
 563         check_added_monitors!(nodes[0], 1);
 564
 565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 567         check_added_monitors!(nodes[1], 1);
 568 }
 569
 570 #[test]
 571 fn test_update_fee_that_funder_cannot_afford() {
 572         let chanmon_cfgs = create_chanmon_cfgs(2);
 573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 576         let channel_value = 1888;
 577         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 578         let channel_id = chan.2;
 579
 580         let feerate = 260;
 581         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 582         check_added_monitors!(nodes[0], 1);
 583         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 584
 585         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 586
 587         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 588
 589         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 590         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 591         {
 592                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 593
 594                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 595                 let num_htlcs = commitment_tx.output.len() - 2;
 596                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 597                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 598                 actual_fee = channel_value - actual_fee;
 599                 assert_eq!(total_fee, actual_fee);
 600         }
 601
 602         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 603         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 604         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 605         check_added_monitors!(nodes[0], 1);
 606
 607         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 608
 609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 610
 611         //While producing the commitment_signed response after handling a received update_fee request the
 612         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 613         //Should produce and error.
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 615         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 616         check_added_monitors!(nodes[1], 1);
 617         check_closed_broadcast!(nodes[1], true);
 618 }
 619
 620 #[test]
 621 fn test_update_fee_with_fundee_update_add_htlc() {
 622         let chanmon_cfgs = create_chanmon_cfgs(2);
 623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 627         let channel_id = chan.2;
 628         let logger = test_utils::TestLogger::new();
 629
 630         // balancing
 631         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 632
 633         let feerate = get_feerate!(nodes[0], channel_id);
 634         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 635         check_added_monitors!(nodes[0], 1);
 636
 637         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 638         assert_eq!(events_0.len(), 1);
 639         let (update_msg, commitment_signed) = match events_0[0] {
 640                         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 } } => {
 641                         (update_fee.as_ref(), commitment_signed)
 642                 },
 643                 _ => panic!("Unexpected event"),
 644         };
 645         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 647         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         check_added_monitors!(nodes[1], 1);
 649
 650         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 651         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 652         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 653
 654         // nothing happens since node[1] is in AwaitingRemoteRevoke
 655         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 656         {
 657                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 658                 assert_eq!(added_monitors.len(), 0);
 659                 added_monitors.clear();
 660         }
 661         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         // node[1] has nothing to do
 664
 665         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         check_added_monitors!(nodes[0], 1);
 668
 669         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 670         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 671         // No commitment_signed so get_event_msg's assert(len == 1) passes
 672         check_added_monitors!(nodes[0], 1);
 673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 674         check_added_monitors!(nodes[1], 1);
 675         // AwaitingRemoteRevoke ends here
 676
 677         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 678         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 679         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 682         assert_eq!(commitment_update.update_fee.is_none(), true);
 683
 684         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 685         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 686         check_added_monitors!(nodes[0], 1);
 687         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 688
 689         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 690         check_added_monitors!(nodes[1], 1);
 691         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 692
 693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 694         check_added_monitors!(nodes[1], 1);
 695         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697
 698         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 699         check_added_monitors!(nodes[0], 1);
 700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 701
 702         expect_pending_htlcs_forwardable!(nodes[0]);
 703
 704         let events = nodes[0].node.get_and_clear_pending_events();
 705         assert_eq!(events.len(), 1);
 706         match events[0] {
 707                 Event::PaymentReceived { .. } => { },
 708                 _ => panic!("Unexpected event"),
 709         };
 710
 711         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 715         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 716 }
 717
 718 #[test]
 719 fn test_update_fee() {
 720         let chanmon_cfgs = create_chanmon_cfgs(2);
 721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 724         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 725         let channel_id = chan.2;
 726
 727         // A                                        B
 728         // (1) update_fee/commitment_signed      ->
 729         //                                       <- (2) revoke_and_ack
 730         //                                       .- send (3) commitment_signed
 731         // (4) update_fee/commitment_signed      ->
 732         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 733         //                                       <- (3) commitment_signed delivered
 734         // send (6) revoke_and_ack               -.
 735         //                                       <- (5) deliver revoke_and_ack
 736         // (6) deliver revoke_and_ack            ->
 737         //                                       .- send (7) commitment_signed in response to (4)
 738         //                                       <- (7) deliver commitment_signed
 739         // revoke_and_ack                        ->
 740
 741         // Create and deliver (1)...
 742         let feerate = get_feerate!(nodes[0], channel_id);
 743         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 744         check_added_monitors!(nodes[0], 1);
 745
 746         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events_0.len(), 1);
 748         let (update_msg, commitment_signed) = match events_0[0] {
 749                         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 } } => {
 750                         (update_fee.as_ref(), commitment_signed)
 751                 },
 752                 _ => panic!("Unexpected event"),
 753         };
 754         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 755
 756         // Generate (2) and (3):
 757         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 758         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 759         check_added_monitors!(nodes[1], 1);
 760
 761         // Deliver (2):
 762         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 763         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 764         check_added_monitors!(nodes[0], 1);
 765
 766         // Create and deliver (4)...
 767         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 768         check_added_monitors!(nodes[0], 1);
 769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 770         assert_eq!(events_0.len(), 1);
 771         let (update_msg, commitment_signed) = match events_0[0] {
 772                         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 } } => {
 773                         (update_fee.as_ref(), commitment_signed)
 774                 },
 775                 _ => panic!("Unexpected event"),
 776         };
 777
 778         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 779         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 780         check_added_monitors!(nodes[1], 1);
 781         // ... creating (5)
 782         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Handle (3), creating (6):
 786         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 787         check_added_monitors!(nodes[0], 1);
 788         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Deliver (5):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Deliver (6), creating (7):
 797         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 798         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 799         assert!(commitment_update.update_add_htlcs.is_empty());
 800         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_htlcs.is_empty());
 802         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 803         assert!(commitment_update.update_fee.is_none());
 804         check_added_monitors!(nodes[1], 1);
 805
 806         // Deliver (7)
 807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 808         check_added_monitors!(nodes[0], 1);
 809         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 810         // No commitment_signed so get_event_msg's assert(len == 1) passes
 811
 812         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 813         check_added_monitors!(nodes[1], 1);
 814         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 815
 816         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 817         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 818         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 819 }
 820
 821 #[test]
 822 fn pre_funding_lock_shutdown_test() {
 823         // Test sending a shutdown prior to funding_locked after funding generation
 824         let chanmon_cfgs = create_chanmon_cfgs(2);
 825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 828         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 829         mine_transaction(&nodes[0], &tx);
 830         mine_transaction(&nodes[1], &tx);
 831
 832         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 833         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 834         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 835         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 836         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 837
 838         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 840         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 842         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 843         assert!(node_0_none.is_none());
 844
 845         assert!(nodes[0].node.list_channels().is_empty());
 846         assert!(nodes[1].node.list_channels().is_empty());
 847 }
 848
 849 #[test]
 850 fn updates_shutdown_wait() {
 851         // Test sending a shutdown with outstanding updates pending
 852         let chanmon_cfgs = create_chanmon_cfgs(3);
 853         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 854         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 855         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 856         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 857         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 858         let logger = test_utils::TestLogger::new();
 859
 860         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 861
 862         nodes[0].node.close_channel(&chan_1.2).unwrap();
 863         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 864         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 865         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 866         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 867
 868         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 869         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 870
 871         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 872
 873         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 874         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 875         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 876         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 877         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 878         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 879
 880         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 881         check_added_monitors!(nodes[2], 1);
 882         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 883         assert!(updates.update_add_htlcs.is_empty());
 884         assert!(updates.update_fail_htlcs.is_empty());
 885         assert!(updates.update_fail_malformed_htlcs.is_empty());
 886         assert!(updates.update_fee.is_none());
 887         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 888         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 889         check_added_monitors!(nodes[1], 1);
 890         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 891         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 892
 893         assert!(updates_2.update_add_htlcs.is_empty());
 894         assert!(updates_2.update_fail_htlcs.is_empty());
 895         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 896         assert!(updates_2.update_fee.is_none());
 897         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 898         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 899         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 900
 901         let events = nodes[0].node.get_and_clear_pending_events();
 902         assert_eq!(events.len(), 1);
 903         match events[0] {
 904                 Event::PaymentSent { ref payment_preimage } => {
 905                         assert_eq!(our_payment_preimage, *payment_preimage);
 906                 },
 907                 _ => panic!("Unexpected event"),
 908         }
 909
 910         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 911         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 912         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 913         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 914         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 915         assert!(node_0_none.is_none());
 916
 917         assert!(nodes[0].node.list_channels().is_empty());
 918
 919         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 920         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 921         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 922         assert!(nodes[1].node.list_channels().is_empty());
 923         assert!(nodes[2].node.list_channels().is_empty());
 924 }
 925
 926 #[test]
 927 fn htlc_fail_async_shutdown() {
 928         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 929         let chanmon_cfgs = create_chanmon_cfgs(3);
 930         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 931         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 932         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 933         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 934         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 935         let logger = test_utils::TestLogger::new();
 936
 937         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 938         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 939         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 940         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 941         check_added_monitors!(nodes[0], 1);
 942         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 943         assert_eq!(updates.update_add_htlcs.len(), 1);
 944         assert!(updates.update_fulfill_htlcs.is_empty());
 945         assert!(updates.update_fail_htlcs.is_empty());
 946         assert!(updates.update_fail_malformed_htlcs.is_empty());
 947         assert!(updates.update_fee.is_none());
 948
 949         nodes[1].node.close_channel(&chan_1.2).unwrap();
 950         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 951         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 952         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 953
 954         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 955         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 956         check_added_monitors!(nodes[1], 1);
 957         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 958         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 959
 960         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 961         assert!(updates_2.update_add_htlcs.is_empty());
 962         assert!(updates_2.update_fulfill_htlcs.is_empty());
 963         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 964         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 965         assert!(updates_2.update_fee.is_none());
 966
 967         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 968         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 969
 970         expect_payment_failed!(nodes[0], our_payment_hash, false);
 971
 972         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 973         assert_eq!(msg_events.len(), 2);
 974         let node_0_closing_signed = match msg_events[0] {
 975                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 976                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 977                         (*msg).clone()
 978                 },
 979                 _ => panic!("Unexpected event"),
 980         };
 981         match msg_events[1] {
 982                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 983                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 984                 },
 985                 _ => panic!("Unexpected event"),
 986         }
 987
 988         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 989         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 990         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 991         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 992         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 993         assert!(node_0_none.is_none());
 994
 995         assert!(nodes[0].node.list_channels().is_empty());
 996
 997         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 998         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 999         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1000         assert!(nodes[1].node.list_channels().is_empty());
1001         assert!(nodes[2].node.list_channels().is_empty());
1002 }
1003
1004 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1005         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1006         // messages delivered prior to disconnect
1007         let chanmon_cfgs = create_chanmon_cfgs(3);
1008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1011         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1012         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1013
1014         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1015
1016         nodes[1].node.close_channel(&chan_1.2).unwrap();
1017         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1018         if recv_count > 0 {
1019                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1020                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1021                 if recv_count > 1 {
1022                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023                 }
1024         }
1025
1026         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1027         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1028
1029         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1031         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1032         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1033
1034         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1035         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1036         assert!(node_1_shutdown == node_1_2nd_shutdown);
1037
1038         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1039         let node_0_2nd_shutdown = if recv_count > 0 {
1040                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1041                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1042                 node_0_2nd_shutdown
1043         } else {
1044                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1045                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1046                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1047         };
1048         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1049
1050         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1051         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1052
1053         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1054         check_added_monitors!(nodes[2], 1);
1055         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1056         assert!(updates.update_add_htlcs.is_empty());
1057         assert!(updates.update_fail_htlcs.is_empty());
1058         assert!(updates.update_fail_malformed_htlcs.is_empty());
1059         assert!(updates.update_fee.is_none());
1060         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1061         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1062         check_added_monitors!(nodes[1], 1);
1063         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1064         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1065
1066         assert!(updates_2.update_add_htlcs.is_empty());
1067         assert!(updates_2.update_fail_htlcs.is_empty());
1068         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1069         assert!(updates_2.update_fee.is_none());
1070         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1071         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1072         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1073
1074         let events = nodes[0].node.get_and_clear_pending_events();
1075         assert_eq!(events.len(), 1);
1076         match events[0] {
1077                 Event::PaymentSent { ref payment_preimage } => {
1078                         assert_eq!(our_payment_preimage, *payment_preimage);
1079                 },
1080                 _ => panic!("Unexpected event"),
1081         }
1082
1083         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1084         if recv_count > 0 {
1085                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1086                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1087                 assert!(node_1_closing_signed.is_some());
1088         }
1089
1090         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1091         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1092
1093         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1094         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1095         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1096         if recv_count == 0 {
1097                 // If all closing_signeds weren't delivered we can just resume where we left off...
1098                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1099
1100                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1101                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1102                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1103
1104                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1105                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1106                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1107
1108                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1109                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1110
1111                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1112                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1113                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1114
1115                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1116                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1117                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1118                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1119                 assert!(node_0_none.is_none());
1120         } else {
1121                 // If one node, however, received + responded with an identical closing_signed we end
1122                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1123                 // There isn't really anything better we can do simply, but in the future we might
1124                 // explore storing a set of recently-closed channels that got disconnected during
1125                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1126                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1127                 // transaction.
1128                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1129
1130                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1131                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1132                 assert_eq!(msg_events.len(), 1);
1133                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1134                         match action {
1135                                 &ErrorAction::SendErrorMessage { ref msg } => {
1136                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1137                                         assert_eq!(msg.channel_id, chan_1.2);
1138                                 },
1139                                 _ => panic!("Unexpected event!"),
1140                         }
1141                 } else { panic!("Needed SendErrorMessage close"); }
1142
1143                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1144                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1145                 // closing_signed so we do it ourselves
1146                 check_closed_broadcast!(nodes[0], false);
1147                 check_added_monitors!(nodes[0], 1);
1148         }
1149
1150         assert!(nodes[0].node.list_channels().is_empty());
1151
1152         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1153         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1154         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1155         assert!(nodes[1].node.list_channels().is_empty());
1156         assert!(nodes[2].node.list_channels().is_empty());
1157 }
1158
1159 #[test]
1160 fn test_shutdown_rebroadcast() {
1161         do_test_shutdown_rebroadcast(0);
1162         do_test_shutdown_rebroadcast(1);
1163         do_test_shutdown_rebroadcast(2);
1164 }
1165
1166 #[test]
1167 fn fake_network_test() {
1168         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1169         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1170         let chanmon_cfgs = create_chanmon_cfgs(4);
1171         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1172         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1173         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1174
1175         // Create some initial channels
1176         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1177         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1178         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1179
1180         // Rebalance the network a bit by relaying one payment through all the channels...
1181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1183         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1185
1186         // Send some more payments
1187         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1188         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1190
1191         // Test failure packets
1192         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1193         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1194
1195         // Add a new channel that skips 3
1196         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1197
1198         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1199         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1203         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1204         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1205
1206         // Do some rebalance loop payments, simultaneously
1207         let mut hops = Vec::with_capacity(3);
1208         hops.push(RouteHop {
1209                 pubkey: nodes[2].node.get_our_node_id(),
1210                 node_features: NodeFeatures::empty(),
1211                 short_channel_id: chan_2.0.contents.short_channel_id,
1212                 channel_features: ChannelFeatures::empty(),
1213                 fee_msat: 0,
1214                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1215         });
1216         hops.push(RouteHop {
1217                 pubkey: nodes[3].node.get_our_node_id(),
1218                 node_features: NodeFeatures::empty(),
1219                 short_channel_id: chan_3.0.contents.short_channel_id,
1220                 channel_features: ChannelFeatures::empty(),
1221                 fee_msat: 0,
1222                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1223         });
1224         hops.push(RouteHop {
1225                 pubkey: nodes[1].node.get_our_node_id(),
1226                 node_features: NodeFeatures::known(),
1227                 short_channel_id: chan_4.0.contents.short_channel_id,
1228                 channel_features: ChannelFeatures::known(),
1229                 fee_msat: 1000000,
1230                 cltv_expiry_delta: TEST_FINAL_CLTV,
1231         });
1232         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;
1233         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;
1234         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1235
1236         let mut hops = Vec::with_capacity(3);
1237         hops.push(RouteHop {
1238                 pubkey: nodes[3].node.get_our_node_id(),
1239                 node_features: NodeFeatures::empty(),
1240                 short_channel_id: chan_4.0.contents.short_channel_id,
1241                 channel_features: ChannelFeatures::empty(),
1242                 fee_msat: 0,
1243                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1244         });
1245         hops.push(RouteHop {
1246                 pubkey: nodes[2].node.get_our_node_id(),
1247                 node_features: NodeFeatures::empty(),
1248                 short_channel_id: chan_3.0.contents.short_channel_id,
1249                 channel_features: ChannelFeatures::empty(),
1250                 fee_msat: 0,
1251                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1252         });
1253         hops.push(RouteHop {
1254                 pubkey: nodes[1].node.get_our_node_id(),
1255                 node_features: NodeFeatures::known(),
1256                 short_channel_id: chan_2.0.contents.short_channel_id,
1257                 channel_features: ChannelFeatures::known(),
1258                 fee_msat: 1000000,
1259                 cltv_expiry_delta: TEST_FINAL_CLTV,
1260         });
1261         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;
1262         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;
1263         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1264
1265         // Claim the rebalances...
1266         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1267         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1268
1269         // Add a duplicate new channel from 2 to 4
1270         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1271
1272         // Send some payments across both channels
1273         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276
1277
1278         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1279         let events = nodes[0].node.get_and_clear_pending_msg_events();
1280         assert_eq!(events.len(), 0);
1281         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);
1282
1283         //TODO: Test that routes work again here as we've been notified that the channel is full
1284
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1288
1289         // Close down the channels...
1290         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1291         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1292         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1293         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1294         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1295 }
1296
1297 #[test]
1298 fn holding_cell_htlc_counting() {
1299         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1300         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1301         // commitment dance rounds.
1302         let chanmon_cfgs = create_chanmon_cfgs(3);
1303         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1304         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1305         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1306         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1307         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1308         let logger = test_utils::TestLogger::new();
1309
1310         let mut payments = Vec::new();
1311         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1312                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1313                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1314                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1315                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1316                 payments.push((payment_preimage, payment_hash));
1317         }
1318         check_added_monitors!(nodes[1], 1);
1319
1320         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1321         assert_eq!(events.len(), 1);
1322         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1323         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1324
1325         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1326         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1327         // another HTLC.
1328         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1329         {
1330                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1331                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1332                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1333                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1334                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1335                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1336         }
1337
1338         // This should also be true if we try to forward a payment.
1339         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1340         {
1341                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1342                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1343                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1344                 check_added_monitors!(nodes[0], 1);
1345         }
1346
1347         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1348         assert_eq!(events.len(), 1);
1349         let payment_event = SendEvent::from_event(events.pop().unwrap());
1350         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1351
1352         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1353         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1354         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1355         // fails), the second will process the resulting failure and fail the HTLC backward.
1356         expect_pending_htlcs_forwardable!(nodes[1]);
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         check_added_monitors!(nodes[1], 1);
1359
1360         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1361         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1362         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1363
1364         let events = nodes[0].node.get_and_clear_pending_msg_events();
1365         assert_eq!(events.len(), 1);
1366         match events[0] {
1367                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1368                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1369                 },
1370                 _ => panic!("Unexpected event"),
1371         }
1372
1373         expect_payment_failed!(nodes[0], payment_hash_2, false);
1374
1375         // Now forward all the pending HTLCs and claim them back
1376         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1377         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1378         check_added_monitors!(nodes[2], 1);
1379
1380         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1381         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1384
1385         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1386         check_added_monitors!(nodes[1], 1);
1387         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1388
1389         for ref update in as_updates.update_add_htlcs.iter() {
1390                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1391         }
1392         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1393         check_added_monitors!(nodes[2], 1);
1394         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1395         check_added_monitors!(nodes[2], 1);
1396         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1397
1398         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1399         check_added_monitors!(nodes[1], 1);
1400         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1401         check_added_monitors!(nodes[1], 1);
1402         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1403
1404         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1405         check_added_monitors!(nodes[2], 1);
1406
1407         expect_pending_htlcs_forwardable!(nodes[2]);
1408
1409         let events = nodes[2].node.get_and_clear_pending_events();
1410         assert_eq!(events.len(), payments.len());
1411         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1412                 match event {
1413                         &Event::PaymentReceived { ref payment_hash, .. } => {
1414                                 assert_eq!(*payment_hash, *hash);
1415                         },
1416                         _ => panic!("Unexpected event"),
1417                 };
1418         }
1419
1420         for (preimage, _) in payments.drain(..) {
1421                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1422         }
1423
1424         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1425 }
1426
1427 #[test]
1428 fn duplicate_htlc_test() {
1429         // Test that we accept duplicate payment_hash HTLCs across the network and that
1430         // claiming/failing them are all separate and don't affect each other
1431         let chanmon_cfgs = create_chanmon_cfgs(6);
1432         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1433         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1434         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1435
1436         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1437         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1440         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1441         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1442
1443         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1444
1445         *nodes[0].network_payment_count.borrow_mut() -= 1;
1446         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1447
1448         *nodes[0].network_payment_count.borrow_mut() -= 1;
1449         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1450
1451         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1452         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1453         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1454 }
1455
1456 #[test]
1457 fn test_duplicate_htlc_different_direction_onchain() {
1458         // Test that ChannelMonitor doesn't generate 2 preimage txn
1459         // when we have 2 HTLCs with same preimage that go across a node
1460         // in opposite directions, even with the same payment secret.
1461         let chanmon_cfgs = create_chanmon_cfgs(2);
1462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1465
1466         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1467         let logger = test_utils::TestLogger::new();
1468
1469         // balancing
1470         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1471
1472         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1473
1474         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1475         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1476         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1477         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1478
1479         // Provide preimage to node 0 by claiming payment
1480         nodes[0].node.claim_funds(payment_preimage);
1481         check_added_monitors!(nodes[0], 1);
1482
1483         // Broadcast node 1 commitment txn
1484         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1485
1486         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1487         let mut has_both_htlcs = 0; // check htlcs match ones committed
1488         for outp in remote_txn[0].output.iter() {
1489                 if outp.value == 800_000 / 1000 {
1490                         has_both_htlcs += 1;
1491                 } else if outp.value == 900_000 / 1000 {
1492                         has_both_htlcs += 1;
1493                 }
1494         }
1495         assert_eq!(has_both_htlcs, 2);
1496
1497         mine_transaction(&nodes[0], &remote_txn[0]);
1498         check_added_monitors!(nodes[0], 1);
1499
1500         // Check we only broadcast 1 timeout tx
1501         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1502         assert_eq!(claim_txn.len(), 5);
1503         check_spends!(claim_txn[2], chan_1.3);
1504         check_spends!(claim_txn[3], claim_txn[2]);
1505         assert_eq!(claim_txn[1].input.len(), 1);
1506         assert_eq!(claim_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1507         check_spends!(claim_txn[1], remote_txn[0]);
1508         assert_eq!(remote_txn[0].output[claim_txn[1].input[0].previous_output.vout as usize].value, 800);
1509         assert_eq!(claim_txn[0].input.len(), 1);
1510         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1511         check_spends!(claim_txn[0], remote_txn[0]);
1512         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 900);
1513
1514         let events = nodes[0].node.get_and_clear_pending_msg_events();
1515         assert_eq!(events.len(), 3);
1516         for e in events {
1517                 match e {
1518                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1519                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1520                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1521                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1522                         },
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, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
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(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).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 our balance under counterparty-announced 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 our balance under counterparty-announced channel reserve value".to_string(), 1);
1566
1567         send_payment(&nodes[0], &vec![&nodes[1]], 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
1578         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1579         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1580         let secp_ctx = Secp256k1::new();
1581         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1582
1583         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1584
1585         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1586         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1587         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1588         let msg = msgs::UpdateAddHTLC {
1589                 channel_id: chan.2,
1590                 htlc_id: 0,
1591                 amount_msat: htlc_msat,
1592                 payment_hash: payment_hash,
1593                 cltv_expiry: htlc_cltv,
1594                 onion_routing_packet: onion_packet,
1595         };
1596
1597         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1598
1599         // Now manually create the commitment_signed message corresponding to the update_add
1600         // nodes[0] just sent. In the code for construction of this message, "local" refers
1601         // to the sender of the message, and "remote" refers to the receiver.
1602
1603         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1604
1605         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1606
1607         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1608         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1609         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1610                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1611                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1612                 let chan_signer = local_chan.get_signer();
1613                 let pubkeys = chan_signer.pubkeys();
1614                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1615                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1616                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1617         };
1618         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1619                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1620                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1621                 let chan_signer = remote_chan.get_signer();
1622                 let pubkeys = chan_signer.pubkeys();
1623                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1624                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1625         };
1626
1627         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1628         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1629                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1630
1631         // Build the remote commitment transaction so we can sign it, and then later use the
1632         // signature for the commitment_signed message.
1633         let local_chan_balance = 1313;
1634
1635         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1636                 offered: false,
1637                 amount_msat: 3460001,
1638                 cltv_expiry: htlc_cltv,
1639                 payment_hash,
1640                 transaction_output_index: Some(1),
1641         };
1642
1643         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1644
1645         let res = {
1646                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1647                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1648                 let local_chan_signer = local_chan.get_signer();
1649                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1650                         commitment_number,
1651                         95000,
1652                         local_chan_balance,
1653                         commit_tx_keys.clone(),
1654                         feerate_per_kw,
1655                         &mut vec![(accepted_htlc_info, ())],
1656                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1657                 );
1658                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1659         };
1660
1661         let commit_signed_msg = msgs::CommitmentSigned {
1662                 channel_id: chan.2,
1663                 signature: res.0,
1664                 htlc_signatures: res.1
1665         };
1666
1667         // Send the commitment_signed message to the nodes[1].
1668         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1669         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1670
1671         // Send the RAA to nodes[1].
1672         let raa_msg = msgs::RevokeAndACK {
1673                 channel_id: chan.2,
1674                 per_commitment_secret: local_secret,
1675                 next_per_commitment_point: next_local_point
1676         };
1677         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1678
1679         let events = nodes[1].node.get_and_clear_pending_msg_events();
1680         assert_eq!(events.len(), 1);
1681         // Make sure the HTLC failed in the way we expect.
1682         match events[0] {
1683                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1684                         assert_eq!(update_fail_htlcs.len(), 1);
1685                         update_fail_htlcs[0].clone()
1686                 },
1687                 _ => panic!("Unexpected event"),
1688         };
1689         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1690
1691         check_added_monitors!(nodes[1], 2);
1692 }
1693
1694 #[test]
1695 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1696         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1697         // Set the fee rate for the channel very high, to the point where the fundee
1698         // sending any above-dust amount would result in a channel reserve violation.
1699         // In this test we check that we would be prevented from sending an HTLC in
1700         // this situation.
1701         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1702         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1703         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1704         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1705         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1706         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1707
1708         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1709         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1710                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1711         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1712         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1713 }
1714
1715 #[test]
1716 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1717         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1718         // Set the fee rate for the channel very high, to the point where the funder
1719         // receiving 1 update_add_htlc would result in them closing the channel due
1720         // to channel reserve violation. This close could also happen if the fee went
1721         // up a more realistic amount, but many HTLCs were outstanding at the time of
1722         // the update_add_htlc.
1723         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1724         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1727         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1728         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1729
1730         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1731         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1732         let secp_ctx = Secp256k1::new();
1733         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1734         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1735         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1736         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1737         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1738         let msg = msgs::UpdateAddHTLC {
1739                 channel_id: chan.2,
1740                 htlc_id: 1,
1741                 amount_msat: htlc_msat + 1,
1742                 payment_hash: payment_hash,
1743                 cltv_expiry: htlc_cltv,
1744                 onion_routing_packet: onion_packet,
1745         };
1746
1747         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1748         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1749         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1750         assert_eq!(nodes[0].node.list_channels().len(), 0);
1751         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1752         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1753         check_added_monitors!(nodes[0], 1);
1754 }
1755
1756 #[test]
1757 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1758         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1759         // calculating our commitment transaction fee (this was previously broken).
1760         let chanmon_cfgs = create_chanmon_cfgs(2);
1761         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1762         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1763         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1764
1765         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1766         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1767         // transaction fee with 0 HTLCs (183 sats)).
1768         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1769
1770         let dust_amt = 329000; // Dust amount
1771         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1772         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1773         // commitment transaction fee.
1774         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1775 }
1776
1777 #[test]
1778 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1779         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1780         // calculating our counterparty's commitment transaction fee (this was previously broken).
1781         let chanmon_cfgs = create_chanmon_cfgs(2);
1782         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1783         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1784         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1785         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1786
1787         let payment_amt = 46000; // Dust amount
1788         // In the previous code, these first four payments would succeed.
1789         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1790         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793
1794         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1795         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1797         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1798         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1799         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1800
1801         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1802         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1803         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1804         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1805 }
1806
1807 #[test]
1808 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1809         let chanmon_cfgs = create_chanmon_cfgs(3);
1810         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1811         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1812         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1813         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1814         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1815
1816         let feemsat = 239;
1817         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1818         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1819         let feerate = get_feerate!(nodes[0], chan.2);
1820
1821         // Add a 2* and +1 for the fee spike reserve.
1822         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1823         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;
1824         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1825
1826         // Add a pending HTLC.
1827         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1828         let payment_event_1 = {
1829                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1830                 check_added_monitors!(nodes[0], 1);
1831
1832                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1833                 assert_eq!(events.len(), 1);
1834                 SendEvent::from_event(events.remove(0))
1835         };
1836         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1837
1838         // Attempt to trigger a channel reserve violation --> payment failure.
1839         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1840         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;
1841         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1842         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1843
1844         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1845         let secp_ctx = Secp256k1::new();
1846         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1847         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1848         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1849         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1850         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1851         let msg = msgs::UpdateAddHTLC {
1852                 channel_id: chan.2,
1853                 htlc_id: 1,
1854                 amount_msat: htlc_msat + 1,
1855                 payment_hash: our_payment_hash_1,
1856                 cltv_expiry: htlc_cltv,
1857                 onion_routing_packet: onion_packet,
1858         };
1859
1860         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1861         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1862         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1863         assert_eq!(nodes[1].node.list_channels().len(), 1);
1864         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1865         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1866         check_added_monitors!(nodes[1], 1);
1867 }
1868
1869 #[test]
1870 fn test_inbound_outbound_capacity_is_not_zero() {
1871         let chanmon_cfgs = create_chanmon_cfgs(2);
1872         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1873         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1874         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1875         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1876         let channels0 = node_chanmgrs[0].list_channels();
1877         let channels1 = node_chanmgrs[1].list_channels();
1878         assert_eq!(channels0.len(), 1);
1879         assert_eq!(channels1.len(), 1);
1880
1881         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1882         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1883
1884         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1885         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1886 }
1887
1888 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1889         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1890 }
1891
1892 #[test]
1893 fn test_channel_reserve_holding_cell_htlcs() {
1894         let chanmon_cfgs = create_chanmon_cfgs(3);
1895         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1896         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1897         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1898         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1899         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1900
1901         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1902         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1903
1904         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1905         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1906
1907         macro_rules! expect_forward {
1908                 ($node: expr) => {{
1909                         let mut events = $node.node.get_and_clear_pending_msg_events();
1910                         assert_eq!(events.len(), 1);
1911                         check_added_monitors!($node, 1);
1912                         let payment_event = SendEvent::from_event(events.remove(0));
1913                         payment_event
1914                 }}
1915         }
1916
1917         let feemsat = 239; // somehow we know?
1918         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1919         let feerate = get_feerate!(nodes[0], chan_1.2);
1920
1921         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1922
1923         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1924         {
1925                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1926                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1927                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1928                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1929                         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)));
1930                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1931                 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);
1932         }
1933
1934         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1935         // nodes[0]'s wealth
1936         loop {
1937                 let amt_msat = recv_value_0 + total_fee_msat;
1938                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1939                 // Also, ensure that each payment has enough to be over the dust limit to
1940                 // ensure it'll be included in each commit tx fee calculation.
1941                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1942                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1943                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1944                         break;
1945                 }
1946                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1947
1948                 let (stat01_, stat11_, stat12_, stat22_) = (
1949                         get_channel_value_stat!(nodes[0], chan_1.2),
1950                         get_channel_value_stat!(nodes[1], chan_1.2),
1951                         get_channel_value_stat!(nodes[1], chan_2.2),
1952                         get_channel_value_stat!(nodes[2], chan_2.2),
1953                 );
1954
1955                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1956                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1957                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1958                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1959                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1960         }
1961
1962         // adding pending output.
1963         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1964         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1965         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1966         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1967         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1968         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1969         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1970         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1971         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1972         // policy.
1973         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1974         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1975         let amt_msat_1 = recv_value_1 + total_fee_msat;
1976
1977         let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1978         let payment_event_1 = {
1979                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1980                 check_added_monitors!(nodes[0], 1);
1981
1982                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1983                 assert_eq!(events.len(), 1);
1984                 SendEvent::from_event(events.remove(0))
1985         };
1986         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1987
1988         // channel reserve test with htlc pending output > 0
1989         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1990         {
1991                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1992                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1993                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1994                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1995         }
1996
1997         // split the rest to test holding cell
1998         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1999         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2000         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2001         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2002         {
2003                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2004                 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);
2005         }
2006
2007         // now see if they go through on both sides
2008         let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2009         // but this will stuck in the holding cell
2010         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2011         check_added_monitors!(nodes[0], 0);
2012         let events = nodes[0].node.get_and_clear_pending_events();
2013         assert_eq!(events.len(), 0);
2014
2015         // test with outbound holding cell amount > 0
2016         {
2017                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2018                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2019                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2020                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2021                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2022         }
2023
2024         let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2025         // this will also stuck in the holding cell
2026         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2027         check_added_monitors!(nodes[0], 0);
2028         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2029         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2030
2031         // flush the pending htlc
2032         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2033         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2034         check_added_monitors!(nodes[1], 1);
2035
2036         // the pending htlc should be promoted to committed
2037         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2038         check_added_monitors!(nodes[0], 1);
2039         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2040
2041         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2042         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2043         // No commitment_signed so get_event_msg's assert(len == 1) passes
2044         check_added_monitors!(nodes[0], 1);
2045
2046         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2047         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2048         check_added_monitors!(nodes[1], 1);
2049
2050         expect_pending_htlcs_forwardable!(nodes[1]);
2051
2052         let ref payment_event_11 = expect_forward!(nodes[1]);
2053         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2054         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2055
2056         expect_pending_htlcs_forwardable!(nodes[2]);
2057         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2058
2059         // flush the htlcs in the holding cell
2060         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2061         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2062         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2063         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2064         expect_pending_htlcs_forwardable!(nodes[1]);
2065
2066         let ref payment_event_3 = expect_forward!(nodes[1]);
2067         assert_eq!(payment_event_3.msgs.len(), 2);
2068         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2069         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2070
2071         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2072         expect_pending_htlcs_forwardable!(nodes[2]);
2073
2074         let events = nodes[2].node.get_and_clear_pending_events();
2075         assert_eq!(events.len(), 2);
2076         match events[0] {
2077                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2078                         assert_eq!(our_payment_hash_21, *payment_hash);
2079                         assert!(payment_preimage.is_none());
2080                         assert_eq!(our_payment_secret_21, *payment_secret);
2081                         assert_eq!(recv_value_21, amt);
2082                 },
2083                 _ => panic!("Unexpected event"),
2084         }
2085         match events[1] {
2086                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2087                         assert_eq!(our_payment_hash_22, *payment_hash);
2088                         assert!(payment_preimage.is_none());
2089                         assert_eq!(our_payment_secret_22, *payment_secret);
2090                         assert_eq!(recv_value_22, amt);
2091                 },
2092                 _ => panic!("Unexpected event"),
2093         }
2094
2095         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2096         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2097         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2098
2099         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2100         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2101         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2102
2103         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2104         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);
2105         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2106         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2107         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2108
2109         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2110         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2111 }
2112
2113 #[test]
2114 fn channel_reserve_in_flight_removes() {
2115         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2116         // can send to its counterparty, but due to update ordering, the other side may not yet have
2117         // considered those HTLCs fully removed.
2118         // This tests that we don't count HTLCs which will not be included in the next remote
2119         // commitment transaction towards the reserve value (as it implies no commitment transaction
2120         // will be generated which violates the remote reserve value).
2121         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2122         // To test this we:
2123         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2124         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2125         //    you only consider the value of the first HTLC, it may not),
2126         //  * start routing a third HTLC from A to B,
2127         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2128         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2129         //  * deliver the first fulfill from B
2130         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2131         //    claim,
2132         //  * deliver A's response CS and RAA.
2133         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2134         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2135         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2136         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2137         let chanmon_cfgs = create_chanmon_cfgs(2);
2138         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2139         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2140         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2141         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2142         let logger = test_utils::TestLogger::new();
2143
2144         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2145         // Route the first two HTLCs.
2146         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2147         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2148
2149         // Start routing the third HTLC (this is just used to get everyone in the right state).
2150         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2151         let send_1 = {
2152                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2153                 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(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2154                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2155                 check_added_monitors!(nodes[0], 1);
2156                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2157                 assert_eq!(events.len(), 1);
2158                 SendEvent::from_event(events.remove(0))
2159         };
2160
2161         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2162         // initial fulfill/CS.
2163         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2164         check_added_monitors!(nodes[1], 1);
2165         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2166
2167         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2168         // remove the second HTLC when we send the HTLC back from B to A.
2169         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2170         check_added_monitors!(nodes[1], 1);
2171         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2172
2173         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2174         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2175         check_added_monitors!(nodes[0], 1);
2176         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2177         expect_payment_sent!(nodes[0], payment_preimage_1);
2178
2179         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2180         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2181         check_added_monitors!(nodes[1], 1);
2182         // B is already AwaitingRAA, so cant generate a CS here
2183         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2184
2185         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2186         check_added_monitors!(nodes[1], 1);
2187         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2188
2189         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2190         check_added_monitors!(nodes[0], 1);
2191         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2192
2193         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2194         check_added_monitors!(nodes[1], 1);
2195         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2196
2197         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2198         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2199         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2200         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2201         // on-chain as necessary).
2202         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2203         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2204         check_added_monitors!(nodes[0], 1);
2205         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2206         expect_payment_sent!(nodes[0], payment_preimage_2);
2207
2208         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2209         check_added_monitors!(nodes[1], 1);
2210         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2211
2212         expect_pending_htlcs_forwardable!(nodes[1]);
2213         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2214
2215         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2216         // resolve the second HTLC from A's point of view.
2217         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2218         check_added_monitors!(nodes[0], 1);
2219         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2220
2221         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2222         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2223         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2224         let send_2 = {
2225                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2226                 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(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2227                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2228                 check_added_monitors!(nodes[1], 1);
2229                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2230                 assert_eq!(events.len(), 1);
2231                 SendEvent::from_event(events.remove(0))
2232         };
2233
2234         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2235         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2236         check_added_monitors!(nodes[0], 1);
2237         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2238
2239         // Now just resolve all the outstanding messages/HTLCs for completeness...
2240
2241         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2242         check_added_monitors!(nodes[1], 1);
2243         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2244
2245         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2246         check_added_monitors!(nodes[1], 1);
2247
2248         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2249         check_added_monitors!(nodes[0], 1);
2250         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2251
2252         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2253         check_added_monitors!(nodes[1], 1);
2254         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2255
2256         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2257         check_added_monitors!(nodes[0], 1);
2258
2259         expect_pending_htlcs_forwardable!(nodes[0]);
2260         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2261
2262         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2263         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2264 }
2265
2266 #[test]
2267 fn channel_monitor_network_test() {
2268         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2269         // tests that ChannelMonitor is able to recover from various states.
2270         let chanmon_cfgs = create_chanmon_cfgs(5);
2271         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2272         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2273         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2274
2275         // Create some initial channels
2276         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2277         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2278         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2279         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2280
2281         // Make sure all nodes are at the same starting height
2282         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2283         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2284         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2285         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2286         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2287
2288         // Rebalance the network a bit by relaying one payment through all the channels...
2289         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2290         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2291         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2292         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2293
2294         // Simple case with no pending HTLCs:
2295         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2296         check_added_monitors!(nodes[1], 1);
2297         check_closed_broadcast!(nodes[1], false);
2298         {
2299                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2300                 assert_eq!(node_txn.len(), 1);
2301                 mine_transaction(&nodes[0], &node_txn[0]);
2302                 check_added_monitors!(nodes[0], 1);
2303                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2304         }
2305         check_closed_broadcast!(nodes[0], true);
2306         assert_eq!(nodes[0].node.list_channels().len(), 0);
2307         assert_eq!(nodes[1].node.list_channels().len(), 1);
2308
2309         // One pending HTLC is discarded by the force-close:
2310         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2311
2312         // Simple case of one pending HTLC to HTLC-Timeout
2313         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2314         check_closed_broadcast!(nodes[1], false);
2315         check_added_monitors!(nodes[1], 1);
2316         {
2317                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2318                 mine_transaction(&nodes[2], &node_txn[0]);
2319                 check_added_monitors!(nodes[2], 1);
2320                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2321         }
2322         check_closed_broadcast!(nodes[2], true);
2323         assert_eq!(nodes[1].node.list_channels().len(), 0);
2324         assert_eq!(nodes[2].node.list_channels().len(), 1);
2325
2326         macro_rules! claim_funds {
2327                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2328                         {
2329                                 assert!($node.node.claim_funds($preimage));
2330                                 check_added_monitors!($node, 1);
2331
2332                                 let events = $node.node.get_and_clear_pending_msg_events();
2333                                 assert_eq!(events.len(), 1);
2334                                 match events[0] {
2335                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2336                                                 assert!(update_add_htlcs.is_empty());
2337                                                 assert!(update_fail_htlcs.is_empty());
2338                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2339                                         },
2340                                         _ => panic!("Unexpected event"),
2341                                 };
2342                         }
2343                 }
2344         }
2345
2346         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2347         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2348         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2349         check_added_monitors!(nodes[2], 1);
2350         check_closed_broadcast!(nodes[2], false);
2351         let node2_commitment_txid;
2352         {
2353                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2354                 node2_commitment_txid = node_txn[0].txid();
2355
2356                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2357                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2358                 mine_transaction(&nodes[3], &node_txn[0]);
2359                 check_added_monitors!(nodes[3], 1);
2360                 check_preimage_claim(&nodes[3], &node_txn);
2361         }
2362         check_closed_broadcast!(nodes[3], true);
2363         assert_eq!(nodes[2].node.list_channels().len(), 0);
2364         assert_eq!(nodes[3].node.list_channels().len(), 1);
2365
2366         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2367         // confusing us in the following tests.
2368         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2369
2370         // One pending HTLC to time out:
2371         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2372         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2373         // buffer space).
2374
2375         let (close_chan_update_1, close_chan_update_2) = {
2376                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2377                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2378                 assert_eq!(events.len(), 2);
2379                 let close_chan_update_1 = match events[0] {
2380                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2381                                 msg.clone()
2382                         },
2383                         _ => panic!("Unexpected event"),
2384                 };
2385                 match events[1] {
2386                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2387                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2388                         },
2389                         _ => panic!("Unexpected event"),
2390                 }
2391                 check_added_monitors!(nodes[3], 1);
2392
2393                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2394                 {
2395                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2396                         node_txn.retain(|tx| {
2397                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2398                                         false
2399                                 } else { true }
2400                         });
2401                 }
2402
2403                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2404
2405                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2406                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2407
2408                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2409                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2410                 assert_eq!(events.len(), 2);
2411                 let close_chan_update_2 = match events[0] {
2412                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2413                                 msg.clone()
2414                         },
2415                         _ => panic!("Unexpected event"),
2416                 };
2417                 match events[1] {
2418                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2419                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2420                         },
2421                         _ => panic!("Unexpected event"),
2422                 }
2423                 check_added_monitors!(nodes[4], 1);
2424                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2425
2426                 mine_transaction(&nodes[4], &node_txn[0]);
2427                 check_preimage_claim(&nodes[4], &node_txn);
2428                 (close_chan_update_1, close_chan_update_2)
2429         };
2430         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2431         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2432         assert_eq!(nodes[3].node.list_channels().len(), 0);
2433         assert_eq!(nodes[4].node.list_channels().len(), 0);
2434
2435         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2436 }
2437
2438 #[test]
2439 fn test_justice_tx() {
2440         // Test justice txn built on revoked HTLC-Success tx, against both sides
2441         let mut alice_config = UserConfig::default();
2442         alice_config.channel_options.announced_channel = true;
2443         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2444         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2445         let mut bob_config = UserConfig::default();
2446         bob_config.channel_options.announced_channel = true;
2447         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2448         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2449         let user_cfgs = [Some(alice_config), Some(bob_config)];
2450         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2451         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2452         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2456         // Create some new channels:
2457         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2458
2459         // A pending HTLC which will be revoked:
2460         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2461         // Get the will-be-revoked local txn from nodes[0]
2462         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2463         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2464         assert_eq!(revoked_local_txn[0].input.len(), 1);
2465         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2466         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2467         assert_eq!(revoked_local_txn[1].input.len(), 1);
2468         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2469         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2470         // Revoke the old state
2471         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2472
2473         {
2474                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2475                 {
2476                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2477                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2478                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2479
2480                         check_spends!(node_txn[0], revoked_local_txn[0]);
2481                         node_txn.swap_remove(0);
2482                         node_txn.truncate(1);
2483                 }
2484                 check_added_monitors!(nodes[1], 1);
2485                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2486
2487                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2488                 // Verify broadcast of revoked HTLC-timeout
2489                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2490                 check_added_monitors!(nodes[0], 1);
2491                 // Broadcast revoked HTLC-timeout on node 1
2492                 mine_transaction(&nodes[1], &node_txn[1]);
2493                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2494         }
2495         get_announce_close_broadcast_events(&nodes, 0, 1);
2496
2497         assert_eq!(nodes[0].node.list_channels().len(), 0);
2498         assert_eq!(nodes[1].node.list_channels().len(), 0);
2499
2500         // We test justice_tx build by A on B's revoked HTLC-Success tx
2501         // Create some new channels:
2502         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2503         {
2504                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2505                 node_txn.clear();
2506         }
2507
2508         // A pending HTLC which will be revoked:
2509         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2510         // Get the will-be-revoked local txn from B
2511         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2512         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2513         assert_eq!(revoked_local_txn[0].input.len(), 1);
2514         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2515         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2516         // Revoke the old state
2517         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2518         {
2519                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2520                 {
2521                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2522                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2523                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2524
2525                         check_spends!(node_txn[0], revoked_local_txn[0]);
2526                         node_txn.swap_remove(0);
2527                 }
2528                 check_added_monitors!(nodes[0], 1);
2529                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2530
2531                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2532                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2533                 check_added_monitors!(nodes[1], 1);
2534                 mine_transaction(&nodes[0], &node_txn[1]);
2535                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2536         }
2537         get_announce_close_broadcast_events(&nodes, 0, 1);
2538         assert_eq!(nodes[0].node.list_channels().len(), 0);
2539         assert_eq!(nodes[1].node.list_channels().len(), 0);
2540 }
2541
2542 #[test]
2543 fn revoked_output_claim() {
2544         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2545         // transaction is broadcast by its counterparty
2546         let chanmon_cfgs = create_chanmon_cfgs(2);
2547         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2548         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2549         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2550         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2551         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2552         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2553         assert_eq!(revoked_local_txn.len(), 1);
2554         // Only output is the full channel value back to nodes[0]:
2555         assert_eq!(revoked_local_txn[0].output.len(), 1);
2556         // Send a payment through, updating everyone's latest commitment txn
2557         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2558
2559         // Inform nodes[1] that nodes[0] broadcast a stale tx
2560         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2561         check_added_monitors!(nodes[1], 1);
2562         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2563         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2564
2565         check_spends!(node_txn[0], revoked_local_txn[0]);
2566         check_spends!(node_txn[1], chan_1.3);
2567
2568         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2569         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2570         get_announce_close_broadcast_events(&nodes, 0, 1);
2571         check_added_monitors!(nodes[0], 1)
2572 }
2573
2574 #[test]
2575 fn claim_htlc_outputs_shared_tx() {
2576         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2577         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2578         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
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
2583         // Create some new channel:
2584         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2585
2586         // Rebalance the network to generate htlc in the two directions
2587         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2588         // 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
2589         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2590         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2591
2592         // Get the will-be-revoked local txn from node[0]
2593         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2594         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2595         assert_eq!(revoked_local_txn[0].input.len(), 1);
2596         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2597         assert_eq!(revoked_local_txn[1].input.len(), 1);
2598         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2599         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2600         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2601
2602         //Revoke the old state
2603         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2604
2605         {
2606                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2607                 check_added_monitors!(nodes[0], 1);
2608                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2609                 check_added_monitors!(nodes[1], 1);
2610                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2611                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2612
2613                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2614                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2615
2616                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2617                 check_spends!(node_txn[0], revoked_local_txn[0]);
2618
2619                 let mut witness_lens = BTreeSet::new();
2620                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2621                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2622                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2623                 assert_eq!(witness_lens.len(), 3);
2624                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2625                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2626                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2627
2628                 // Next nodes[1] broadcasts its current local tx state:
2629                 assert_eq!(node_txn[1].input.len(), 1);
2630                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2631
2632                 assert_eq!(node_txn[2].input.len(), 1);
2633                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2634                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2635                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2636                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2637                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2638         }
2639         get_announce_close_broadcast_events(&nodes, 0, 1);
2640         assert_eq!(nodes[0].node.list_channels().len(), 0);
2641         assert_eq!(nodes[1].node.list_channels().len(), 0);
2642 }
2643
2644 #[test]
2645 fn claim_htlc_outputs_single_tx() {
2646         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2647         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2648         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2651         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2652
2653         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2654
2655         // Rebalance the network to generate htlc in the two directions
2656         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2657         // 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
2658         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2659         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2660         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2661
2662         // Get the will-be-revoked local txn from node[0]
2663         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2664
2665         //Revoke the old state
2666         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2667
2668         {
2669                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2670                 check_added_monitors!(nodes[0], 1);
2671                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2672                 check_added_monitors!(nodes[1], 1);
2673                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2674
2675                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2676                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2677
2678                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2679                 assert_eq!(node_txn.len(), 9);
2680                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2681                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2682                 // 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)
2683                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2684
2685                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2686                 assert_eq!(node_txn[0].input.len(), 1);
2687                 check_spends!(node_txn[0], chan_1.3);
2688                 assert_eq!(node_txn[1].input.len(), 1);
2689                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2690                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2691                 check_spends!(node_txn[1], node_txn[0]);
2692
2693                 // Justice transactions are indices 1-2-4
2694                 assert_eq!(node_txn[2].input.len(), 1);
2695                 assert_eq!(node_txn[3].input.len(), 1);
2696                 assert_eq!(node_txn[4].input.len(), 1);
2697
2698                 check_spends!(node_txn[2], revoked_local_txn[0]);
2699                 check_spends!(node_txn[3], revoked_local_txn[0]);
2700                 check_spends!(node_txn[4], revoked_local_txn[0]);
2701
2702                 let mut witness_lens = BTreeSet::new();
2703                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2704                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2705                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2706                 assert_eq!(witness_lens.len(), 3);
2707                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2708                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2709                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2710         }
2711         get_announce_close_broadcast_events(&nodes, 0, 1);
2712         assert_eq!(nodes[0].node.list_channels().len(), 0);
2713         assert_eq!(nodes[1].node.list_channels().len(), 0);
2714 }
2715
2716 #[test]
2717 fn test_htlc_on_chain_success() {
2718         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2719         // the preimage backward accordingly. So here we test that ChannelManager is
2720         // broadcasting the right event to other nodes in payment path.
2721         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2722         // A --------------------> B ----------------------> C (preimage)
2723         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2724         // commitment transaction was broadcast.
2725         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2726         // towards B.
2727         // B should be able to claim via preimage if A then broadcasts its local tx.
2728         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2729         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2730         // PaymentSent event).
2731
2732         let chanmon_cfgs = create_chanmon_cfgs(3);
2733         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2734         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2735         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2736
2737         // Create some initial channels
2738         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2739         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2740
2741         // Rebalance the network a bit by relaying one payment through all the channels...
2742         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2743         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2744
2745         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2746         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2747
2748         // Broadcast legit commitment tx from C on B's chain
2749         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2750         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2751         assert_eq!(commitment_tx.len(), 1);
2752         check_spends!(commitment_tx[0], chan_2.3);
2753         nodes[2].node.claim_funds(our_payment_preimage);
2754         nodes[2].node.claim_funds(our_payment_preimage_2);
2755         check_added_monitors!(nodes[2], 2);
2756         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2757         assert!(updates.update_add_htlcs.is_empty());
2758         assert!(updates.update_fail_htlcs.is_empty());
2759         assert!(updates.update_fail_malformed_htlcs.is_empty());
2760         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2761
2762         mine_transaction(&nodes[2], &commitment_tx[0]);
2763         check_closed_broadcast!(nodes[2], true);
2764         check_added_monitors!(nodes[2], 1);
2765         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)
2766         assert_eq!(node_txn.len(), 5);
2767         assert_eq!(node_txn[0], node_txn[3]);
2768         assert_eq!(node_txn[1], node_txn[4]);
2769         assert_eq!(node_txn[2], commitment_tx[0]);
2770         check_spends!(node_txn[0], commitment_tx[0]);
2771         check_spends!(node_txn[1], commitment_tx[0]);
2772         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2773         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2774         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2775         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2776         assert_eq!(node_txn[0].lock_time, 0);
2777         assert_eq!(node_txn[1].lock_time, 0);
2778
2779         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2780         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2781         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2782         {
2783                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2784                 assert_eq!(added_monitors.len(), 1);
2785                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2786                 added_monitors.clear();
2787         }
2788         let events = nodes[1].node.get_and_clear_pending_msg_events();
2789         {
2790                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2791                 assert_eq!(added_monitors.len(), 2);
2792                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2793                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2794                 added_monitors.clear();
2795         }
2796         assert_eq!(events.len(), 3);
2797         match events[0] {
2798                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2799                 _ => panic!("Unexpected event"),
2800         }
2801         match events[1] {
2802                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2803                 _ => panic!("Unexpected event"),
2804         }
2805
2806         match events[2] {
2807                 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, .. } } => {
2808                         assert!(update_add_htlcs.is_empty());
2809                         assert!(update_fail_htlcs.is_empty());
2810                         assert_eq!(update_fulfill_htlcs.len(), 1);
2811                         assert!(update_fail_malformed_htlcs.is_empty());
2812                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2813                 },
2814                 _ => panic!("Unexpected event"),
2815         };
2816         macro_rules! check_tx_local_broadcast {
2817                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2818                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2819                         assert_eq!(node_txn.len(), 5);
2820                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2821                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2822                         check_spends!(node_txn[0], $commitment_tx);
2823                         check_spends!(node_txn[1], $commitment_tx);
2824                         assert_ne!(node_txn[0].lock_time, 0);
2825                         assert_ne!(node_txn[1].lock_time, 0);
2826                         if $htlc_offered {
2827                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2828                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2829                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2830                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2831                         } else {
2832                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2833                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2834                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2835                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2836                         }
2837                         check_spends!(node_txn[2], $chan_tx);
2838                         check_spends!(node_txn[3], node_txn[2]);
2839                         check_spends!(node_txn[4], node_txn[2]);
2840                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2841                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2842                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2843                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2844                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2845                         assert_ne!(node_txn[3].lock_time, 0);
2846                         assert_ne!(node_txn[4].lock_time, 0);
2847                         node_txn.clear();
2848                 } }
2849         }
2850         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2851         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2852         // timeout-claim of the output that nodes[2] just claimed via success.
2853         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2854
2855         // Broadcast legit commitment tx from A on B's chain
2856         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2857         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2858         check_spends!(commitment_tx[0], chan_1.3);
2859         mine_transaction(&nodes[1], &commitment_tx[0]);
2860         check_closed_broadcast!(nodes[1], true);
2861         check_added_monitors!(nodes[1], 1);
2862         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2863         assert_eq!(node_txn.len(), 4);
2864         check_spends!(node_txn[0], commitment_tx[0]);
2865         assert_eq!(node_txn[0].input.len(), 2);
2866         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2867         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2868         assert_eq!(node_txn[0].lock_time, 0);
2869         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2870         check_spends!(node_txn[1], chan_1.3);
2871         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2872         check_spends!(node_txn[2], node_txn[1]);
2873         check_spends!(node_txn[3], node_txn[1]);
2874         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2875         // we already checked the same situation with A.
2876
2877         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2878         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2879         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2880         check_closed_broadcast!(nodes[0], true);
2881         check_added_monitors!(nodes[0], 1);
2882         let events = nodes[0].node.get_and_clear_pending_events();
2883         assert_eq!(events.len(), 2);
2884         let mut first_claimed = false;
2885         for event in events {
2886                 match event {
2887                         Event::PaymentSent { payment_preimage } => {
2888                                 if payment_preimage == our_payment_preimage {
2889                                         assert!(!first_claimed);
2890                                         first_claimed = true;
2891                                 } else {
2892                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2893                                 }
2894                         },
2895                         _ => panic!("Unexpected event"),
2896                 }
2897         }
2898         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2899 }
2900
2901 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2902         // Test that in case of a unilateral close onchain, we detect the state of output and
2903         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2904         // broadcasting the right event to other nodes in payment path.
2905         // A ------------------> B ----------------------> C (timeout)
2906         //    B's commitment tx                 C's commitment tx
2907         //            \                                  \
2908         //         B's HTLC timeout tx               B's timeout tx
2909
2910         let chanmon_cfgs = create_chanmon_cfgs(3);
2911         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2912         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2913         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2914         *nodes[0].connect_style.borrow_mut() = connect_style;
2915         *nodes[1].connect_style.borrow_mut() = connect_style;
2916         *nodes[2].connect_style.borrow_mut() = connect_style;
2917
2918         // Create some intial channels
2919         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2920         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2921
2922         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2923         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2924         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2925
2926         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2927
2928         // Broadcast legit commitment tx from C on B's chain
2929         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2930         check_spends!(commitment_tx[0], chan_2.3);
2931         nodes[2].node.fail_htlc_backwards(&payment_hash);
2932         check_added_monitors!(nodes[2], 0);
2933         expect_pending_htlcs_forwardable!(nodes[2]);
2934         check_added_monitors!(nodes[2], 1);
2935
2936         let events = nodes[2].node.get_and_clear_pending_msg_events();
2937         assert_eq!(events.len(), 1);
2938         match events[0] {
2939                 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, .. } } => {
2940                         assert!(update_add_htlcs.is_empty());
2941                         assert!(!update_fail_htlcs.is_empty());
2942                         assert!(update_fulfill_htlcs.is_empty());
2943                         assert!(update_fail_malformed_htlcs.is_empty());
2944                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2945                 },
2946                 _ => panic!("Unexpected event"),
2947         };
2948         mine_transaction(&nodes[2], &commitment_tx[0]);
2949         check_closed_broadcast!(nodes[2], true);
2950         check_added_monitors!(nodes[2], 1);
2951         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2952         assert_eq!(node_txn.len(), 1);
2953         check_spends!(node_txn[0], chan_2.3);
2954         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2955
2956         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2957         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2958         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2959         mine_transaction(&nodes[1], &commitment_tx[0]);
2960         let timeout_tx;
2961         {
2962                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2963                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2964                 assert_eq!(node_txn[0], node_txn[3]);
2965                 assert_eq!(node_txn[1], node_txn[4]);
2966
2967                 check_spends!(node_txn[2], commitment_tx[0]);
2968                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2969
2970                 check_spends!(node_txn[0], chan_2.3);
2971                 check_spends!(node_txn[1], node_txn[0]);
2972                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2973                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2974
2975                 timeout_tx = node_txn[2].clone();
2976                 node_txn.clear();
2977         }
2978
2979         mine_transaction(&nodes[1], &timeout_tx);
2980         check_added_monitors!(nodes[1], 1);
2981         check_closed_broadcast!(nodes[1], true);
2982         {
2983                 // B will rebroadcast a fee-bumped timeout transaction here.
2984                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2985                 assert_eq!(node_txn.len(), 1);
2986                 check_spends!(node_txn[0], commitment_tx[0]);
2987         }
2988
2989         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2990         {
2991                 // B will rebroadcast its own holder commitment transaction here...just because
2992                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2993                 assert_eq!(node_txn.len(), 1);
2994                 check_spends!(node_txn[0], chan_2.3);
2995         }
2996
2997         expect_pending_htlcs_forwardable!(nodes[1]);
2998         check_added_monitors!(nodes[1], 1);
2999         let events = nodes[1].node.get_and_clear_pending_msg_events();
3000         assert_eq!(events.len(), 1);
3001         match events[0] {
3002                 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, .. } } => {
3003                         assert!(update_add_htlcs.is_empty());
3004                         assert!(!update_fail_htlcs.is_empty());
3005                         assert!(update_fulfill_htlcs.is_empty());
3006                         assert!(update_fail_malformed_htlcs.is_empty());
3007                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3008                 },
3009                 _ => panic!("Unexpected event"),
3010         };
3011
3012         // Broadcast legit commitment tx from B on A's chain
3013         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3014         check_spends!(commitment_tx[0], chan_1.3);
3015
3016         mine_transaction(&nodes[0], &commitment_tx[0]);
3017
3018         check_closed_broadcast!(nodes[0], true);
3019         check_added_monitors!(nodes[0], 1);
3020         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3021         assert_eq!(node_txn.len(), 3);
3022         check_spends!(node_txn[0], commitment_tx[0]);
3023         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3024         check_spends!(node_txn[1], chan_1.3);
3025         check_spends!(node_txn[2], node_txn[1]);
3026         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3027         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3028 }
3029
3030 #[test]
3031 fn test_htlc_on_chain_timeout() {
3032         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3033         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3034         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3035 }
3036
3037 #[test]
3038 fn test_simple_commitment_revoked_fail_backward() {
3039         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3040         // and fail backward accordingly.
3041
3042         let chanmon_cfgs = create_chanmon_cfgs(3);
3043         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3044         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3045         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3046
3047         // Create some initial channels
3048         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3049         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3050
3051         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3052         // Get the will-be-revoked local txn from nodes[2]
3053         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3054         // Revoke the old state
3055         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3056
3057         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3058
3059         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3060         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3061         check_added_monitors!(nodes[1], 1);
3062         check_closed_broadcast!(nodes[1], true);
3063
3064         expect_pending_htlcs_forwardable!(nodes[1]);
3065         check_added_monitors!(nodes[1], 1);
3066         let events = nodes[1].node.get_and_clear_pending_msg_events();
3067         assert_eq!(events.len(), 1);
3068         match events[0] {
3069                 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, .. } } => {
3070                         assert!(update_add_htlcs.is_empty());
3071                         assert_eq!(update_fail_htlcs.len(), 1);
3072                         assert!(update_fulfill_htlcs.is_empty());
3073                         assert!(update_fail_malformed_htlcs.is_empty());
3074                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3075
3076                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3077                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3078
3079                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3080                         assert_eq!(events.len(), 1);
3081                         match events[0] {
3082                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3083                                 _ => panic!("Unexpected event"),
3084                         }
3085                         expect_payment_failed!(nodes[0], payment_hash, false);
3086                 },
3087                 _ => panic!("Unexpected event"),
3088         }
3089 }
3090
3091 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3092         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3093         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3094         // commitment transaction anymore.
3095         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3096         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3097         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3098         // technically disallowed and we should probably handle it reasonably.
3099         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3100         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3101         // transactions:
3102         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3103         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3104         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3105         //   and once they revoke the previous commitment transaction (allowing us to send a new
3106         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3107         let chanmon_cfgs = create_chanmon_cfgs(3);
3108         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3109         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3110         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3111
3112         // Create some initial channels
3113         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3114         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3115
3116         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3117         // Get the will-be-revoked local txn from nodes[2]
3118         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3119         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3120         // Revoke the old state
3121         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3122
3123         let value = if use_dust {
3124                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3125                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3126                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3127         } else { 3000000 };
3128
3129         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3130         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3131         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3132
3133         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3134         expect_pending_htlcs_forwardable!(nodes[2]);
3135         check_added_monitors!(nodes[2], 1);
3136         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3137         assert!(updates.update_add_htlcs.is_empty());
3138         assert!(updates.update_fulfill_htlcs.is_empty());
3139         assert!(updates.update_fail_malformed_htlcs.is_empty());
3140         assert_eq!(updates.update_fail_htlcs.len(), 1);
3141         assert!(updates.update_fee.is_none());
3142         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3143         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3144         // Drop the last RAA from 3 -> 2
3145
3146         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3147         expect_pending_htlcs_forwardable!(nodes[2]);
3148         check_added_monitors!(nodes[2], 1);
3149         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3150         assert!(updates.update_add_htlcs.is_empty());
3151         assert!(updates.update_fulfill_htlcs.is_empty());
3152         assert!(updates.update_fail_malformed_htlcs.is_empty());
3153         assert_eq!(updates.update_fail_htlcs.len(), 1);
3154         assert!(updates.update_fee.is_none());
3155         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3156         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3157         check_added_monitors!(nodes[1], 1);
3158         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3159         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3160         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3161         check_added_monitors!(nodes[2], 1);
3162
3163         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3164         expect_pending_htlcs_forwardable!(nodes[2]);
3165         check_added_monitors!(nodes[2], 1);
3166         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3167         assert!(updates.update_add_htlcs.is_empty());
3168         assert!(updates.update_fulfill_htlcs.is_empty());
3169         assert!(updates.update_fail_malformed_htlcs.is_empty());
3170         assert_eq!(updates.update_fail_htlcs.len(), 1);
3171         assert!(updates.update_fee.is_none());
3172         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3173         // At this point first_payment_hash has dropped out of the latest two commitment
3174         // transactions that nodes[1] is tracking...
3175         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3176         check_added_monitors!(nodes[1], 1);
3177         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3178         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3179         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3180         check_added_monitors!(nodes[2], 1);
3181
3182         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3183         // on nodes[2]'s RAA.
3184         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3185         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3186         let logger = test_utils::TestLogger::new();
3187         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3188         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3189         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3190         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3191         check_added_monitors!(nodes[1], 0);
3192
3193         if deliver_bs_raa {
3194                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3195                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3196                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3197                 check_added_monitors!(nodes[1], 1);
3198                 let events = nodes[1].node.get_and_clear_pending_events();
3199                 assert_eq!(events.len(), 1);
3200                 match events[0] {
3201                         Event::PendingHTLCsForwardable { .. } => { },
3202                         _ => panic!("Unexpected event"),
3203                 };
3204                 // Deliberately don't process the pending fail-back so they all fail back at once after
3205                 // block connection just like the !deliver_bs_raa case
3206         }
3207
3208         let mut failed_htlcs = HashSet::new();
3209         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3210
3211         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3212         check_added_monitors!(nodes[1], 1);
3213         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3214
3215         let events = nodes[1].node.get_and_clear_pending_events();
3216         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3217         match events[0] {
3218                 Event::PaymentFailed { ref payment_hash, .. } => {
3219                         assert_eq!(*payment_hash, fourth_payment_hash);
3220                 },
3221                 _ => panic!("Unexpected event"),
3222         }
3223         if !deliver_bs_raa {
3224                 match events[1] {
3225                         Event::PendingHTLCsForwardable { .. } => { },
3226                         _ => panic!("Unexpected event"),
3227                 };
3228         }
3229         nodes[1].node.process_pending_htlc_forwards();
3230         check_added_monitors!(nodes[1], 1);
3231
3232         let events = nodes[1].node.get_and_clear_pending_msg_events();
3233         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3234         match events[if deliver_bs_raa { 1 } else { 0 }] {
3235                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3236                 _ => panic!("Unexpected event"),
3237         }
3238         match events[if deliver_bs_raa { 2 } else { 1 }] {
3239                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3240                         assert_eq!(channel_id, chan_2.2);
3241                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3242                 },
3243                 _ => panic!("Unexpected event"),
3244         }
3245         if deliver_bs_raa {
3246                 match events[0] {
3247                         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, .. } } => {
3248                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3249                                 assert_eq!(update_add_htlcs.len(), 1);
3250                                 assert!(update_fulfill_htlcs.is_empty());
3251                                 assert!(update_fail_htlcs.is_empty());
3252                                 assert!(update_fail_malformed_htlcs.is_empty());
3253                         },
3254                         _ => panic!("Unexpected event"),
3255                 }
3256         }
3257         match events[if deliver_bs_raa { 3 } else { 2 }] {
3258                 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, .. } } => {
3259                         assert!(update_add_htlcs.is_empty());
3260                         assert_eq!(update_fail_htlcs.len(), 3);
3261                         assert!(update_fulfill_htlcs.is_empty());
3262                         assert!(update_fail_malformed_htlcs.is_empty());
3263                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3264
3265                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3266                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3267                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3268
3269                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3270
3271                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3272                         // If we delivered B's RAA we got an unknown preimage error, not something
3273                         // that we should update our routing table for.
3274                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3275                         for event in events {
3276                                 match event {
3277                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3278                                         _ => panic!("Unexpected event"),
3279                                 }
3280                         }
3281                         let events = nodes[0].node.get_and_clear_pending_events();
3282                         assert_eq!(events.len(), 3);
3283                         match events[0] {
3284                                 Event::PaymentFailed { ref payment_hash, .. } => {
3285                                         assert!(failed_htlcs.insert(payment_hash.0));
3286                                 },
3287                                 _ => panic!("Unexpected event"),
3288                         }
3289                         match events[1] {
3290                                 Event::PaymentFailed { ref payment_hash, .. } => {
3291                                         assert!(failed_htlcs.insert(payment_hash.0));
3292                                 },
3293                                 _ => panic!("Unexpected event"),
3294                         }
3295                         match events[2] {
3296                                 Event::PaymentFailed { ref payment_hash, .. } => {
3297                                         assert!(failed_htlcs.insert(payment_hash.0));
3298                                 },
3299                                 _ => panic!("Unexpected event"),
3300                         }
3301                 },
3302                 _ => panic!("Unexpected event"),
3303         }
3304
3305         assert!(failed_htlcs.contains(&first_payment_hash.0));
3306         assert!(failed_htlcs.contains(&second_payment_hash.0));
3307         assert!(failed_htlcs.contains(&third_payment_hash.0));
3308 }
3309
3310 #[test]
3311 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3312         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3313         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3314         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3315         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3316 }
3317
3318 #[test]
3319 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3320         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3321         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3322         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3323         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3324 }
3325
3326 #[test]
3327 fn fail_backward_pending_htlc_upon_channel_failure() {
3328         let chanmon_cfgs = create_chanmon_cfgs(2);
3329         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3331         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3332         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3333         let logger = test_utils::TestLogger::new();
3334
3335         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3336         {
3337                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3338                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3339                 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(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3340                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3341                 check_added_monitors!(nodes[0], 1);
3342
3343                 let payment_event = {
3344                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3345                         assert_eq!(events.len(), 1);
3346                         SendEvent::from_event(events.remove(0))
3347                 };
3348                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3349                 assert_eq!(payment_event.msgs.len(), 1);
3350         }
3351
3352         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3353         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3354         {
3355                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3356                 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(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3357                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3358                 check_added_monitors!(nodes[0], 0);
3359
3360                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3361         }
3362
3363         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3364         {
3365                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3366
3367                 let secp_ctx = Secp256k1::new();
3368                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3369                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3370                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3371                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3372                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3373                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3374                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3375
3376                 // Send a 0-msat update_add_htlc to fail the channel.
3377                 let update_add_htlc = msgs::UpdateAddHTLC {
3378                         channel_id: chan.2,
3379                         htlc_id: 0,
3380                         amount_msat: 0,
3381                         payment_hash,
3382                         cltv_expiry,
3383                         onion_routing_packet,
3384                 };
3385                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3386         }
3387
3388         // Check that Alice fails backward the pending HTLC from the second payment.
3389         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3390         check_closed_broadcast!(nodes[0], true);
3391         check_added_monitors!(nodes[0], 1);
3392 }
3393
3394 #[test]
3395 fn test_htlc_ignore_latest_remote_commitment() {
3396         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3397         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3398         let chanmon_cfgs = create_chanmon_cfgs(2);
3399         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3400         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3401         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3402         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3403
3404         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3405         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3406         check_closed_broadcast!(nodes[0], true);
3407         check_added_monitors!(nodes[0], 1);
3408
3409         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3410         assert_eq!(node_txn.len(), 2);
3411
3412         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3413         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3414         check_closed_broadcast!(nodes[1], true);
3415         check_added_monitors!(nodes[1], 1);
3416
3417         // Duplicate the connect_block call since this may happen due to other listeners
3418         // registering new transactions
3419         header.prev_blockhash = header.block_hash();
3420         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
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, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3439                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).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).unwrap();
3468         check_closed_broadcast!(nodes[2], true);
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         mine_transaction(&nodes[1], &tx);
3480
3481         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3482         check_closed_broadcast!(nodes[1], true);
3483         check_added_monitors!(nodes[1], 1);
3484
3485         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3486         {
3487                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3488                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3489                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3490         }
3491         mine_transaction(&nodes[2], &tx);
3492         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3493         assert_eq!(node_txn.len(), 1);
3494         assert_eq!(node_txn[0].input.len(), 1);
3495         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3496         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3497         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3498
3499         check_spends!(node_txn[0], tx);
3500 }
3501
3502 #[test]
3503 fn test_dup_events_on_peer_disconnect() {
3504         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3505         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3506         // as we used to generate the event immediately upon receipt of the payment preimage in the
3507         // update_fulfill_htlc message.
3508
3509         let chanmon_cfgs = create_chanmon_cfgs(2);
3510         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3511         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3512         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3513         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3514
3515         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3516
3517         assert!(nodes[1].node.claim_funds(payment_preimage));
3518         check_added_monitors!(nodes[1], 1);
3519         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3520         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3521         expect_payment_sent!(nodes[0], payment_preimage);
3522
3523         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3524         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3525
3526         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3527         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3528 }
3529
3530 #[test]
3531 fn test_simple_peer_disconnect() {
3532         // Test that we can reconnect when there are no lost messages
3533         let chanmon_cfgs = create_chanmon_cfgs(3);
3534         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3535         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3536         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3537         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3538         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3539
3540         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3541         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3542         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3543
3544         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3545         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3546         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3547         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3548
3549         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3550         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3551         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3552
3553         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3554         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3555         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3556         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3557
3558         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3559         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3560
3561         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3562         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3563
3564         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3565         {
3566                 let events = nodes[0].node.get_and_clear_pending_events();
3567                 assert_eq!(events.len(), 2);
3568                 match events[0] {
3569                         Event::PaymentSent { payment_preimage } => {
3570                                 assert_eq!(payment_preimage, payment_preimage_3);
3571                         },
3572                         _ => panic!("Unexpected event"),
3573                 }
3574                 match events[1] {
3575                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3576                                 assert_eq!(payment_hash, payment_hash_5);
3577                                 assert!(rejected_by_dest);
3578                         },
3579                         _ => panic!("Unexpected event"),
3580                 }
3581         }
3582
3583         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3584         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3585 }
3586
3587 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3588         // Test that we can reconnect when in-flight HTLC updates get dropped
3589         let chanmon_cfgs = create_chanmon_cfgs(2);
3590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3592         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3593         if messages_delivered == 0 {
3594                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3595                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3596         } else {
3597                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3598         }
3599
3600         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3601
3602         let logger = test_utils::TestLogger::new();
3603         let payment_event = {
3604                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3605                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3606                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3607                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3608                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3609                 check_added_monitors!(nodes[0], 1);
3610
3611                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3612                 assert_eq!(events.len(), 1);
3613                 SendEvent::from_event(events.remove(0))
3614         };
3615         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3616
3617         if messages_delivered < 2 {
3618                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3619         } else {
3620                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3621                 if messages_delivered >= 3 {
3622                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3623                         check_added_monitors!(nodes[1], 1);
3624                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3625
3626                         if messages_delivered >= 4 {
3627                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3628                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3629                                 check_added_monitors!(nodes[0], 1);
3630
3631                                 if messages_delivered >= 5 {
3632                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3633                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3634                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3635                                         check_added_monitors!(nodes[0], 1);
3636
3637                                         if messages_delivered >= 6 {
3638                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3639                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3640                                                 check_added_monitors!(nodes[1], 1);
3641                                         }
3642                                 }
3643                         }
3644                 }
3645         }
3646
3647         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3648         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3649         if messages_delivered < 3 {
3650                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3651                 // received on either side, both sides will need to resend them.
3652                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3653         } else if messages_delivered == 3 {
3654                 // nodes[0] still wants its RAA + commitment_signed
3655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3656         } else if messages_delivered == 4 {
3657                 // nodes[0] still wants its commitment_signed
3658                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3659         } else if messages_delivered == 5 {
3660                 // nodes[1] still wants its final RAA
3661                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3662         } else if messages_delivered == 6 {
3663                 // Everything was delivered...
3664                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3665         }
3666
3667         let events_1 = nodes[1].node.get_and_clear_pending_events();
3668         assert_eq!(events_1.len(), 1);
3669         match events_1[0] {
3670                 Event::PendingHTLCsForwardable { .. } => { },
3671                 _ => panic!("Unexpected event"),
3672         };
3673
3674         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3675         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3676         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3677
3678         nodes[1].node.process_pending_htlc_forwards();
3679
3680         let events_2 = nodes[1].node.get_and_clear_pending_events();
3681         assert_eq!(events_2.len(), 1);
3682         match events_2[0] {
3683                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3684                         assert_eq!(payment_hash_1, *payment_hash);
3685                         assert!(payment_preimage.is_none());
3686                         assert_eq!(payment_secret_1, *payment_secret);
3687                         assert_eq!(amt, 1000000);
3688                 },
3689                 _ => panic!("Unexpected event"),
3690         }
3691
3692         nodes[1].node.claim_funds(payment_preimage_1);
3693         check_added_monitors!(nodes[1], 1);
3694
3695         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3696         assert_eq!(events_3.len(), 1);
3697         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3698                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3699                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3700                         assert!(updates.update_add_htlcs.is_empty());
3701                         assert!(updates.update_fail_htlcs.is_empty());
3702                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3703                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3704                         assert!(updates.update_fee.is_none());
3705                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3706                 },
3707                 _ => panic!("Unexpected event"),
3708         };
3709
3710         if messages_delivered >= 1 {
3711                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3712
3713                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3714                 assert_eq!(events_4.len(), 1);
3715                 match events_4[0] {
3716                         Event::PaymentSent { ref payment_preimage } => {
3717                                 assert_eq!(payment_preimage_1, *payment_preimage);
3718                         },
3719                         _ => panic!("Unexpected event"),
3720                 }
3721
3722                 if messages_delivered >= 2 {
3723                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3724                         check_added_monitors!(nodes[0], 1);
3725                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3726
3727                         if messages_delivered >= 3 {
3728                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3729                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3730                                 check_added_monitors!(nodes[1], 1);
3731
3732                                 if messages_delivered >= 4 {
3733                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3734                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3735                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3736                                         check_added_monitors!(nodes[1], 1);
3737
3738                                         if messages_delivered >= 5 {
3739                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3740                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3741                                                 check_added_monitors!(nodes[0], 1);
3742                                         }
3743                                 }
3744                         }
3745                 }
3746         }
3747
3748         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3749         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3750         if messages_delivered < 2 {
3751                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3752                 if messages_delivered < 1 {
3753                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3754                         assert_eq!(events_4.len(), 1);
3755                         match events_4[0] {
3756                                 Event::PaymentSent { ref payment_preimage } => {
3757                                         assert_eq!(payment_preimage_1, *payment_preimage);
3758                                 },
3759                                 _ => panic!("Unexpected event"),
3760                         }
3761                 } else {
3762                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3763                 }
3764         } else if messages_delivered == 2 {
3765                 // nodes[0] still wants its RAA + commitment_signed
3766                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3767         } else if messages_delivered == 3 {
3768                 // nodes[0] still wants its commitment_signed
3769                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3770         } else if messages_delivered == 4 {
3771                 // nodes[1] still wants its final RAA
3772                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3773         } else if messages_delivered == 5 {
3774                 // Everything was delivered...
3775                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3776         }
3777
3778         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3779         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3780         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3781
3782         // Channel should still work fine...
3783         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3784         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3785                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3786                 &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);
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 persister: test_utils::TestPersister;
3813         let new_chain_monitor: test_utils::TestChainMonitor;
3814         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3815         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3816         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3817
3818         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3819         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3820
3821         confirm_transaction(&nodes[0], &tx);
3822         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3823         assert_eq!(events_1.len(), 1);
3824         match events_1[0] {
3825                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3826                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3827                 },
3828                 _ => panic!("Unexpected event"),
3829         }
3830
3831         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3832
3833         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3834         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3835
3836         confirm_transaction(&nodes[1], &tx);
3837         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3838         assert_eq!(events_2.len(), 2);
3839         let funding_locked = match events_2[0] {
3840                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3841                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3842                         msg.clone()
3843                 },
3844                 _ => panic!("Unexpected event"),
3845         };
3846         let bs_announcement_sigs = match events_2[1] {
3847                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3848                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3849                         msg.clone()
3850                 },
3851                 _ => panic!("Unexpected event"),
3852         };
3853
3854         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3855
3856         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3857         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3858         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3859         assert_eq!(events_3.len(), 2);
3860         let as_announcement_sigs = match events_3[0] {
3861                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3862                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3863                         msg.clone()
3864                 },
3865                 _ => panic!("Unexpected event"),
3866         };
3867         let (as_announcement, as_update) = match events_3[1] {
3868                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3869                         (msg.clone(), update_msg.clone())
3870                 },
3871                 _ => panic!("Unexpected event"),
3872         };
3873
3874         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3875         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3876         assert_eq!(events_4.len(), 1);
3877         let (_, bs_update) = match events_4[0] {
3878                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3879                         (msg.clone(), update_msg.clone())
3880                 },
3881                 _ => panic!("Unexpected event"),
3882         };
3883
3884         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3885         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3886         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3887
3888         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3889         let logger = test_utils::TestLogger::new();
3890         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(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3891         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3892         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3893
3894         // Check that after deserialization and reconnection we can still generate an identical
3895         // channel_announcement from the cached signatures.
3896         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3897
3898         let nodes_0_serialized = nodes[0].node.encode();
3899         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3900         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3901
3902         persister = test_utils::TestPersister::new();
3903         let keys_manager = &chanmon_cfgs[0].keys_manager;
3904         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
3905         nodes[0].chain_monitor = &new_chain_monitor;
3906         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3907         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3908                 &mut chan_0_monitor_read, keys_manager).unwrap();
3909         assert!(chan_0_monitor_read.is_empty());
3910
3911         let mut nodes_0_read = &nodes_0_serialized[..];
3912         let (_, nodes_0_deserialized_tmp) = {
3913                 let mut channel_monitors = HashMap::new();
3914                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3915                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3916                         default_config: UserConfig::default(),
3917                         keys_manager,
3918                         fee_estimator: node_cfgs[0].fee_estimator,
3919                         chain_monitor: nodes[0].chain_monitor,
3920                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3921                         logger: nodes[0].logger,
3922                         channel_monitors,
3923                 }).unwrap()
3924         };
3925         nodes_0_deserialized = nodes_0_deserialized_tmp;
3926         assert!(nodes_0_read.is_empty());
3927
3928         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3929         nodes[0].node = &nodes_0_deserialized;
3930         check_added_monitors!(nodes[0], 1);
3931
3932         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3933
3934         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3935         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3936         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3937         let mut found_announcement = false;
3938         for event in msgs.iter() {
3939                 match event {
3940                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3941                                 if *msg == as_announcement { found_announcement = true; }
3942                         },
3943                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3944                         _ => panic!("Unexpected event"),
3945                 }
3946         }
3947         assert!(found_announcement);
3948 }
3949
3950 #[test]
3951 fn test_drop_messages_peer_disconnect_dual_htlc() {
3952         // Test that we can handle reconnecting when both sides of a channel have pending
3953         // commitment_updates when we disconnect.
3954         let chanmon_cfgs = create_chanmon_cfgs(2);
3955         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3956         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3957         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3958         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3959         let logger = test_utils::TestLogger::new();
3960
3961         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3962
3963         // Now try to send a second payment which will fail to send
3964         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3965         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3966         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(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3967         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3968         check_added_monitors!(nodes[0], 1);
3969
3970         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3971         assert_eq!(events_1.len(), 1);
3972         match events_1[0] {
3973                 MessageSendEvent::UpdateHTLCs { .. } => {},
3974                 _ => panic!("Unexpected event"),
3975         }
3976
3977         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3978         check_added_monitors!(nodes[1], 1);
3979
3980         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3981         assert_eq!(events_2.len(), 1);
3982         match events_2[0] {
3983                 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 } } => {
3984                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3985                         assert!(update_add_htlcs.is_empty());
3986                         assert_eq!(update_fulfill_htlcs.len(), 1);
3987                         assert!(update_fail_htlcs.is_empty());
3988                         assert!(update_fail_malformed_htlcs.is_empty());
3989                         assert!(update_fee.is_none());
3990
3991                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3992                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3993                         assert_eq!(events_3.len(), 1);
3994                         match events_3[0] {
3995                                 Event::PaymentSent { ref payment_preimage } => {
3996                                         assert_eq!(*payment_preimage, payment_preimage_1);
3997                                 },
3998                                 _ => panic!("Unexpected event"),
3999                         }
4000
4001                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4002                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4003                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4004                         check_added_monitors!(nodes[0], 1);
4005                 },
4006                 _ => panic!("Unexpected event"),
4007         }
4008
4009         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4010         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4011
4012         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4013         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4014         assert_eq!(reestablish_1.len(), 1);
4015         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4016         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4017         assert_eq!(reestablish_2.len(), 1);
4018
4019         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4020         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4021         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4022         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4023
4024         assert!(as_resp.0.is_none());
4025         assert!(bs_resp.0.is_none());
4026
4027         assert!(bs_resp.1.is_none());
4028         assert!(bs_resp.2.is_none());
4029
4030         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4031
4032         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4033         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4034         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4035         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4036         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4037         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4038         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4039         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4040         // No commitment_signed so get_event_msg's assert(len == 1) passes
4041         check_added_monitors!(nodes[1], 1);
4042
4043         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4044         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4045         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4046         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4047         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4048         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4049         assert!(bs_second_commitment_signed.update_fee.is_none());
4050         check_added_monitors!(nodes[1], 1);
4051
4052         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4053         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4054         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4055         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4056         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4057         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4058         assert!(as_commitment_signed.update_fee.is_none());
4059         check_added_monitors!(nodes[0], 1);
4060
4061         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4062         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4063         // No commitment_signed so get_event_msg's assert(len == 1) passes
4064         check_added_monitors!(nodes[0], 1);
4065
4066         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4067         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4068         // No commitment_signed so get_event_msg's assert(len == 1) passes
4069         check_added_monitors!(nodes[1], 1);
4070
4071         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4072         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4073         check_added_monitors!(nodes[1], 1);
4074
4075         expect_pending_htlcs_forwardable!(nodes[1]);
4076
4077         let events_5 = nodes[1].node.get_and_clear_pending_events();
4078         assert_eq!(events_5.len(), 1);
4079         match events_5[0] {
4080                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4081                         assert_eq!(payment_hash_2, *payment_hash);
4082                         assert!(payment_preimage.is_none());
4083                         assert_eq!(payment_secret_2, *payment_secret);
4084                 },
4085                 _ => panic!("Unexpected event"),
4086         }
4087
4088         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4089         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4090         check_added_monitors!(nodes[0], 1);
4091
4092         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4093 }
4094
4095 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4096         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4097         // to avoid our counterparty failing the channel.
4098         let chanmon_cfgs = create_chanmon_cfgs(2);
4099         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4100         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4101         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4102
4103         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4104         let logger = test_utils::TestLogger::new();
4105
4106         let our_payment_hash = if send_partial_mpp {
4107                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4108                 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(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4109                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4110                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4111                 // indicates there are more HTLCs coming.
4112                 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
4113                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4114                 check_added_monitors!(nodes[0], 1);
4115                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4116                 assert_eq!(events.len(), 1);
4117                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4118                 // hop should *not* yet generate any PaymentReceived event(s).
4119                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4120                 our_payment_hash
4121         } else {
4122                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4123         };
4124
4125         let mut block = Block {
4126                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4127                 txdata: vec![],
4128         };
4129         connect_block(&nodes[0], &block);
4130         connect_block(&nodes[1], &block);
4131         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4132         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4133                 block.header.prev_blockhash = block.block_hash();
4134                 connect_block(&nodes[0], &block);
4135                 connect_block(&nodes[1], &block);
4136         }
4137
4138         expect_pending_htlcs_forwardable!(nodes[1]);
4139
4140         check_added_monitors!(nodes[1], 1);
4141         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4142         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4143         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4144         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4145         assert!(htlc_timeout_updates.update_fee.is_none());
4146
4147         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4148         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4149         // 100_000 msat as u64, followed by the height at which we failed back above
4150         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4151         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4152         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4153 }
4154
4155 #[test]
4156 fn test_htlc_timeout() {
4157         do_test_htlc_timeout(true);
4158         do_test_htlc_timeout(false);
4159 }
4160
4161 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4162         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4163         let chanmon_cfgs = create_chanmon_cfgs(3);
4164         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4165         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4166         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4167         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4168         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4169
4170         // Make sure all nodes are at the same starting height
4171         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4172         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4173         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4174
4175         let logger = test_utils::TestLogger::new();
4176
4177         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4178         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4179         {
4180                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4181                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4182                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4183         }
4184         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4185         check_added_monitors!(nodes[1], 1);
4186
4187         // Now attempt to route a second payment, which should be placed in the holding cell
4188         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4189         if forwarded_htlc {
4190                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4191                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4192                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4193                 check_added_monitors!(nodes[0], 1);
4194                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4195                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4196                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4197                 expect_pending_htlcs_forwardable!(nodes[1]);
4198                 check_added_monitors!(nodes[1], 0);
4199         } else {
4200                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4201                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4202                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4203                 check_added_monitors!(nodes[1], 0);
4204         }
4205
4206         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4207         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4208         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4209         connect_blocks(&nodes[1], 1);
4210
4211         if forwarded_htlc {
4212                 expect_pending_htlcs_forwardable!(nodes[1]);
4213                 check_added_monitors!(nodes[1], 1);
4214                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4215                 assert_eq!(fail_commit.len(), 1);
4216                 match fail_commit[0] {
4217                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4218                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4219                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4220                         },
4221                         _ => unreachable!(),
4222                 }
4223                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4224                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4225                         match update {
4226                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4227                                 _ => panic!("Unexpected event"),
4228                         }
4229                 } else {
4230                         panic!("Unexpected event");
4231                 }
4232         } else {
4233                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4234         }
4235 }
4236
4237 #[test]
4238 fn test_holding_cell_htlc_add_timeouts() {
4239         do_test_holding_cell_htlc_add_timeouts(false);
4240         do_test_holding_cell_htlc_add_timeouts(true);
4241 }
4242
4243 #[test]
4244 fn test_invalid_channel_announcement() {
4245         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4246         let secp_ctx = Secp256k1::new();
4247         let chanmon_cfgs = create_chanmon_cfgs(2);
4248         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4249         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4250         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4251
4252         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4253
4254         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4255         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4256         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4257         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4258
4259         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 } );
4260
4261         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4262         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4263
4264         let as_network_key = nodes[0].node.get_our_node_id();
4265         let bs_network_key = nodes[1].node.get_our_node_id();
4266
4267         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4268
4269         let mut chan_announcement;
4270
4271         macro_rules! dummy_unsigned_msg {
4272                 () => {
4273                         msgs::UnsignedChannelAnnouncement {
4274                                 features: ChannelFeatures::known(),
4275                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4276                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4277                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4278                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4279                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4280                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4281                                 excess_data: Vec::new(),
4282                         };
4283                 }
4284         }
4285
4286         macro_rules! sign_msg {
4287                 ($unsigned_msg: expr) => {
4288                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4289                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4290                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4291                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4292                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4293                         chan_announcement = msgs::ChannelAnnouncement {
4294                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4295                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4296                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4297                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4298                                 contents: $unsigned_msg
4299                         }
4300                 }
4301         }
4302
4303         let unsigned_msg = dummy_unsigned_msg!();
4304         sign_msg!(unsigned_msg);
4305         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4306         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 } );
4307
4308         // Configured with Network::Testnet
4309         let mut unsigned_msg = dummy_unsigned_msg!();
4310         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4311         sign_msg!(unsigned_msg);
4312         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4313
4314         let mut unsigned_msg = dummy_unsigned_msg!();
4315         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4316         sign_msg!(unsigned_msg);
4317         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4318 }
4319
4320 #[test]
4321 fn test_no_txn_manager_serialize_deserialize() {
4322         let chanmon_cfgs = create_chanmon_cfgs(2);
4323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4325         let logger: test_utils::TestLogger;
4326         let fee_estimator: test_utils::TestFeeEstimator;
4327         let persister: test_utils::TestPersister;
4328         let new_chain_monitor: test_utils::TestChainMonitor;
4329         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4330         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4331
4332         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4333
4334         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4335
4336         let nodes_0_serialized = nodes[0].node.encode();
4337         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4338         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4339
4340         logger = test_utils::TestLogger::new();
4341         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4342         persister = test_utils::TestPersister::new();
4343         let keys_manager = &chanmon_cfgs[0].keys_manager;
4344         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4345         nodes[0].chain_monitor = &new_chain_monitor;
4346         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4347         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4348                 &mut chan_0_monitor_read, keys_manager).unwrap();
4349         assert!(chan_0_monitor_read.is_empty());
4350
4351         let mut nodes_0_read = &nodes_0_serialized[..];
4352         let config = UserConfig::default();
4353         let (_, nodes_0_deserialized_tmp) = {
4354                 let mut channel_monitors = HashMap::new();
4355                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4356                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4357                         default_config: config,
4358                         keys_manager,
4359                         fee_estimator: &fee_estimator,
4360                         chain_monitor: nodes[0].chain_monitor,
4361                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4362                         logger: &logger,
4363                         channel_monitors,
4364                 }).unwrap()
4365         };
4366         nodes_0_deserialized = nodes_0_deserialized_tmp;
4367         assert!(nodes_0_read.is_empty());
4368
4369         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4370         nodes[0].node = &nodes_0_deserialized;
4371         assert_eq!(nodes[0].node.list_channels().len(), 1);
4372         check_added_monitors!(nodes[0], 1);
4373
4374         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4375         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4376         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4377         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4378
4379         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4380         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4381         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4382         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4383
4384         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4385         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4386         for node in nodes.iter() {
4387                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4388                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4389                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4390         }
4391
4392         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4393 }
4394
4395 #[test]
4396 fn test_dup_htlc_onchain_fails_on_reload() {
4397         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4398         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4399         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4400         // the ChannelMonitor tells it to.
4401         //
4402         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4403         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4404         // PaymentFailed event appearing). However, because we may not serialize the relevant
4405         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4406         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4407         // and de-duplicates ChannelMonitor events.
4408         //
4409         // This tests that explicit tracking behavior.
4410         let chanmon_cfgs = create_chanmon_cfgs(2);
4411         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4412         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4413         let persister: test_utils::TestPersister;
4414         let new_chain_monitor: test_utils::TestChainMonitor;
4415         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4416         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4417
4418         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4419
4420         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4421         // nodes[0].
4422         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4423         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4424         check_closed_broadcast!(nodes[0], true);
4425         check_added_monitors!(nodes[0], 1);
4426
4427         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4428         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4429
4430         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4431         assert_eq!(node_txn.len(), 2);
4432
4433         assert!(nodes[1].node.claim_funds(payment_preimage));
4434         check_added_monitors!(nodes[1], 1);
4435
4436         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4437         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
4438         check_closed_broadcast!(nodes[1], true);
4439         check_added_monitors!(nodes[1], 1);
4440         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4441
4442         connect_block(&nodes[0], &Block { header, txdata: node_txn});
4443
4444         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4445         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4446         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4447         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4448         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4449
4450         header.prev_blockhash = header.block_hash();
4451         let claim_block = Block { header, txdata: claim_txn};
4452         connect_block(&nodes[0], &claim_block);
4453         expect_payment_sent!(nodes[0], payment_preimage);
4454
4455         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4456         // connected a highly-relevant block, it likely gets serialized out now.
4457         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4458         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4459
4460         // Now reload nodes[0]...
4461         persister = test_utils::TestPersister::new();
4462         let keys_manager = &chanmon_cfgs[0].keys_manager;
4463         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
4464         nodes[0].chain_monitor = &new_chain_monitor;
4465         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4466         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4467                 &mut chan_0_monitor_read, keys_manager).unwrap();
4468         assert!(chan_0_monitor_read.is_empty());
4469
4470         let (_, nodes_0_deserialized_tmp) = {
4471                 let mut channel_monitors = HashMap::new();
4472                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4473                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4474                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4475                                 default_config: Default::default(),
4476                                 keys_manager,
4477                                 fee_estimator: node_cfgs[0].fee_estimator,
4478                                 chain_monitor: nodes[0].chain_monitor,
4479                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4480                                 logger: nodes[0].logger,
4481                                 channel_monitors,
4482                         }).unwrap()
4483         };
4484         nodes_0_deserialized = nodes_0_deserialized_tmp;
4485
4486         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4487         check_added_monitors!(nodes[0], 1);
4488         nodes[0].node = &nodes_0_deserialized;
4489
4490         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4491         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4492         // payment events should kick in, leaving us with no pending events here.
4493         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, nodes[0].blocks.borrow().len() as u32 - 1);
4494         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4495 }
4496
4497 #[test]
4498 fn test_manager_serialize_deserialize_events() {
4499         // This test makes sure the events field in ChannelManager survives de/serialization
4500         let chanmon_cfgs = create_chanmon_cfgs(2);
4501         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4503         let fee_estimator: test_utils::TestFeeEstimator;
4504         let persister: test_utils::TestPersister;
4505         let logger: test_utils::TestLogger;
4506         let new_chain_monitor: test_utils::TestChainMonitor;
4507         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4508         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4509
4510         // Start creating a channel, but stop right before broadcasting the funding transaction
4511         let channel_value = 100000;
4512         let push_msat = 10001;
4513         let a_flags = InitFeatures::known();
4514         let b_flags = InitFeatures::known();
4515         let node_a = nodes.remove(0);
4516         let node_b = nodes.remove(0);
4517         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4518         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()));
4519         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()));
4520
4521         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4522
4523         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4524         check_added_monitors!(node_a, 0);
4525
4526         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()));
4527         {
4528                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4529                 assert_eq!(added_monitors.len(), 1);
4530                 assert_eq!(added_monitors[0].0, funding_output);
4531                 added_monitors.clear();
4532         }
4533
4534         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()));
4535         {
4536                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4537                 assert_eq!(added_monitors.len(), 1);
4538                 assert_eq!(added_monitors[0].0, funding_output);
4539                 added_monitors.clear();
4540         }
4541         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4542
4543         nodes.push(node_a);
4544         nodes.push(node_b);
4545
4546         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4547         let nodes_0_serialized = nodes[0].node.encode();
4548         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4549         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4550
4551         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4552         logger = test_utils::TestLogger::new();
4553         persister = test_utils::TestPersister::new();
4554         let keys_manager = &chanmon_cfgs[0].keys_manager;
4555         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4556         nodes[0].chain_monitor = &new_chain_monitor;
4557         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4558         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4559                 &mut chan_0_monitor_read, keys_manager).unwrap();
4560         assert!(chan_0_monitor_read.is_empty());
4561
4562         let mut nodes_0_read = &nodes_0_serialized[..];
4563         let config = UserConfig::default();
4564         let (_, nodes_0_deserialized_tmp) = {
4565                 let mut channel_monitors = HashMap::new();
4566                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4567                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4568                         default_config: config,
4569                         keys_manager,
4570                         fee_estimator: &fee_estimator,
4571                         chain_monitor: nodes[0].chain_monitor,
4572                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4573                         logger: &logger,
4574                         channel_monitors,
4575                 }).unwrap()
4576         };
4577         nodes_0_deserialized = nodes_0_deserialized_tmp;
4578         assert!(nodes_0_read.is_empty());
4579
4580         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4581
4582         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4583         nodes[0].node = &nodes_0_deserialized;
4584
4585         // After deserializing, make sure the funding_transaction is still held by the channel manager
4586         let events_4 = nodes[0].node.get_and_clear_pending_events();
4587         assert_eq!(events_4.len(), 0);
4588         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4589         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4590
4591         // Make sure the channel is functioning as though the de/serialization never happened
4592         assert_eq!(nodes[0].node.list_channels().len(), 1);
4593         check_added_monitors!(nodes[0], 1);
4594
4595         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4596         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4597         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4598         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4599
4600         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4601         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4602         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4603         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4604
4605         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4606         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4607         for node in nodes.iter() {
4608                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4609                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4610                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4611         }
4612
4613         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4614 }
4615
4616 #[test]
4617 fn test_simple_manager_serialize_deserialize() {
4618         let chanmon_cfgs = create_chanmon_cfgs(2);
4619         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4620         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4621         let logger: test_utils::TestLogger;
4622         let fee_estimator: test_utils::TestFeeEstimator;
4623         let persister: test_utils::TestPersister;
4624         let new_chain_monitor: test_utils::TestChainMonitor;
4625         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4626         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4627         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4628
4629         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4630         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4631
4632         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4633
4634         let nodes_0_serialized = nodes[0].node.encode();
4635         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4636         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4637
4638         logger = test_utils::TestLogger::new();
4639         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4640         persister = test_utils::TestPersister::new();
4641         let keys_manager = &chanmon_cfgs[0].keys_manager;
4642         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4643         nodes[0].chain_monitor = &new_chain_monitor;
4644         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4645         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4646                 &mut chan_0_monitor_read, keys_manager).unwrap();
4647         assert!(chan_0_monitor_read.is_empty());
4648
4649         let mut nodes_0_read = &nodes_0_serialized[..];
4650         let (_, nodes_0_deserialized_tmp) = {
4651                 let mut channel_monitors = HashMap::new();
4652                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4653                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4654                         default_config: UserConfig::default(),
4655                         keys_manager,
4656                         fee_estimator: &fee_estimator,
4657                         chain_monitor: nodes[0].chain_monitor,
4658                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4659                         logger: &logger,
4660                         channel_monitors,
4661                 }).unwrap()
4662         };
4663         nodes_0_deserialized = nodes_0_deserialized_tmp;
4664         assert!(nodes_0_read.is_empty());
4665
4666         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4667         nodes[0].node = &nodes_0_deserialized;
4668         check_added_monitors!(nodes[0], 1);
4669
4670         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4671
4672         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4673         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4674 }
4675
4676 #[test]
4677 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4678         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4679         let chanmon_cfgs = create_chanmon_cfgs(4);
4680         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4681         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4682         let logger: test_utils::TestLogger;
4683         let fee_estimator: test_utils::TestFeeEstimator;
4684         let persister: test_utils::TestPersister;
4685         let new_chain_monitor: test_utils::TestChainMonitor;
4686         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4687         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4688         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4689         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4690         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4691
4692         let mut node_0_stale_monitors_serialized = Vec::new();
4693         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4694                 let mut writer = test_utils::TestVecWriter(Vec::new());
4695                 monitor.1.write(&mut writer).unwrap();
4696                 node_0_stale_monitors_serialized.push(writer.0);
4697         }
4698
4699         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4700
4701         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4702         let nodes_0_serialized = nodes[0].node.encode();
4703
4704         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4705         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4706         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4707         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4708
4709         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4710         // nodes[3])
4711         let mut node_0_monitors_serialized = Vec::new();
4712         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4713                 let mut writer = test_utils::TestVecWriter(Vec::new());
4714                 monitor.1.write(&mut writer).unwrap();
4715                 node_0_monitors_serialized.push(writer.0);
4716         }
4717
4718         logger = test_utils::TestLogger::new();
4719         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4720         persister = test_utils::TestPersister::new();
4721         let keys_manager = &chanmon_cfgs[0].keys_manager;
4722         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4723         nodes[0].chain_monitor = &new_chain_monitor;
4724
4725
4726         let mut node_0_stale_monitors = Vec::new();
4727         for serialized in node_0_stale_monitors_serialized.iter() {
4728                 let mut read = &serialized[..];
4729                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4730                 assert!(read.is_empty());
4731                 node_0_stale_monitors.push(monitor);
4732         }
4733
4734         let mut node_0_monitors = Vec::new();
4735         for serialized in node_0_monitors_serialized.iter() {
4736                 let mut read = &serialized[..];
4737                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4738                 assert!(read.is_empty());
4739                 node_0_monitors.push(monitor);
4740         }
4741
4742         let mut nodes_0_read = &nodes_0_serialized[..];
4743         if let Err(msgs::DecodeError::InvalidValue) =
4744                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4745                 default_config: UserConfig::default(),
4746                 keys_manager,
4747                 fee_estimator: &fee_estimator,
4748                 chain_monitor: nodes[0].chain_monitor,
4749                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4750                 logger: &logger,
4751                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4752         }) { } else {
4753                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4754         };
4755
4756         let mut nodes_0_read = &nodes_0_serialized[..];
4757         let (_, nodes_0_deserialized_tmp) =
4758                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4759                 default_config: UserConfig::default(),
4760                 keys_manager,
4761                 fee_estimator: &fee_estimator,
4762                 chain_monitor: nodes[0].chain_monitor,
4763                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4764                 logger: &logger,
4765                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4766         }).unwrap();
4767         nodes_0_deserialized = nodes_0_deserialized_tmp;
4768         assert!(nodes_0_read.is_empty());
4769
4770         { // Channel close should result in a commitment tx and an HTLC tx
4771                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4772                 assert_eq!(txn.len(), 2);
4773                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4774                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4775         }
4776
4777         for monitor in node_0_monitors.drain(..) {
4778                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4779                 check_added_monitors!(nodes[0], 1);
4780         }
4781         nodes[0].node = &nodes_0_deserialized;
4782
4783         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4784         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4785         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4786         //... and we can even still claim the payment!
4787         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4788
4789         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4790         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4791         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4792         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4793         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4794         assert_eq!(msg_events.len(), 1);
4795         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4796                 match action {
4797                         &ErrorAction::SendErrorMessage { ref msg } => {
4798                                 assert_eq!(msg.channel_id, channel_id);
4799                         },
4800                         _ => panic!("Unexpected event!"),
4801                 }
4802         }
4803 }
4804
4805 macro_rules! check_spendable_outputs {
4806         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4807                 {
4808                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4809                         let mut txn = Vec::new();
4810                         let mut all_outputs = Vec::new();
4811                         let secp_ctx = Secp256k1::new();
4812                         for event in events.drain(..) {
4813                                 match event {
4814                                         Event::SpendableOutputs { mut outputs } => {
4815                                                 for outp in outputs.drain(..) {
4816                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4817                                                         all_outputs.push(outp);
4818                                                 }
4819                                         },
4820                                         _ => panic!("Unexpected event"),
4821                                 };
4822                         }
4823                         if all_outputs.len() > 1 {
4824                                 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs.iter().map(|a| a).collect::<Vec<_>>(), Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx) {
4825                                         txn.push(tx);
4826                                 }
4827                         }
4828                         txn
4829                 }
4830         }
4831 }
4832
4833 #[test]
4834 fn test_claim_sizeable_push_msat() {
4835         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4836         let chanmon_cfgs = create_chanmon_cfgs(2);
4837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4839         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4840
4841         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4842         nodes[1].node.force_close_channel(&chan.2).unwrap();
4843         check_closed_broadcast!(nodes[1], true);
4844         check_added_monitors!(nodes[1], 1);
4845         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4846         assert_eq!(node_txn.len(), 1);
4847         check_spends!(node_txn[0], chan.3);
4848         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
4849
4850         mine_transaction(&nodes[1], &node_txn[0]);
4851         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4852
4853         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4854         assert_eq!(spend_txn.len(), 1);
4855         check_spends!(spend_txn[0], node_txn[0]);
4856 }
4857
4858 #[test]
4859 fn test_claim_on_remote_sizeable_push_msat() {
4860         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4861         // to_remote output is encumbered by a P2WPKH
4862         let chanmon_cfgs = create_chanmon_cfgs(2);
4863         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4864         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4865         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4866
4867         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4868         nodes[0].node.force_close_channel(&chan.2).unwrap();
4869         check_closed_broadcast!(nodes[0], true);
4870         check_added_monitors!(nodes[0], 1);
4871
4872         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4873         assert_eq!(node_txn.len(), 1);
4874         check_spends!(node_txn[0], chan.3);
4875         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
4876
4877         mine_transaction(&nodes[1], &node_txn[0]);
4878         check_closed_broadcast!(nodes[1], true);
4879         check_added_monitors!(nodes[1], 1);
4880         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4881
4882         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4883         assert_eq!(spend_txn.len(), 1);
4884         check_spends!(spend_txn[0], node_txn[0]);
4885 }
4886
4887 #[test]
4888 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4889         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4890         // to_remote output is encumbered by a P2WPKH
4891
4892         let chanmon_cfgs = create_chanmon_cfgs(2);
4893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4895         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4896
4897         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4898         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4899         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4900         assert_eq!(revoked_local_txn[0].input.len(), 1);
4901         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4902
4903         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4904         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4905         check_closed_broadcast!(nodes[1], true);
4906         check_added_monitors!(nodes[1], 1);
4907
4908         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4909         mine_transaction(&nodes[1], &node_txn[0]);
4910         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4911
4912         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4913         assert_eq!(spend_txn.len(), 3);
4914         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4915         check_spends!(spend_txn[1], node_txn[0]);
4916         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4917 }
4918
4919 #[test]
4920 fn test_static_spendable_outputs_preimage_tx() {
4921         let chanmon_cfgs = create_chanmon_cfgs(2);
4922         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4923         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4924         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4925
4926         // Create some initial channels
4927         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4928
4929         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4930
4931         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4932         assert_eq!(commitment_tx[0].input.len(), 1);
4933         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4934
4935         // Settle A's commitment tx on B's chain
4936         assert!(nodes[1].node.claim_funds(payment_preimage));
4937         check_added_monitors!(nodes[1], 1);
4938         mine_transaction(&nodes[1], &commitment_tx[0]);
4939         check_added_monitors!(nodes[1], 1);
4940         let events = nodes[1].node.get_and_clear_pending_msg_events();
4941         match events[0] {
4942                 MessageSendEvent::UpdateHTLCs { .. } => {},
4943                 _ => panic!("Unexpected event"),
4944         }
4945         match events[1] {
4946                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4947                 _ => panic!("Unexepected event"),
4948         }
4949
4950         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4951         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4952         assert_eq!(node_txn.len(), 3);
4953         check_spends!(node_txn[0], commitment_tx[0]);
4954         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4955         check_spends!(node_txn[1], chan_1.3);
4956         check_spends!(node_txn[2], node_txn[1]);
4957
4958         mine_transaction(&nodes[1], &node_txn[0]);
4959         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4960
4961         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4962         assert_eq!(spend_txn.len(), 1);
4963         check_spends!(spend_txn[0], node_txn[0]);
4964 }
4965
4966 #[test]
4967 fn test_static_spendable_outputs_timeout_tx() {
4968         let chanmon_cfgs = create_chanmon_cfgs(2);
4969         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4970         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4971         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4972
4973         // Create some initial channels
4974         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4975
4976         // Rebalance the network a bit by relaying one payment through all the channels ...
4977         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4978
4979         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4980
4981         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4982         assert_eq!(commitment_tx[0].input.len(), 1);
4983         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4984
4985         // Settle A's commitment tx on B' chain
4986         mine_transaction(&nodes[1], &commitment_tx[0]);
4987         check_added_monitors!(nodes[1], 1);
4988         let events = nodes[1].node.get_and_clear_pending_msg_events();
4989         match events[0] {
4990                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4991                 _ => panic!("Unexpected event"),
4992         }
4993
4994         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4995         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4996         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4997         check_spends!(node_txn[0],  commitment_tx[0].clone());
4998         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4999         check_spends!(node_txn[1], chan_1.3.clone());
5000         check_spends!(node_txn[2], node_txn[1]);
5001
5002         mine_transaction(&nodes[1], &node_txn[0]);
5003         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5004         expect_payment_failed!(nodes[1], our_payment_hash, true);
5005
5006         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5007         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5008         check_spends!(spend_txn[0], commitment_tx[0]);
5009         check_spends!(spend_txn[1], node_txn[0]);
5010         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
5011 }
5012
5013 #[test]
5014 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5015         let chanmon_cfgs = create_chanmon_cfgs(2);
5016         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5017         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5018         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5019
5020         // Create some initial channels
5021         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5022
5023         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5024         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5025         assert_eq!(revoked_local_txn[0].input.len(), 1);
5026         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5027
5028         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5029
5030         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5031         check_closed_broadcast!(nodes[1], true);
5032         check_added_monitors!(nodes[1], 1);
5033
5034         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5035         assert_eq!(node_txn.len(), 2);
5036         assert_eq!(node_txn[0].input.len(), 2);
5037         check_spends!(node_txn[0], revoked_local_txn[0]);
5038
5039         mine_transaction(&nodes[1], &node_txn[0]);
5040         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5041
5042         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5043         assert_eq!(spend_txn.len(), 1);
5044         check_spends!(spend_txn[0], node_txn[0]);
5045 }
5046
5047 #[test]
5048 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5049         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5050         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5051         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5052         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5053         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5054
5055         // Create some initial channels
5056         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5057
5058         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5059         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5060         assert_eq!(revoked_local_txn[0].input.len(), 1);
5061         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5062
5063         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5064
5065         // A will generate HTLC-Timeout from revoked commitment tx
5066         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5067         check_closed_broadcast!(nodes[0], true);
5068         check_added_monitors!(nodes[0], 1);
5069
5070         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5071         assert_eq!(revoked_htlc_txn.len(), 2);
5072         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5073         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5074         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5075         check_spends!(revoked_htlc_txn[1], chan_1.3);
5076
5077         // B will generate justice tx from A's revoked commitment/HTLC tx
5078         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5079         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5080         check_closed_broadcast!(nodes[1], true);
5081         check_added_monitors!(nodes[1], 1);
5082
5083         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5084         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5085         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5086         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5087         // transactions next...
5088         assert_eq!(node_txn[0].input.len(), 3);
5089         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5090
5091         assert_eq!(node_txn[1].input.len(), 2);
5092         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5093         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5094                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5095         } else {
5096                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5097                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5098         }
5099
5100         assert_eq!(node_txn[2].input.len(), 1);
5101         check_spends!(node_txn[2], chan_1.3);
5102
5103         mine_transaction(&nodes[1], &node_txn[1]);
5104         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5105
5106         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5107         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5108         assert_eq!(spend_txn.len(), 1);
5109         assert_eq!(spend_txn[0].input.len(), 1);
5110         check_spends!(spend_txn[0], node_txn[1]);
5111 }
5112
5113 #[test]
5114 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5115         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5116         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5117         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5118         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5119         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5120
5121         // Create some initial channels
5122         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5123
5124         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5125         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5126         assert_eq!(revoked_local_txn[0].input.len(), 1);
5127         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5128
5129         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5130         assert_eq!(revoked_local_txn[0].output.len(), 2);
5131
5132         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5133
5134         // B will generate HTLC-Success from revoked commitment tx
5135         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5136         check_closed_broadcast!(nodes[1], true);
5137         check_added_monitors!(nodes[1], 1);
5138         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5139
5140         assert_eq!(revoked_htlc_txn.len(), 2);
5141         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5142         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5143         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5144
5145         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5146         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5147         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5148
5149         // A will generate justice tx from B's revoked commitment/HTLC tx
5150         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5151         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5152         check_closed_broadcast!(nodes[0], true);
5153         check_added_monitors!(nodes[0], 1);
5154
5155         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5156         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5157
5158         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5159         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5160         // transactions next...
5161         assert_eq!(node_txn[0].input.len(), 2);
5162         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5163         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5164                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5165         } else {
5166                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5167                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5168         }
5169
5170         assert_eq!(node_txn[1].input.len(), 1);
5171         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5172
5173         check_spends!(node_txn[2], chan_1.3);
5174
5175         mine_transaction(&nodes[0], &node_txn[1]);
5176         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5177
5178         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5179         // didn't try to generate any new transactions.
5180
5181         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5182         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5183         assert_eq!(spend_txn.len(), 3);
5184         assert_eq!(spend_txn[0].input.len(), 1);
5185         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5186         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5187         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5188         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5189 }
5190
5191 #[test]
5192 fn test_onchain_to_onchain_claim() {
5193         // Test that in case of channel closure, we detect the state of output and claim HTLC
5194         // on downstream peer's remote commitment tx.
5195         // First, have C claim an HTLC against its own latest commitment transaction.
5196         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5197         // channel.
5198         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5199         // gets broadcast.
5200
5201         let chanmon_cfgs = create_chanmon_cfgs(3);
5202         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5203         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5204         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5205
5206         // Create some initial channels
5207         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5208         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5209
5210         // Rebalance the network a bit by relaying one payment through all the channels ...
5211         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5212         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5213
5214         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5215         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5216         check_spends!(commitment_tx[0], chan_2.3);
5217         nodes[2].node.claim_funds(payment_preimage);
5218         check_added_monitors!(nodes[2], 1);
5219         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5220         assert!(updates.update_add_htlcs.is_empty());
5221         assert!(updates.update_fail_htlcs.is_empty());
5222         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5223         assert!(updates.update_fail_malformed_htlcs.is_empty());
5224
5225         mine_transaction(&nodes[2], &commitment_tx[0]);
5226         check_closed_broadcast!(nodes[2], true);
5227         check_added_monitors!(nodes[2], 1);
5228
5229         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5230         assert_eq!(c_txn.len(), 3);
5231         assert_eq!(c_txn[0], c_txn[2]);
5232         assert_eq!(commitment_tx[0], c_txn[1]);
5233         check_spends!(c_txn[1], chan_2.3);
5234         check_spends!(c_txn[2], c_txn[1]);
5235         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5236         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5237         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5238         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5239
5240         // 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
5241         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5242         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5243         {
5244                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5245                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5246                 assert_eq!(b_txn.len(), 3);
5247                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5248                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5249                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5250                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5251                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5252                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5253                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5254                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5255                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5256                 b_txn.clear();
5257         }
5258         check_added_monitors!(nodes[1], 1);
5259         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5260         assert_eq!(msg_events.len(), 3);
5261         check_added_monitors!(nodes[1], 1);
5262         match msg_events[0] {
5263                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5264                 _ => panic!("Unexpected event"),
5265         }
5266         match msg_events[1] {
5267                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5268                 _ => panic!("Unexpected event"),
5269         }
5270         match msg_events[2] {
5271                 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, .. } } => {
5272                         assert!(update_add_htlcs.is_empty());
5273                         assert!(update_fail_htlcs.is_empty());
5274                         assert_eq!(update_fulfill_htlcs.len(), 1);
5275                         assert!(update_fail_malformed_htlcs.is_empty());
5276                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5277                 },
5278                 _ => panic!("Unexpected event"),
5279         };
5280         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5281         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5282         mine_transaction(&nodes[1], &commitment_tx[0]);
5283         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5284         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5285         assert_eq!(b_txn.len(), 3);
5286         check_spends!(b_txn[1], chan_1.3);
5287         check_spends!(b_txn[2], b_txn[1]);
5288         check_spends!(b_txn[0], commitment_tx[0]);
5289         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5290         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5291         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5292
5293         check_closed_broadcast!(nodes[1], true);
5294         check_added_monitors!(nodes[1], 1);
5295 }
5296
5297 #[test]
5298 fn test_duplicate_payment_hash_one_failure_one_success() {
5299         // Topology : A --> B --> C --> D
5300         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5301         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5302         // we forward one of the payments onwards to D.
5303         let chanmon_cfgs = create_chanmon_cfgs(4);
5304         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5305         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5306         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5307
5308         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5309         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5310         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5311
5312         let node_max_height = std::cmp::max(std::cmp::max(nodes[0].blocks.borrow().len(), nodes[1].blocks.borrow().len()), std::cmp::max(nodes[2].blocks.borrow().len(), nodes[3].blocks.borrow().len())) as u32;
5313         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5314         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5315         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5316         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5317
5318         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5319
5320         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5321         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5322         // script push size limit so that the below script length checks match
5323         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5324         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5325                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5326         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5327
5328         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5329         assert_eq!(commitment_txn[0].input.len(), 1);
5330         check_spends!(commitment_txn[0], chan_2.3);
5331
5332         mine_transaction(&nodes[1], &commitment_txn[0]);
5333         check_closed_broadcast!(nodes[1], true);
5334         check_added_monitors!(nodes[1], 1);
5335
5336         let htlc_timeout_tx;
5337         { // Extract one of the two HTLC-Timeout transaction
5338                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5339                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5340                 assert_eq!(node_txn.len(), 5);
5341                 check_spends!(node_txn[0], commitment_txn[0]);
5342                 assert_eq!(node_txn[0].input.len(), 1);
5343                 check_spends!(node_txn[1], commitment_txn[0]);
5344                 assert_eq!(node_txn[1].input.len(), 1);
5345                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5346                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5347                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5348                 check_spends!(node_txn[2], chan_2.3);
5349                 check_spends!(node_txn[3], node_txn[2]);
5350                 check_spends!(node_txn[4], node_txn[2]);
5351                 htlc_timeout_tx = node_txn[1].clone();
5352         }
5353
5354         nodes[2].node.claim_funds(our_payment_preimage);
5355         mine_transaction(&nodes[2], &commitment_txn[0]);
5356         check_added_monitors!(nodes[2], 2);
5357         let events = nodes[2].node.get_and_clear_pending_msg_events();
5358         match events[0] {
5359                 MessageSendEvent::UpdateHTLCs { .. } => {},
5360                 _ => panic!("Unexpected event"),
5361         }
5362         match events[1] {
5363                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5364                 _ => panic!("Unexepected event"),
5365         }
5366         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5367         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)
5368         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5369         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5370         assert_eq!(htlc_success_txn[0].input.len(), 1);
5371         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5372         assert_eq!(htlc_success_txn[1].input.len(), 1);
5373         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5374         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5375         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5376         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5377         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5378
5379
5380         mine_transaction(&nodes[1], &htlc_timeout_tx);
5381         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5382         expect_pending_htlcs_forwardable!(nodes[1]);
5383         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5384         assert!(htlc_updates.update_add_htlcs.is_empty());
5385         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5386         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5387         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5388         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5389         check_added_monitors!(nodes[1], 1);
5390
5391         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5392         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5393         {
5394                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5395                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5396                 assert_eq!(events.len(), 1);
5397                 match events[0] {
5398                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5399                         },
5400                         _ => { panic!("Unexpected event"); }
5401                 }
5402         }
5403         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5404
5405         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5406         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5407         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5408         assert!(updates.update_add_htlcs.is_empty());
5409         assert!(updates.update_fail_htlcs.is_empty());
5410         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5411         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5412         assert!(updates.update_fail_malformed_htlcs.is_empty());
5413         check_added_monitors!(nodes[1], 1);
5414
5415         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5416         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5417
5418         let events = nodes[0].node.get_and_clear_pending_events();
5419         match events[0] {
5420                 Event::PaymentSent { ref payment_preimage } => {
5421                         assert_eq!(*payment_preimage, our_payment_preimage);
5422                 }
5423                 _ => panic!("Unexpected event"),
5424         }
5425 }
5426
5427 #[test]
5428 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5429         let chanmon_cfgs = create_chanmon_cfgs(2);
5430         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5431         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5432         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5433
5434         // Create some initial channels
5435         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5436
5437         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5438         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5439         assert_eq!(local_txn.len(), 1);
5440         assert_eq!(local_txn[0].input.len(), 1);
5441         check_spends!(local_txn[0], chan_1.3);
5442
5443         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5444         nodes[1].node.claim_funds(payment_preimage);
5445         check_added_monitors!(nodes[1], 1);
5446         mine_transaction(&nodes[1], &local_txn[0]);
5447         check_added_monitors!(nodes[1], 1);
5448         let events = nodes[1].node.get_and_clear_pending_msg_events();
5449         match events[0] {
5450                 MessageSendEvent::UpdateHTLCs { .. } => {},
5451                 _ => panic!("Unexpected event"),
5452         }
5453         match events[1] {
5454                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5455                 _ => panic!("Unexepected event"),
5456         }
5457         let node_tx = {
5458                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5459                 assert_eq!(node_txn.len(), 3);
5460                 assert_eq!(node_txn[0], node_txn[2]);
5461                 assert_eq!(node_txn[1], local_txn[0]);
5462                 assert_eq!(node_txn[0].input.len(), 1);
5463                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5464                 check_spends!(node_txn[0], local_txn[0]);
5465                 node_txn[0].clone()
5466         };
5467
5468         mine_transaction(&nodes[1], &node_tx);
5469         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5470
5471         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5472         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5473         assert_eq!(spend_txn.len(), 1);
5474         check_spends!(spend_txn[0], node_tx);
5475 }
5476
5477 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5478         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5479         // unrevoked commitment transaction.
5480         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5481         // a remote RAA before they could be failed backwards (and combinations thereof).
5482         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5483         // use the same payment hashes.
5484         // Thus, we use a six-node network:
5485         //
5486         // A \         / E
5487         //    - C - D -
5488         // B /         \ F
5489         // And test where C fails back to A/B when D announces its latest commitment transaction
5490         let chanmon_cfgs = create_chanmon_cfgs(6);
5491         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5492         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5493         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5494         let logger = test_utils::TestLogger::new();
5495
5496         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5497         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5498         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5499         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5500         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5501
5502         // Rebalance and check output sanity...
5503         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5504         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5505         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5506
5507         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5508         // 0th HTLC:
5509         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
5510         // 1st HTLC:
5511         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
5512         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5513         let our_node_id = &nodes[1].node.get_our_node_id();
5514         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5515         // 2nd HTLC:
5516         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5517         // 3rd HTLC:
5518         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5519         // 4th HTLC:
5520         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5521         // 5th HTLC:
5522         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5523         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5524         // 6th HTLC:
5525         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, 0).unwrap());
5526         // 7th HTLC:
5527         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, 0).unwrap());
5528
5529         // 8th HTLC:
5530         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5531         // 9th HTLC:
5532         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5533         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5534
5535         // 10th HTLC:
5536         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
5537         // 11th HTLC:
5538         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5539         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, 0).unwrap());
5540
5541         // Double-check that six of the new HTLC were added
5542         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5543         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5544         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5545         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5546
5547         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5548         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5549         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5550         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5551         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5552         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5553         check_added_monitors!(nodes[4], 0);
5554         expect_pending_htlcs_forwardable!(nodes[4]);
5555         check_added_monitors!(nodes[4], 1);
5556
5557         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5558         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5559         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5560         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5561         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5562         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5563
5564         // Fail 3rd below-dust and 7th above-dust HTLCs
5565         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5566         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5567         check_added_monitors!(nodes[5], 0);
5568         expect_pending_htlcs_forwardable!(nodes[5]);
5569         check_added_monitors!(nodes[5], 1);
5570
5571         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5572         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5573         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5574         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5575
5576         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5577
5578         expect_pending_htlcs_forwardable!(nodes[3]);
5579         check_added_monitors!(nodes[3], 1);
5580         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5581         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5582         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5583         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5584         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5585         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5586         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5587         if deliver_last_raa {
5588                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5589         } else {
5590                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5591         }
5592
5593         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5594         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5595         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5596         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5597         //
5598         // We now broadcast the latest commitment transaction, which *should* result in failures for
5599         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5600         // the non-broadcast above-dust HTLCs.
5601         //
5602         // Alternatively, we may broadcast the previous commitment transaction, which should only
5603         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5604         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5605
5606         if announce_latest {
5607                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5608         } else {
5609                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5610         }
5611         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5612         check_closed_broadcast!(nodes[2], true);
5613         expect_pending_htlcs_forwardable!(nodes[2]);
5614         check_added_monitors!(nodes[2], 3);
5615
5616         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5617         assert_eq!(cs_msgs.len(), 2);
5618         let mut a_done = false;
5619         for msg in cs_msgs {
5620                 match msg {
5621                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5622                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5623                                 // should be failed-backwards here.
5624                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5625                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5626                                         for htlc in &updates.update_fail_htlcs {
5627                                                 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 });
5628                                         }
5629                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5630                                         assert!(!a_done);
5631                                         a_done = true;
5632                                         &nodes[0]
5633                                 } else {
5634                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5635                                         for htlc in &updates.update_fail_htlcs {
5636                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5637                                         }
5638                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5639                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5640                                         &nodes[1]
5641                                 };
5642                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5643                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5644                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5645                                 if announce_latest {
5646                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5647                                         if *node_id == nodes[0].node.get_our_node_id() {
5648                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5649                                         }
5650                                 }
5651                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5652                         },
5653                         _ => panic!("Unexpected event"),
5654                 }
5655         }
5656
5657         let as_events = nodes[0].node.get_and_clear_pending_events();
5658         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5659         let mut as_failds = HashSet::new();
5660         for event in as_events.iter() {
5661                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5662                         assert!(as_failds.insert(*payment_hash));
5663                         if *payment_hash != payment_hash_2 {
5664                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5665                         } else {
5666                                 assert!(!rejected_by_dest);
5667                         }
5668                 } else { panic!("Unexpected event"); }
5669         }
5670         assert!(as_failds.contains(&payment_hash_1));
5671         assert!(as_failds.contains(&payment_hash_2));
5672         if announce_latest {
5673                 assert!(as_failds.contains(&payment_hash_3));
5674                 assert!(as_failds.contains(&payment_hash_5));
5675         }
5676         assert!(as_failds.contains(&payment_hash_6));
5677
5678         let bs_events = nodes[1].node.get_and_clear_pending_events();
5679         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5680         let mut bs_failds = HashSet::new();
5681         for event in bs_events.iter() {
5682                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5683                         assert!(bs_failds.insert(*payment_hash));
5684                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5685                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5686                         } else {
5687                                 assert!(!rejected_by_dest);
5688                         }
5689                 } else { panic!("Unexpected event"); }
5690         }
5691         assert!(bs_failds.contains(&payment_hash_1));
5692         assert!(bs_failds.contains(&payment_hash_2));
5693         if announce_latest {
5694                 assert!(bs_failds.contains(&payment_hash_4));
5695         }
5696         assert!(bs_failds.contains(&payment_hash_5));
5697
5698         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5699         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5700         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5701         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5702         // PaymentFailureNetworkUpdates.
5703         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5704         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5705         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5706         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5707         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5708                 match event {
5709                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5710                         _ => panic!("Unexpected event"),
5711                 }
5712         }
5713 }
5714
5715 #[test]
5716 fn test_fail_backwards_latest_remote_announce_a() {
5717         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5718 }
5719
5720 #[test]
5721 fn test_fail_backwards_latest_remote_announce_b() {
5722         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5723 }
5724
5725 #[test]
5726 fn test_fail_backwards_previous_remote_announce() {
5727         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5728         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5729         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5730 }
5731
5732 #[test]
5733 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5734         let chanmon_cfgs = create_chanmon_cfgs(2);
5735         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5736         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5737         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5738
5739         // Create some initial channels
5740         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5741
5742         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5743         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5744         assert_eq!(local_txn[0].input.len(), 1);
5745         check_spends!(local_txn[0], chan_1.3);
5746
5747         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5748         mine_transaction(&nodes[0], &local_txn[0]);
5749         check_closed_broadcast!(nodes[0], true);
5750         check_added_monitors!(nodes[0], 1);
5751
5752         let htlc_timeout = {
5753                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5754                 assert_eq!(node_txn[0].input.len(), 1);
5755                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5756                 check_spends!(node_txn[0], local_txn[0]);
5757                 node_txn[0].clone()
5758         };
5759
5760         mine_transaction(&nodes[0], &htlc_timeout);
5761         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5762         expect_payment_failed!(nodes[0], our_payment_hash, true);
5763
5764         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5765         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5766         assert_eq!(spend_txn.len(), 3);
5767         check_spends!(spend_txn[0], local_txn[0]);
5768         check_spends!(spend_txn[1], htlc_timeout);
5769         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5770 }
5771
5772 #[test]
5773 fn test_key_derivation_params() {
5774         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5775         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5776         // let us re-derive the channel key set to then derive a delayed_payment_key.
5777
5778         let chanmon_cfgs = create_chanmon_cfgs(3);
5779
5780         // We manually create the node configuration to backup the seed.
5781         let seed = [42; 32];
5782         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5783         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &chanmon_cfgs[0].persister, &keys_manager);
5784         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager: &keys_manager, node_seed: seed };
5785         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5786         node_cfgs.remove(0);
5787         node_cfgs.insert(0, node);
5788
5789         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5790         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5791
5792         // Create some initial channels
5793         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5794         // for node 0
5795         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5796         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5797         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5798
5799         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5800         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5801         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5802         assert_eq!(local_txn_1[0].input.len(), 1);
5803         check_spends!(local_txn_1[0], chan_1.3);
5804
5805         // We check funding pubkey are unique
5806         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]));
5807         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]));
5808         if from_0_funding_key_0 == from_1_funding_key_0
5809             || from_0_funding_key_0 == from_1_funding_key_1
5810             || from_0_funding_key_1 == from_1_funding_key_0
5811             || from_0_funding_key_1 == from_1_funding_key_1 {
5812                 panic!("Funding pubkeys aren't unique");
5813         }
5814
5815         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5816         mine_transaction(&nodes[0], &local_txn_1[0]);
5817         check_closed_broadcast!(nodes[0], true);
5818         check_added_monitors!(nodes[0], 1);
5819
5820         let htlc_timeout = {
5821                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5822                 assert_eq!(node_txn[0].input.len(), 1);
5823                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5824                 check_spends!(node_txn[0], local_txn_1[0]);
5825                 node_txn[0].clone()
5826         };
5827
5828         mine_transaction(&nodes[0], &htlc_timeout);
5829         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5830         expect_payment_failed!(nodes[0], our_payment_hash, true);
5831
5832         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5833         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5834         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5835         assert_eq!(spend_txn.len(), 3);
5836         check_spends!(spend_txn[0], local_txn_1[0]);
5837         check_spends!(spend_txn[1], htlc_timeout);
5838         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5839 }
5840
5841 #[test]
5842 fn test_static_output_closing_tx() {
5843         let chanmon_cfgs = create_chanmon_cfgs(2);
5844         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5845         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5846         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5847
5848         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5849
5850         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5851         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5852
5853         mine_transaction(&nodes[0], &closing_tx);
5854         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5855
5856         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5857         assert_eq!(spend_txn.len(), 1);
5858         check_spends!(spend_txn[0], closing_tx);
5859
5860         mine_transaction(&nodes[1], &closing_tx);
5861         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5862
5863         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5864         assert_eq!(spend_txn.len(), 1);
5865         check_spends!(spend_txn[0], closing_tx);
5866 }
5867
5868 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5869         let chanmon_cfgs = create_chanmon_cfgs(2);
5870         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5871         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5872         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5873         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5874
5875         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5876
5877         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5878         // present in B's local commitment transaction, but none of A's commitment transactions.
5879         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5880         check_added_monitors!(nodes[1], 1);
5881
5882         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5883         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5884         let events = nodes[0].node.get_and_clear_pending_events();
5885         assert_eq!(events.len(), 1);
5886         match events[0] {
5887                 Event::PaymentSent { payment_preimage } => {
5888                         assert_eq!(payment_preimage, our_payment_preimage);
5889                 },
5890                 _ => panic!("Unexpected event"),
5891         }
5892
5893         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5894         check_added_monitors!(nodes[0], 1);
5895         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5896         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5897         check_added_monitors!(nodes[1], 1);
5898
5899         let starting_block = nodes[1].best_block_info();
5900         let mut block = Block {
5901                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5902                 txdata: vec![],
5903         };
5904         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5905                 connect_block(&nodes[1], &block);
5906                 block.header.prev_blockhash = block.block_hash();
5907         }
5908         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5909         check_closed_broadcast!(nodes[1], true);
5910         check_added_monitors!(nodes[1], 1);
5911 }
5912
5913 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5914         let chanmon_cfgs = create_chanmon_cfgs(2);
5915         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5916         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5917         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5918         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5919         let logger = test_utils::TestLogger::new();
5920
5921         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5922         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5923         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(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5924         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5925         check_added_monitors!(nodes[0], 1);
5926
5927         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5928
5929         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5930         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5931         // to "time out" the HTLC.
5932
5933         let starting_block = nodes[1].best_block_info();
5934         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5935
5936         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5937                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5938                 header.prev_blockhash = header.block_hash();
5939         }
5940         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5941         check_closed_broadcast!(nodes[0], true);
5942         check_added_monitors!(nodes[0], 1);
5943 }
5944
5945 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5946         let chanmon_cfgs = create_chanmon_cfgs(3);
5947         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5948         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5949         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5950         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5951
5952         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5953         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5954         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5955         // actually revoked.
5956         let htlc_value = if use_dust { 50000 } else { 3000000 };
5957         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5958         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5959         expect_pending_htlcs_forwardable!(nodes[1]);
5960         check_added_monitors!(nodes[1], 1);
5961
5962         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5963         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5964         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5965         check_added_monitors!(nodes[0], 1);
5966         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5967         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5968         check_added_monitors!(nodes[1], 1);
5969         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5970         check_added_monitors!(nodes[1], 1);
5971         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5972
5973         if check_revoke_no_close {
5974                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5975                 check_added_monitors!(nodes[0], 1);
5976         }
5977
5978         let starting_block = nodes[1].best_block_info();
5979         let mut block = Block {
5980                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5981                 txdata: vec![],
5982         };
5983         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5984                 connect_block(&nodes[0], &block);
5985                 block.header.prev_blockhash = block.block_hash();
5986         }
5987         if !check_revoke_no_close {
5988                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5989                 check_closed_broadcast!(nodes[0], true);
5990                 check_added_monitors!(nodes[0], 1);
5991         } else {
5992                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5993         }
5994 }
5995
5996 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5997 // There are only a few cases to test here:
5998 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5999 //    broadcastable commitment transactions result in channel closure,
6000 //  * its included in an unrevoked-but-previous remote commitment transaction,
6001 //  * its included in the latest remote or local commitment transactions.
6002 // We test each of the three possible commitment transactions individually and use both dust and
6003 // non-dust HTLCs.
6004 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6005 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6006 // tested for at least one of the cases in other tests.
6007 #[test]
6008 fn htlc_claim_single_commitment_only_a() {
6009         do_htlc_claim_local_commitment_only(true);
6010         do_htlc_claim_local_commitment_only(false);
6011
6012         do_htlc_claim_current_remote_commitment_only(true);
6013         do_htlc_claim_current_remote_commitment_only(false);
6014 }
6015
6016 #[test]
6017 fn htlc_claim_single_commitment_only_b() {
6018         do_htlc_claim_previous_remote_commitment_only(true, false);
6019         do_htlc_claim_previous_remote_commitment_only(false, false);
6020         do_htlc_claim_previous_remote_commitment_only(true, true);
6021         do_htlc_claim_previous_remote_commitment_only(false, true);
6022 }
6023
6024 #[test]
6025 #[should_panic]
6026 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6027         let chanmon_cfgs = create_chanmon_cfgs(2);
6028         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6029         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6030         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6031         //Force duplicate channel ids
6032         for node in nodes.iter() {
6033                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6034         }
6035
6036         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6037         let channel_value_satoshis=10000;
6038         let push_msat=10001;
6039         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6040         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6041         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6042
6043         //Create a second channel with a channel_id collision
6044         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6045 }
6046
6047 #[test]
6048 fn bolt2_open_channel_sending_node_checks_part2() {
6049         let chanmon_cfgs = create_chanmon_cfgs(2);
6050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6053
6054         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6055         let channel_value_satoshis=2^24;
6056         let push_msat=10001;
6057         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6058
6059         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6060         let channel_value_satoshis=10000;
6061         // Test when push_msat is equal to 1000 * funding_satoshis.
6062         let push_msat=1000*channel_value_satoshis+1;
6063         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6064
6065         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6066         let channel_value_satoshis=10000;
6067         let push_msat=10001;
6068         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
6069         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6070         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6071
6072         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6073         // 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
6074         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6075
6076         // 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.
6077         assert!(BREAKDOWN_TIMEOUT>0);
6078         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6079
6080         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6081         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6082         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6083
6084         // 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.
6085         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6086         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6087         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6088         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6089         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6090 }
6091
6092 #[test]
6093 fn bolt2_open_channel_sane_dust_limit() {
6094         let chanmon_cfgs = create_chanmon_cfgs(2);
6095         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6096         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6097         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6098
6099         let channel_value_satoshis=1000000;
6100         let push_msat=10001;
6101         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6102         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6103         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6104         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6105
6106         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6107         let events = nodes[1].node.get_and_clear_pending_msg_events();
6108         let err_msg = match events[0] {
6109                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6110                         msg.clone()
6111                 },
6112                 _ => panic!("Unexpected event"),
6113         };
6114         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6115 }
6116
6117 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6118 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6119 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6120 // is no longer affordable once it's freed.
6121 #[test]
6122 fn test_fail_holding_cell_htlc_upon_free() {
6123         let chanmon_cfgs = create_chanmon_cfgs(2);
6124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6127         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6128         let logger = test_utils::TestLogger::new();
6129
6130         // First nodes[0] generates an update_fee, setting the channel's
6131         // pending_update_fee.
6132         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6133         check_added_monitors!(nodes[0], 1);
6134
6135         let events = nodes[0].node.get_and_clear_pending_msg_events();
6136         assert_eq!(events.len(), 1);
6137         let (update_msg, commitment_signed) = match events[0] {
6138                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6139                         (update_fee.as_ref(), commitment_signed)
6140                 },
6141                 _ => panic!("Unexpected event"),
6142         };
6143
6144         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6145
6146         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6147         let channel_reserve = chan_stat.channel_reserve_msat;
6148         let feerate = get_feerate!(nodes[0], chan.2);
6149
6150         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6151         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6152         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6153         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6154         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(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6155
6156         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6157         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6158         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6159         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6160
6161         // Flush the pending fee update.
6162         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6163         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6164         check_added_monitors!(nodes[1], 1);
6165         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6166         check_added_monitors!(nodes[0], 1);
6167
6168         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6169         // HTLC, but now that the fee has been raised the payment will now fail, causing
6170         // us to surface its failure to the user.
6171         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6172         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6173         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6174         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6175         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6176
6177         // Check that the payment failed to be sent out.
6178         let events = nodes[0].node.get_and_clear_pending_events();
6179         assert_eq!(events.len(), 1);
6180         match &events[0] {
6181                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6182                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6183                         assert_eq!(*rejected_by_dest, false);
6184                         assert_eq!(*error_code, None);
6185                         assert_eq!(*error_data, None);
6186                 },
6187                 _ => panic!("Unexpected event"),
6188         }
6189 }
6190
6191 // Test that if multiple HTLCs are released from the holding cell and one is
6192 // valid but the other is no longer valid upon release, the valid HTLC can be
6193 // successfully completed while the other one fails as expected.
6194 #[test]
6195 fn test_free_and_fail_holding_cell_htlcs() {
6196         let chanmon_cfgs = create_chanmon_cfgs(2);
6197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6199         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6200         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6201         let logger = test_utils::TestLogger::new();
6202
6203         // First nodes[0] generates an update_fee, setting the channel's
6204         // pending_update_fee.
6205         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6206         check_added_monitors!(nodes[0], 1);
6207
6208         let events = nodes[0].node.get_and_clear_pending_msg_events();
6209         assert_eq!(events.len(), 1);
6210         let (update_msg, commitment_signed) = match events[0] {
6211                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6212                         (update_fee.as_ref(), commitment_signed)
6213                 },
6214                 _ => panic!("Unexpected event"),
6215         };
6216
6217         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6218
6219         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6220         let channel_reserve = chan_stat.channel_reserve_msat;
6221         let feerate = get_feerate!(nodes[0], chan.2);
6222
6223         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6224         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6225         let amt_1 = 20000;
6226         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6227         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6228         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6229         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(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6230         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(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6231
6232         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6233         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6234         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6235         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6236         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6237         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6238         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6239
6240         // Flush the pending fee update.
6241         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6242         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6243         check_added_monitors!(nodes[1], 1);
6244         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6245         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6246         check_added_monitors!(nodes[0], 2);
6247
6248         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6249         // but now that the fee has been raised the second payment will now fail, causing us
6250         // to surface its failure to the user. The first payment should succeed.
6251         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6252         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6253         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6254         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6255         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6256
6257         // Check that the second payment failed to be sent out.
6258         let events = nodes[0].node.get_and_clear_pending_events();
6259         assert_eq!(events.len(), 1);
6260         match &events[0] {
6261                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6262                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6263                         assert_eq!(*rejected_by_dest, false);
6264                         assert_eq!(*error_code, None);
6265                         assert_eq!(*error_data, None);
6266                 },
6267                 _ => panic!("Unexpected event"),
6268         }
6269
6270         // Complete the first payment and the RAA from the fee update.
6271         let (payment_event, send_raa_event) = {
6272                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6273                 assert_eq!(msgs.len(), 2);
6274                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6275         };
6276         let raa = match send_raa_event {
6277                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6278                 _ => panic!("Unexpected event"),
6279         };
6280         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6281         check_added_monitors!(nodes[1], 1);
6282         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6283         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6284         let events = nodes[1].node.get_and_clear_pending_events();
6285         assert_eq!(events.len(), 1);
6286         match events[0] {
6287                 Event::PendingHTLCsForwardable { .. } => {},
6288                 _ => panic!("Unexpected event"),
6289         }
6290         nodes[1].node.process_pending_htlc_forwards();
6291         let events = nodes[1].node.get_and_clear_pending_events();
6292         assert_eq!(events.len(), 1);
6293         match events[0] {
6294                 Event::PaymentReceived { .. } => {},
6295                 _ => panic!("Unexpected event"),
6296         }
6297         nodes[1].node.claim_funds(payment_preimage_1);
6298         check_added_monitors!(nodes[1], 1);
6299         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6300         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6301         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6302         let events = nodes[0].node.get_and_clear_pending_events();
6303         assert_eq!(events.len(), 1);
6304         match events[0] {
6305                 Event::PaymentSent { ref payment_preimage } => {
6306                         assert_eq!(*payment_preimage, payment_preimage_1);
6307                 }
6308                 _ => panic!("Unexpected event"),
6309         }
6310 }
6311
6312 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6313 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6314 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6315 // once it's freed.
6316 #[test]
6317 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6318         let chanmon_cfgs = create_chanmon_cfgs(3);
6319         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6320         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6321         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6322         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6323         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6324         let logger = test_utils::TestLogger::new();
6325
6326         // First nodes[1] generates an update_fee, setting the channel's
6327         // pending_update_fee.
6328         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6329         check_added_monitors!(nodes[1], 1);
6330
6331         let events = nodes[1].node.get_and_clear_pending_msg_events();
6332         assert_eq!(events.len(), 1);
6333         let (update_msg, commitment_signed) = match events[0] {
6334                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6335                         (update_fee.as_ref(), commitment_signed)
6336                 },
6337                 _ => panic!("Unexpected event"),
6338         };
6339
6340         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6341
6342         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6343         let channel_reserve = chan_stat.channel_reserve_msat;
6344         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6345
6346         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6347         let feemsat = 239;
6348         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6349         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6350         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6351         let payment_event = {
6352                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6353                 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(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6354                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6355                 check_added_monitors!(nodes[0], 1);
6356
6357                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6358                 assert_eq!(events.len(), 1);
6359
6360                 SendEvent::from_event(events.remove(0))
6361         };
6362         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6363         check_added_monitors!(nodes[1], 0);
6364         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6365         expect_pending_htlcs_forwardable!(nodes[1]);
6366
6367         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6368         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6369
6370         // Flush the pending fee update.
6371         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6372         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6373         check_added_monitors!(nodes[2], 1);
6374         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6375         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6376         check_added_monitors!(nodes[1], 2);
6377
6378         // A final RAA message is generated to finalize the fee update.
6379         let events = nodes[1].node.get_and_clear_pending_msg_events();
6380         assert_eq!(events.len(), 1);
6381
6382         let raa_msg = match &events[0] {
6383                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6384                         msg.clone()
6385                 },
6386                 _ => panic!("Unexpected event"),
6387         };
6388
6389         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6390         check_added_monitors!(nodes[2], 1);
6391         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6392
6393         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6394         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6395         assert_eq!(process_htlc_forwards_event.len(), 1);
6396         match &process_htlc_forwards_event[0] {
6397                 &Event::PendingHTLCsForwardable { .. } => {},
6398                 _ => panic!("Unexpected event"),
6399         }
6400
6401         // In response, we call ChannelManager's process_pending_htlc_forwards
6402         nodes[1].node.process_pending_htlc_forwards();
6403         check_added_monitors!(nodes[1], 1);
6404
6405         // This causes the HTLC to be failed backwards.
6406         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6407         assert_eq!(fail_event.len(), 1);
6408         let (fail_msg, commitment_signed) = match &fail_event[0] {
6409                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6410                         assert_eq!(updates.update_add_htlcs.len(), 0);
6411                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6412                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6413                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6414                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6415                 },
6416                 _ => panic!("Unexpected event"),
6417         };
6418
6419         // Pass the failure messages back to nodes[0].
6420         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6421         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6422
6423         // Complete the HTLC failure+removal process.
6424         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6425         check_added_monitors!(nodes[0], 1);
6426         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6427         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6428         check_added_monitors!(nodes[1], 2);
6429         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6430         assert_eq!(final_raa_event.len(), 1);
6431         let raa = match &final_raa_event[0] {
6432                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6433                 _ => panic!("Unexpected event"),
6434         };
6435         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6436         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6437         assert_eq!(fail_msg_event.len(), 1);
6438         match &fail_msg_event[0] {
6439                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6440                 _ => panic!("Unexpected event"),
6441         }
6442         let failure_event = nodes[0].node.get_and_clear_pending_events();
6443         assert_eq!(failure_event.len(), 1);
6444         match &failure_event[0] {
6445                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6446                         assert!(!rejected_by_dest);
6447                 },
6448                 _ => panic!("Unexpected event"),
6449         }
6450         check_added_monitors!(nodes[0], 1);
6451 }
6452
6453 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6454 // 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.
6455 //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.
6456
6457 #[test]
6458 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6459         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6460         let chanmon_cfgs = create_chanmon_cfgs(2);
6461         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6462         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6463         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6464         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6465
6466         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6467         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6468         let logger = test_utils::TestLogger::new();
6469         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6470         route.paths[0][0].fee_msat = 100;
6471
6472         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6473                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6474         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6475         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6476 }
6477
6478 #[test]
6479 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6480         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6481         let chanmon_cfgs = create_chanmon_cfgs(2);
6482         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6483         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6484         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6485         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6486         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6487
6488         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6489         let logger = test_utils::TestLogger::new();
6490         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6491         route.paths[0][0].fee_msat = 0;
6492         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6493                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6494
6495         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6496         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6497 }
6498
6499 #[test]
6500 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6501         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6502         let chanmon_cfgs = create_chanmon_cfgs(2);
6503         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6504         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6505         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6506         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6507
6508         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6509         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6510         let logger = test_utils::TestLogger::new();
6511         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(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6512         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6513         check_added_monitors!(nodes[0], 1);
6514         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6515         updates.update_add_htlcs[0].amount_msat = 0;
6516
6517         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6518         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6519         check_closed_broadcast!(nodes[1], true).unwrap();
6520         check_added_monitors!(nodes[1], 1);
6521 }
6522
6523 #[test]
6524 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6525         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6526         //It is enforced when constructing a route.
6527         let chanmon_cfgs = create_chanmon_cfgs(2);
6528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6530         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6531         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6532         let logger = test_utils::TestLogger::new();
6533
6534         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6535
6536         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6537         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(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6538         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6539                 assert_eq!(err, &"Channel CLTV overflowed?"));
6540 }
6541
6542 #[test]
6543 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6544         //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.
6545         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6546         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6547         let chanmon_cfgs = create_chanmon_cfgs(2);
6548         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6549         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6550         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6551         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6552         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6553
6554         let logger = test_utils::TestLogger::new();
6555         for i in 0..max_accepted_htlcs {
6556                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6557                 let payment_event = {
6558                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6559                         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(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6560                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6561                         check_added_monitors!(nodes[0], 1);
6562
6563                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6564                         assert_eq!(events.len(), 1);
6565                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6566                                 assert_eq!(htlcs[0].htlc_id, i);
6567                         } else {
6568                                 assert!(false);
6569                         }
6570                         SendEvent::from_event(events.remove(0))
6571                 };
6572                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6573                 check_added_monitors!(nodes[1], 0);
6574                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6575
6576                 expect_pending_htlcs_forwardable!(nodes[1]);
6577                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6578         }
6579         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6580         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6581         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(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6582         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6583                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6584
6585         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6586         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6587 }
6588
6589 #[test]
6590 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6591         //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.
6592         let chanmon_cfgs = create_chanmon_cfgs(2);
6593         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6594         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6595         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6596         let channel_value = 100000;
6597         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6598         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6599
6600         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6601
6602         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6603         // Manually create a route over our max in flight (which our router normally automatically
6604         // limits us to.
6605         let route = Route { paths: vec![vec![RouteHop {
6606            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6607            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6608            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6609         }]] };
6610         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6611                 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)));
6612
6613         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6614         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);
6615
6616         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6617 }
6618
6619 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6620 #[test]
6621 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6622         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6623         let chanmon_cfgs = create_chanmon_cfgs(2);
6624         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6625         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6626         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6627         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6628         let htlc_minimum_msat: u64;
6629         {
6630                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6631                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6632                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6633         }
6634
6635         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6636         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6637         let logger = test_utils::TestLogger::new();
6638         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(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6639         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6640         check_added_monitors!(nodes[0], 1);
6641         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6642         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6643         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6644         assert!(nodes[1].node.list_channels().is_empty());
6645         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6646         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()));
6647         check_added_monitors!(nodes[1], 1);
6648 }
6649
6650 #[test]
6651 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6652         //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
6653         let chanmon_cfgs = create_chanmon_cfgs(2);
6654         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6655         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6656         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6657         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6658         let logger = test_utils::TestLogger::new();
6659
6660         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6661         let channel_reserve = chan_stat.channel_reserve_msat;
6662         let feerate = get_feerate!(nodes[0], chan.2);
6663         // The 2* and +1 are for the fee spike reserve.
6664         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6665
6666         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6667         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6668         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6669         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(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6670         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6671         check_added_monitors!(nodes[0], 1);
6672         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6673
6674         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6675         // at this time channel-initiatee receivers are not required to enforce that senders
6676         // respect the fee_spike_reserve.
6677         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6678         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6679
6680         assert!(nodes[1].node.list_channels().is_empty());
6681         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6682         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6683         check_added_monitors!(nodes[1], 1);
6684 }
6685
6686 #[test]
6687 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6688         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6689         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6690         let chanmon_cfgs = create_chanmon_cfgs(2);
6691         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6692         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6693         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6694         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6695         let logger = test_utils::TestLogger::new();
6696
6697         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6698         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6699
6700         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6701         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(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6702
6703         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6704         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6705         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6706         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6707
6708         let mut msg = msgs::UpdateAddHTLC {
6709                 channel_id: chan.2,
6710                 htlc_id: 0,
6711                 amount_msat: 1000,
6712                 payment_hash: our_payment_hash,
6713                 cltv_expiry: htlc_cltv,
6714                 onion_routing_packet: onion_packet.clone(),
6715         };
6716
6717         for i in 0..super::channel::OUR_MAX_HTLCS {
6718                 msg.htlc_id = i as u64;
6719                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6720         }
6721         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6722         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6723
6724         assert!(nodes[1].node.list_channels().is_empty());
6725         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6726         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6727         check_added_monitors!(nodes[1], 1);
6728 }
6729
6730 #[test]
6731 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6732         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6733         let chanmon_cfgs = create_chanmon_cfgs(2);
6734         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6735         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6736         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6737         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6738         let logger = test_utils::TestLogger::new();
6739
6740         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6741         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6742         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6743         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6744         check_added_monitors!(nodes[0], 1);
6745         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6746         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6747         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6748
6749         assert!(nodes[1].node.list_channels().is_empty());
6750         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6751         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6752         check_added_monitors!(nodes[1], 1);
6753 }
6754
6755 #[test]
6756 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6757         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6758         let chanmon_cfgs = create_chanmon_cfgs(2);
6759         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6760         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6761         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6762         let logger = test_utils::TestLogger::new();
6763
6764         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6765         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6766         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6767         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6768         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6769         check_added_monitors!(nodes[0], 1);
6770         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6771         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6772         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6773
6774         assert!(nodes[1].node.list_channels().is_empty());
6775         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6776         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6777         check_added_monitors!(nodes[1], 1);
6778 }
6779
6780 #[test]
6781 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6782         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6783         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6784         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6785         let chanmon_cfgs = create_chanmon_cfgs(2);
6786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6788         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6789         let logger = test_utils::TestLogger::new();
6790
6791         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6792         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6793         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6794         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6795         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6796         check_added_monitors!(nodes[0], 1);
6797         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6798         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6799
6800         //Disconnect and Reconnect
6801         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6802         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6803         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6804         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6805         assert_eq!(reestablish_1.len(), 1);
6806         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6807         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6808         assert_eq!(reestablish_2.len(), 1);
6809         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6810         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6811         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6812         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6813
6814         //Resend HTLC
6815         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6816         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6817         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6818         check_added_monitors!(nodes[1], 1);
6819         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6820
6821         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6822
6823         assert!(nodes[1].node.list_channels().is_empty());
6824         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6825         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6826         check_added_monitors!(nodes[1], 1);
6827 }
6828
6829 #[test]
6830 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6831         //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.
6832
6833         let chanmon_cfgs = create_chanmon_cfgs(2);
6834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6836         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6837         let logger = test_utils::TestLogger::new();
6838         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6839         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6840         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6841         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6842         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6843
6844         check_added_monitors!(nodes[0], 1);
6845         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6846         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6847
6848         let update_msg = msgs::UpdateFulfillHTLC{
6849                 channel_id: chan.2,
6850                 htlc_id: 0,
6851                 payment_preimage: our_payment_preimage,
6852         };
6853
6854         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6855
6856         assert!(nodes[0].node.list_channels().is_empty());
6857         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6858         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()));
6859         check_added_monitors!(nodes[0], 1);
6860 }
6861
6862 #[test]
6863 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6864         //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.
6865
6866         let chanmon_cfgs = create_chanmon_cfgs(2);
6867         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6868         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6869         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6870         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6871         let logger = test_utils::TestLogger::new();
6872
6873         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6874         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6875         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6876         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6877         check_added_monitors!(nodes[0], 1);
6878         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6879         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6880
6881         let update_msg = msgs::UpdateFailHTLC{
6882                 channel_id: chan.2,
6883                 htlc_id: 0,
6884                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6885         };
6886
6887         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6888
6889         assert!(nodes[0].node.list_channels().is_empty());
6890         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6891         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()));
6892         check_added_monitors!(nodes[0], 1);
6893 }
6894
6895 #[test]
6896 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6897         //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.
6898
6899         let chanmon_cfgs = create_chanmon_cfgs(2);
6900         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6901         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6902         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6903         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6904         let logger = test_utils::TestLogger::new();
6905
6906         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6907         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
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(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6909         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6910         check_added_monitors!(nodes[0], 1);
6911         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6912         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6913         let update_msg = msgs::UpdateFailMalformedHTLC{
6914                 channel_id: chan.2,
6915                 htlc_id: 0,
6916                 sha256_of_onion: [1; 32],
6917                 failure_code: 0x8000,
6918         };
6919
6920         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6921
6922         assert!(nodes[0].node.list_channels().is_empty());
6923         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6924         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()));
6925         check_added_monitors!(nodes[0], 1);
6926 }
6927
6928 #[test]
6929 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6930         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6931
6932         let chanmon_cfgs = create_chanmon_cfgs(2);
6933         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6934         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6935         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6936         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6937
6938         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6939
6940         nodes[1].node.claim_funds(our_payment_preimage);
6941         check_added_monitors!(nodes[1], 1);
6942
6943         let events = nodes[1].node.get_and_clear_pending_msg_events();
6944         assert_eq!(events.len(), 1);
6945         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6946                 match events[0] {
6947                         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, .. } } => {
6948                                 assert!(update_add_htlcs.is_empty());
6949                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6950                                 assert!(update_fail_htlcs.is_empty());
6951                                 assert!(update_fail_malformed_htlcs.is_empty());
6952                                 assert!(update_fee.is_none());
6953                                 update_fulfill_htlcs[0].clone()
6954                         },
6955                         _ => panic!("Unexpected event"),
6956                 }
6957         };
6958
6959         update_fulfill_msg.htlc_id = 1;
6960
6961         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6962
6963         assert!(nodes[0].node.list_channels().is_empty());
6964         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6965         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6966         check_added_monitors!(nodes[0], 1);
6967 }
6968
6969 #[test]
6970 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6971         //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.
6972
6973         let chanmon_cfgs = create_chanmon_cfgs(2);
6974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6976         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6977         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6978
6979         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6980
6981         nodes[1].node.claim_funds(our_payment_preimage);
6982         check_added_monitors!(nodes[1], 1);
6983
6984         let events = nodes[1].node.get_and_clear_pending_msg_events();
6985         assert_eq!(events.len(), 1);
6986         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6987                 match events[0] {
6988                         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, .. } } => {
6989                                 assert!(update_add_htlcs.is_empty());
6990                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6991                                 assert!(update_fail_htlcs.is_empty());
6992                                 assert!(update_fail_malformed_htlcs.is_empty());
6993                                 assert!(update_fee.is_none());
6994                                 update_fulfill_htlcs[0].clone()
6995                         },
6996                         _ => panic!("Unexpected event"),
6997                 }
6998         };
6999
7000         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7001
7002         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7003
7004         assert!(nodes[0].node.list_channels().is_empty());
7005         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7006         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7007         check_added_monitors!(nodes[0], 1);
7008 }
7009
7010 #[test]
7011 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7012         //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.
7013
7014         let chanmon_cfgs = create_chanmon_cfgs(2);
7015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7017         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7018         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7019         let logger = test_utils::TestLogger::new();
7020
7021         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7022         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7023         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(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7024         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7025         check_added_monitors!(nodes[0], 1);
7026
7027         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7028         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7029
7030         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7031         check_added_monitors!(nodes[1], 0);
7032         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7033
7034         let events = nodes[1].node.get_and_clear_pending_msg_events();
7035
7036         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7037                 match events[0] {
7038                         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, .. } } => {
7039                                 assert!(update_add_htlcs.is_empty());
7040                                 assert!(update_fulfill_htlcs.is_empty());
7041                                 assert!(update_fail_htlcs.is_empty());
7042                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7043                                 assert!(update_fee.is_none());
7044                                 update_fail_malformed_htlcs[0].clone()
7045                         },
7046                         _ => panic!("Unexpected event"),
7047                 }
7048         };
7049         update_msg.failure_code &= !0x8000;
7050         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7051
7052         assert!(nodes[0].node.list_channels().is_empty());
7053         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7054         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7055         check_added_monitors!(nodes[0], 1);
7056 }
7057
7058 #[test]
7059 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7060         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7061         //    * 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.
7062
7063         let chanmon_cfgs = create_chanmon_cfgs(3);
7064         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7065         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7066         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7067         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7068         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7069         let logger = test_utils::TestLogger::new();
7070
7071         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7072
7073         //First hop
7074         let mut payment_event = {
7075                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7076                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7077                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7078                 check_added_monitors!(nodes[0], 1);
7079                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7080                 assert_eq!(events.len(), 1);
7081                 SendEvent::from_event(events.remove(0))
7082         };
7083         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7084         check_added_monitors!(nodes[1], 0);
7085         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7086         expect_pending_htlcs_forwardable!(nodes[1]);
7087         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7088         assert_eq!(events_2.len(), 1);
7089         check_added_monitors!(nodes[1], 1);
7090         payment_event = SendEvent::from_event(events_2.remove(0));
7091         assert_eq!(payment_event.msgs.len(), 1);
7092
7093         //Second Hop
7094         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7095         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7096         check_added_monitors!(nodes[2], 0);
7097         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7098
7099         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7100         assert_eq!(events_3.len(), 1);
7101         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7102                 match events_3[0] {
7103                         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 } } => {
7104                                 assert!(update_add_htlcs.is_empty());
7105                                 assert!(update_fulfill_htlcs.is_empty());
7106                                 assert!(update_fail_htlcs.is_empty());
7107                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7108                                 assert!(update_fee.is_none());
7109                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7110                         },
7111                         _ => panic!("Unexpected event"),
7112                 }
7113         };
7114
7115         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7116
7117         check_added_monitors!(nodes[1], 0);
7118         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7119         expect_pending_htlcs_forwardable!(nodes[1]);
7120         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7121         assert_eq!(events_4.len(), 1);
7122
7123         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7124         match events_4[0] {
7125                 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, .. } } => {
7126                         assert!(update_add_htlcs.is_empty());
7127                         assert!(update_fulfill_htlcs.is_empty());
7128                         assert_eq!(update_fail_htlcs.len(), 1);
7129                         assert!(update_fail_malformed_htlcs.is_empty());
7130                         assert!(update_fee.is_none());
7131                 },
7132                 _ => panic!("Unexpected event"),
7133         };
7134
7135         check_added_monitors!(nodes[1], 1);
7136 }
7137
7138 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7139         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7140         // 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
7141         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7142
7143         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7144         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7145         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7146         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7147         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7148         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7149
7150         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7151
7152         // We route 2 dust-HTLCs between A and B
7153         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7154         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7155         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7156
7157         // Cache one local commitment tx as previous
7158         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7159
7160         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7161         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7162         check_added_monitors!(nodes[1], 0);
7163         expect_pending_htlcs_forwardable!(nodes[1]);
7164         check_added_monitors!(nodes[1], 1);
7165
7166         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7167         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7168         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7169         check_added_monitors!(nodes[0], 1);
7170
7171         // Cache one local commitment tx as lastest
7172         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7173
7174         let events = nodes[0].node.get_and_clear_pending_msg_events();
7175         match events[0] {
7176                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7177                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7178                 },
7179                 _ => panic!("Unexpected event"),
7180         }
7181         match events[1] {
7182                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7183                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7184                 },
7185                 _ => panic!("Unexpected event"),
7186         }
7187
7188         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7189         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7190         if announce_latest {
7191                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7192         } else {
7193                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7194         }
7195
7196         check_closed_broadcast!(nodes[0], true);
7197         check_added_monitors!(nodes[0], 1);
7198
7199         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7200         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7201         let events = nodes[0].node.get_and_clear_pending_events();
7202         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7203         assert_eq!(events.len(), 2);
7204         let mut first_failed = false;
7205         for event in events {
7206                 match event {
7207                         Event::PaymentFailed { payment_hash, .. } => {
7208                                 if payment_hash == payment_hash_1 {
7209                                         assert!(!first_failed);
7210                                         first_failed = true;
7211                                 } else {
7212                                         assert_eq!(payment_hash, payment_hash_2);
7213                                 }
7214                         }
7215                         _ => panic!("Unexpected event"),
7216                 }
7217         }
7218 }
7219
7220 #[test]
7221 fn test_failure_delay_dust_htlc_local_commitment() {
7222         do_test_failure_delay_dust_htlc_local_commitment(true);
7223         do_test_failure_delay_dust_htlc_local_commitment(false);
7224 }
7225
7226 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7227         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7228         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7229         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7230         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7231         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7232         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7233
7234         let chanmon_cfgs = create_chanmon_cfgs(3);
7235         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7236         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7237         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7238         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7239
7240         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7241
7242         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7243         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7244
7245         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7246         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7247
7248         // We revoked bs_commitment_tx
7249         if revoked {
7250                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7251                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7252         }
7253
7254         let mut timeout_tx = Vec::new();
7255         if local {
7256                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7257                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7258                 check_closed_broadcast!(nodes[0], true);
7259                 check_added_monitors!(nodes[0], 1);
7260                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7261                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7262                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7263                 expect_payment_failed!(nodes[0], dust_hash, true);
7264                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7265                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7266                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7267                 mine_transaction(&nodes[0], &timeout_tx[0]);
7268                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7269                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7270         } else {
7271                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7272                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7273                 check_closed_broadcast!(nodes[0], true);
7274                 check_added_monitors!(nodes[0], 1);
7275                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7276                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7277                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7278                 if !revoked {
7279                         expect_payment_failed!(nodes[0], dust_hash, true);
7280                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7281                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7282                         mine_transaction(&nodes[0], &timeout_tx[0]);
7283                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7284                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7285                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7286                 } else {
7287                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7288                         // commitment tx
7289                         let events = nodes[0].node.get_and_clear_pending_events();
7290                         assert_eq!(events.len(), 2);
7291                         let first;
7292                         match events[0] {
7293                                 Event::PaymentFailed { payment_hash, .. } => {
7294                                         if payment_hash == dust_hash { first = true; }
7295                                         else { first = false; }
7296                                 },
7297                                 _ => panic!("Unexpected event"),
7298                         }
7299                         match events[1] {
7300                                 Event::PaymentFailed { payment_hash, .. } => {
7301                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7302                                         else { assert_eq!(payment_hash, dust_hash); }
7303                                 },
7304                                 _ => panic!("Unexpected event"),
7305                         }
7306                 }
7307         }
7308 }
7309
7310 #[test]
7311 fn test_sweep_outbound_htlc_failure_update() {
7312         do_test_sweep_outbound_htlc_failure_update(false, true);
7313         do_test_sweep_outbound_htlc_failure_update(false, false);
7314         do_test_sweep_outbound_htlc_failure_update(true, false);
7315 }
7316
7317 #[test]
7318 fn test_upfront_shutdown_script() {
7319         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7320         // enforce it at shutdown message
7321
7322         let mut config = UserConfig::default();
7323         config.channel_options.announced_channel = true;
7324         config.peer_channel_config_limits.force_announced_channel_preference = false;
7325         config.channel_options.commit_upfront_shutdown_pubkey = false;
7326         let user_cfgs = [None, Some(config), None];
7327         let chanmon_cfgs = create_chanmon_cfgs(3);
7328         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7329         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7330         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7331
7332         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7333         let flags = InitFeatures::known();
7334         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7335         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7336         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7337         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7338         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7339         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7340     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()));
7341         check_added_monitors!(nodes[2], 1);
7342
7343         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7344         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7345         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7346         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7347         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7348         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7349         let events = nodes[2].node.get_and_clear_pending_msg_events();
7350         assert_eq!(events.len(), 1);
7351         match events[0] {
7352                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7353                 _ => panic!("Unexpected event"),
7354         }
7355
7356         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7357         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7358         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7359         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7360         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7361         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7362         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7363         let events = nodes[1].node.get_and_clear_pending_msg_events();
7364         assert_eq!(events.len(), 1);
7365         match events[0] {
7366                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7367                 _ => panic!("Unexpected event"),
7368         }
7369
7370         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7371         // channel smoothly, opt-out is from channel initiator here
7372         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7373         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7374         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7375         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7376         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7377         let events = nodes[0].node.get_and_clear_pending_msg_events();
7378         assert_eq!(events.len(), 1);
7379         match events[0] {
7380                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7381                 _ => panic!("Unexpected event"),
7382         }
7383
7384         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7385         //// channel smoothly
7386         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7387         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7388         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7389         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7390         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7391         let events = nodes[0].node.get_and_clear_pending_msg_events();
7392         assert_eq!(events.len(), 2);
7393         match events[0] {
7394                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7395                 _ => panic!("Unexpected event"),
7396         }
7397         match events[1] {
7398                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7399                 _ => panic!("Unexpected event"),
7400         }
7401 }
7402
7403 #[test]
7404 fn test_upfront_shutdown_script_unsupport_segwit() {
7405         // We test that channel is closed early
7406         // if a segwit program is passed as upfront shutdown script,
7407         // but the peer does not support segwit.
7408         let chanmon_cfgs = create_chanmon_cfgs(2);
7409         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7410         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7411         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7412
7413         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7414
7415         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7416         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7417                 .push_slice(&[0, 0])
7418                 .into_script());
7419
7420         let features = InitFeatures::known().clear_shutdown_anysegwit();
7421         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7422
7423         let events = nodes[0].node.get_and_clear_pending_msg_events();
7424         assert_eq!(events.len(), 1);
7425         match events[0] {
7426                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7427                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7428                         assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7429                 },
7430                 _ => panic!("Unexpected event"),
7431         }
7432 }
7433
7434 #[test]
7435 fn test_shutdown_script_any_segwit_allowed() {
7436         let mut config = UserConfig::default();
7437         config.channel_options.announced_channel = true;
7438         config.peer_channel_config_limits.force_announced_channel_preference = false;
7439         config.channel_options.commit_upfront_shutdown_pubkey = false;
7440         let user_cfgs = [None, Some(config), None];
7441         let chanmon_cfgs = create_chanmon_cfgs(3);
7442         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7443         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7444         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7445
7446         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7447         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7448         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7449         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7450         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7451                 .push_slice(&[0, 0])
7452                 .into_script();
7453         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7454         let events = nodes[0].node.get_and_clear_pending_msg_events();
7455         assert_eq!(events.len(), 2);
7456         match events[0] {
7457                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7458                 _ => panic!("Unexpected event"),
7459         }
7460         match events[1] {
7461                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7462                 _ => panic!("Unexpected event"),
7463         }
7464 }
7465
7466 #[test]
7467 fn test_shutdown_script_any_segwit_not_allowed() {
7468         let mut config = UserConfig::default();
7469         config.channel_options.announced_channel = true;
7470         config.peer_channel_config_limits.force_announced_channel_preference = false;
7471         config.channel_options.commit_upfront_shutdown_pubkey = false;
7472         let user_cfgs = [None, Some(config), None];
7473         let chanmon_cfgs = create_chanmon_cfgs(3);
7474         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7475         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7476         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7477
7478         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7479         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7480         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7481         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7482         // Make an any segwit version script
7483         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7484                 .push_slice(&[0, 0])
7485                 .into_script();
7486         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7487         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7488         let events = nodes[0].node.get_and_clear_pending_msg_events();
7489         assert_eq!(events.len(), 2);
7490         match events[1] {
7491                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7492                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7493                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7494                 },
7495                 _ => panic!("Unexpected event"),
7496         }
7497         check_added_monitors!(nodes[0], 1);
7498 }
7499
7500 #[test]
7501 fn test_shutdown_script_segwit_but_not_anysegwit() {
7502         let mut config = UserConfig::default();
7503         config.channel_options.announced_channel = true;
7504         config.peer_channel_config_limits.force_announced_channel_preference = false;
7505         config.channel_options.commit_upfront_shutdown_pubkey = false;
7506         let user_cfgs = [None, Some(config), None];
7507         let chanmon_cfgs = create_chanmon_cfgs(3);
7508         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7509         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7510         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7511
7512         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7513         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7514         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7515         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7516         // Make a segwit script that is not a valid as any segwit
7517         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7518                 .push_slice(&[0, 0])
7519                 .into_script();
7520         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7521         let events = nodes[0].node.get_and_clear_pending_msg_events();
7522         assert_eq!(events.len(), 2);
7523         match events[1] {
7524                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7525                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7526                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7527                 },
7528                 _ => panic!("Unexpected event"),
7529         }
7530         check_added_monitors!(nodes[0], 1);
7531 }
7532
7533 #[test]
7534 fn test_user_configurable_csv_delay() {
7535         // We test our channel constructors yield errors when we pass them absurd csv delay
7536
7537         let mut low_our_to_self_config = UserConfig::default();
7538         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7539         let mut high_their_to_self_config = UserConfig::default();
7540         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7541         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7542         let chanmon_cfgs = create_chanmon_cfgs(2);
7543         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7544         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7545         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7546
7547         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7548         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7549                 match error {
7550                         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())); },
7551                         _ => panic!("Unexpected event"),
7552                 }
7553         } else { assert!(false) }
7554
7555         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7556         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7557         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7558         open_channel.to_self_delay = 200;
7559         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7560                 match error {
7561                         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()));  },
7562                         _ => panic!("Unexpected event"),
7563                 }
7564         } else { assert!(false); }
7565
7566         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7567         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7568         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()));
7569         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7570         accept_channel.to_self_delay = 200;
7571         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7572         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7573                 match action {
7574                         &ErrorAction::SendErrorMessage { ref msg } => {
7575                                 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()));
7576                         },
7577                         _ => { assert!(false); }
7578                 }
7579         } else { assert!(false); }
7580
7581         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7582         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7583         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7584         open_channel.to_self_delay = 200;
7585         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7586                 match error {
7587                         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())); },
7588                         _ => panic!("Unexpected event"),
7589                 }
7590         } else { assert!(false); }
7591 }
7592
7593 #[test]
7594 fn test_data_loss_protect() {
7595         // We want to be sure that :
7596         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7597         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7598         // * we close channel in case of detecting other being fallen behind
7599         // * we are able to claim our own outputs thanks to to_remote being static
7600         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7601         let persister;
7602         let logger;
7603         let fee_estimator;
7604         let tx_broadcaster;
7605         let chain_source;
7606         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7607         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7608         // during signing due to revoked tx
7609         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7610         let keys_manager = &chanmon_cfgs[0].keys_manager;
7611         let monitor;
7612         let node_state_0;
7613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7615         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7616
7617         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7618
7619         // Cache node A state before any channel update
7620         let previous_node_state = nodes[0].node.encode();
7621         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7622         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7623
7624         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7625         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7626
7627         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7628         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7629
7630         // Restore node A from previous state
7631         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7632         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7633         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7634         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7635         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7636         persister = test_utils::TestPersister::new();
7637         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7638         node_state_0 = {
7639                 let mut channel_monitors = HashMap::new();
7640                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7641                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7642                         keys_manager: keys_manager,
7643                         fee_estimator: &fee_estimator,
7644                         chain_monitor: &monitor,
7645                         logger: &logger,
7646                         tx_broadcaster: &tx_broadcaster,
7647                         default_config: UserConfig::default(),
7648                         channel_monitors,
7649                 }).unwrap().1
7650         };
7651         nodes[0].node = &node_state_0;
7652         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7653         nodes[0].chain_monitor = &monitor;
7654         nodes[0].chain_source = &chain_source;
7655
7656         check_added_monitors!(nodes[0], 1);
7657
7658         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7659         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7660
7661         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7662
7663         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7664         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7665         check_added_monitors!(nodes[0], 1);
7666
7667         {
7668                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7669                 assert_eq!(node_txn.len(), 0);
7670         }
7671
7672         let mut reestablish_1 = Vec::with_capacity(1);
7673         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7674                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7675                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7676                         reestablish_1.push(msg.clone());
7677                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7678                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7679                         match action {
7680                                 &ErrorAction::SendErrorMessage { ref msg } => {
7681                                         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");
7682                                 },
7683                                 _ => panic!("Unexpected event!"),
7684                         }
7685                 } else {
7686                         panic!("Unexpected event")
7687                 }
7688         }
7689
7690         // Check we close channel detecting A is fallen-behind
7691         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7692         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7693         check_added_monitors!(nodes[1], 1);
7694
7695
7696         // Check A is able to claim to_remote output
7697         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7698         assert_eq!(node_txn.len(), 1);
7699         check_spends!(node_txn[0], chan.3);
7700         assert_eq!(node_txn[0].output.len(), 2);
7701         mine_transaction(&nodes[0], &node_txn[0]);
7702         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7703         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7704         assert_eq!(spend_txn.len(), 1);
7705         check_spends!(spend_txn[0], node_txn[0]);
7706 }
7707
7708 #[test]
7709 fn test_check_htlc_underpaying() {
7710         // Send payment through A -> B but A is maliciously
7711         // sending a probe payment (i.e less than expected value0
7712         // to B, B should refuse payment.
7713
7714         let chanmon_cfgs = create_chanmon_cfgs(2);
7715         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7717         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7718
7719         // Create some initial channels
7720         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7721
7722         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7723         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7724         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7725         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7726         check_added_monitors!(nodes[0], 1);
7727
7728         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7729         assert_eq!(events.len(), 1);
7730         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7731         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7732         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7733
7734         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7735         // and then will wait a second random delay before failing the HTLC back:
7736         expect_pending_htlcs_forwardable!(nodes[1]);
7737         expect_pending_htlcs_forwardable!(nodes[1]);
7738
7739         // Node 3 is expecting payment of 100_000 but received 10_000,
7740         // it should fail htlc like we didn't know the preimage.
7741         nodes[1].node.process_pending_htlc_forwards();
7742
7743         let events = nodes[1].node.get_and_clear_pending_msg_events();
7744         assert_eq!(events.len(), 1);
7745         let (update_fail_htlc, commitment_signed) = match events[0] {
7746                 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 } } => {
7747                         assert!(update_add_htlcs.is_empty());
7748                         assert!(update_fulfill_htlcs.is_empty());
7749                         assert_eq!(update_fail_htlcs.len(), 1);
7750                         assert!(update_fail_malformed_htlcs.is_empty());
7751                         assert!(update_fee.is_none());
7752                         (update_fail_htlcs[0].clone(), commitment_signed)
7753                 },
7754                 _ => panic!("Unexpected event"),
7755         };
7756         check_added_monitors!(nodes[1], 1);
7757
7758         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7759         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7760
7761         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7762         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7763         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7764         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7765 }
7766
7767 #[test]
7768 fn test_announce_disable_channels() {
7769         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7770         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7771
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, &[None, None]);
7775         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7776
7777         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7778         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7779         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7780
7781         // Disconnect peers
7782         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7783         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7784
7785         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7786         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7787         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7788         assert_eq!(msg_events.len(), 3);
7789         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7790         for e in msg_events {
7791                 match e {
7792                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7793                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7794                                 // Check that each channel gets updated exactly once
7795                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7796                                         panic!("Generated ChannelUpdate for wrong chan!");
7797                                 }
7798                         },
7799                         _ => panic!("Unexpected event"),
7800                 }
7801         }
7802         // Reconnect peers
7803         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7804         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7805         assert_eq!(reestablish_1.len(), 3);
7806         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7807         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7808         assert_eq!(reestablish_2.len(), 3);
7809
7810         // Reestablish chan_1
7811         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7812         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7813         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7814         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7815         // Reestablish chan_2
7816         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7817         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7818         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7819         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7820         // Reestablish chan_3
7821         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7822         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7823         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7824         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7825
7826         nodes[0].node.timer_tick_occurred();
7827         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7828         nodes[0].node.timer_tick_occurred();
7829         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7830         assert_eq!(msg_events.len(), 3);
7831         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7832         for e in msg_events {
7833                 match e {
7834                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7835                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7836                                 // Check that each channel gets updated exactly once
7837                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7838                                         panic!("Generated ChannelUpdate for wrong chan!");
7839                                 }
7840                         },
7841                         _ => panic!("Unexpected event"),
7842                 }
7843         }
7844 }
7845
7846 #[test]
7847 fn test_bump_penalty_txn_on_revoked_commitment() {
7848         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7849         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7850
7851         let chanmon_cfgs = create_chanmon_cfgs(2);
7852         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7853         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7854         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7855
7856         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7857         let logger = test_utils::TestLogger::new();
7858
7859         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7860         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7861         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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7862         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7863
7864         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7865         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7866         assert_eq!(revoked_txn[0].output.len(), 4);
7867         assert_eq!(revoked_txn[0].input.len(), 1);
7868         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7869         let revoked_txid = revoked_txn[0].txid();
7870
7871         let mut penalty_sum = 0;
7872         for outp in revoked_txn[0].output.iter() {
7873                 if outp.script_pubkey.is_v0_p2wsh() {
7874                         penalty_sum += outp.value;
7875                 }
7876         }
7877
7878         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7879         let header_114 = connect_blocks(&nodes[1], 14);
7880
7881         // Actually revoke tx by claiming a HTLC
7882         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7883         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7884         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7885         check_added_monitors!(nodes[1], 1);
7886
7887         // One or more justice tx should have been broadcast, check it
7888         let penalty_1;
7889         let feerate_1;
7890         {
7891                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7892                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7893                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7894                 assert_eq!(node_txn[0].output.len(), 1);
7895                 check_spends!(node_txn[0], revoked_txn[0]);
7896                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7897                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7898                 penalty_1 = node_txn[0].txid();
7899                 node_txn.clear();
7900         };
7901
7902         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7903         connect_blocks(&nodes[1], 15);
7904         let mut penalty_2 = penalty_1;
7905         let mut feerate_2 = 0;
7906         {
7907                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7908                 assert_eq!(node_txn.len(), 1);
7909                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7910                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7911                         assert_eq!(node_txn[0].output.len(), 1);
7912                         check_spends!(node_txn[0], revoked_txn[0]);
7913                         penalty_2 = node_txn[0].txid();
7914                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7915                         assert_ne!(penalty_2, penalty_1);
7916                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7917                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7918                         // Verify 25% bump heuristic
7919                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7920                         node_txn.clear();
7921                 }
7922         }
7923         assert_ne!(feerate_2, 0);
7924
7925         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7926         connect_blocks(&nodes[1], 1);
7927         let penalty_3;
7928         let mut feerate_3 = 0;
7929         {
7930                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7931                 assert_eq!(node_txn.len(), 1);
7932                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7933                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7934                         assert_eq!(node_txn[0].output.len(), 1);
7935                         check_spends!(node_txn[0], revoked_txn[0]);
7936                         penalty_3 = node_txn[0].txid();
7937                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7938                         assert_ne!(penalty_3, penalty_2);
7939                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7940                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7941                         // Verify 25% bump heuristic
7942                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7943                         node_txn.clear();
7944                 }
7945         }
7946         assert_ne!(feerate_3, 0);
7947
7948         nodes[1].node.get_and_clear_pending_events();
7949         nodes[1].node.get_and_clear_pending_msg_events();
7950 }
7951
7952 #[test]
7953 fn test_bump_penalty_txn_on_revoked_htlcs() {
7954         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7955         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7956
7957         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7958         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7959         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7960         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7961         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7962
7963         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7964         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7965         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
7966                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7967         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7968         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
7969                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7970         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7971
7972         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7973         assert_eq!(revoked_local_txn[0].input.len(), 1);
7974         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7975
7976         // Revoke local commitment tx
7977         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7978
7979         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7980         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7981         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7982         check_closed_broadcast!(nodes[1], true);
7983         check_added_monitors!(nodes[1], 1);
7984
7985         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7986         assert_eq!(revoked_htlc_txn.len(), 4);
7987         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7988                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7989                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7990                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7991                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7992                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7993                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7994         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7995                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7996                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7997                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7998                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7999                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
8000                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8001         }
8002
8003         // Broadcast set of revoked txn on A
8004         let hash_128 = connect_blocks(&nodes[0], 40);
8005         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8006         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8007         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8008         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
8009         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8010         let first;
8011         let feerate_1;
8012         let penalty_txn;
8013         {
8014                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8015                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8016                 // Verify claim tx are spending revoked HTLC txn
8017
8018                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8019                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8020                 // which are included in the same block (they are broadcasted because we scan the
8021                 // transactions linearly and generate claims as we go, they likely should be removed in the
8022                 // future).
8023                 assert_eq!(node_txn[0].input.len(), 1);
8024                 check_spends!(node_txn[0], revoked_local_txn[0]);
8025                 assert_eq!(node_txn[1].input.len(), 1);
8026                 check_spends!(node_txn[1], revoked_local_txn[0]);
8027                 assert_eq!(node_txn[2].input.len(), 1);
8028                 check_spends!(node_txn[2], revoked_local_txn[0]);
8029
8030                 // Each of the three justice transactions claim a separate (single) output of the three
8031                 // available, which we check here:
8032                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8033                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8034                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8035
8036                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8037                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8038
8039                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8040                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8041                 // a remote commitment tx has already been confirmed).
8042                 check_spends!(node_txn[3], chan.3);
8043
8044                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8045                 // output, checked above).
8046                 assert_eq!(node_txn[4].input.len(), 2);
8047                 assert_eq!(node_txn[4].output.len(), 1);
8048                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8049
8050                 first = node_txn[4].txid();
8051                 // Store both feerates for later comparison
8052                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8053                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8054                 penalty_txn = vec![node_txn[2].clone()];
8055                 node_txn.clear();
8056         }
8057
8058         // Connect one more block to see if bumped penalty are issued for HTLC txn
8059         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8060         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8061         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8062         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8063         {
8064                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8065                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8066
8067                 check_spends!(node_txn[0], revoked_local_txn[0]);
8068                 check_spends!(node_txn[1], revoked_local_txn[0]);
8069                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8070                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8071                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8072                 } else {
8073                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
8074                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8075                 }
8076
8077                 node_txn.clear();
8078         };
8079
8080         // Few more blocks to confirm penalty txn
8081         connect_blocks(&nodes[0], 4);
8082         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8083         let header_144 = connect_blocks(&nodes[0], 9);
8084         let node_txn = {
8085                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8086                 assert_eq!(node_txn.len(), 1);
8087
8088                 assert_eq!(node_txn[0].input.len(), 2);
8089                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8090                 // Verify bumped tx is different and 25% bump heuristic
8091                 assert_ne!(first, node_txn[0].txid());
8092                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8093                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8094                 assert!(feerate_2 * 100 > feerate_1 * 125);
8095                 let txn = vec![node_txn[0].clone()];
8096                 node_txn.clear();
8097                 txn
8098         };
8099         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8100         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8101         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8102         connect_blocks(&nodes[0], 20);
8103         {
8104                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8105                 // We verify than no new transaction has been broadcast because previously
8106                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8107                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8108                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8109                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8110                 // up bumped justice generation.
8111                 assert_eq!(node_txn.len(), 0);
8112                 node_txn.clear();
8113         }
8114         check_closed_broadcast!(nodes[0], true);
8115         check_added_monitors!(nodes[0], 1);
8116 }
8117
8118 #[test]
8119 fn test_bump_penalty_txn_on_remote_commitment() {
8120         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8121         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8122
8123         // Create 2 HTLCs
8124         // Provide preimage for one
8125         // Check aggregation
8126
8127         let chanmon_cfgs = create_chanmon_cfgs(2);
8128         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8129         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8130         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8131
8132         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8133         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8134         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8135
8136         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8137         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8138         assert_eq!(remote_txn[0].output.len(), 4);
8139         assert_eq!(remote_txn[0].input.len(), 1);
8140         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8141
8142         // Claim a HTLC without revocation (provide B monitor with preimage)
8143         nodes[1].node.claim_funds(payment_preimage);
8144         mine_transaction(&nodes[1], &remote_txn[0]);
8145         check_added_monitors!(nodes[1], 2);
8146
8147         // One or more claim tx should have been broadcast, check it
8148         let timeout;
8149         let preimage;
8150         let feerate_timeout;
8151         let feerate_preimage;
8152         {
8153                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8154                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8155                 assert_eq!(node_txn[0].input.len(), 1);
8156                 assert_eq!(node_txn[1].input.len(), 1);
8157                 check_spends!(node_txn[0], remote_txn[0]);
8158                 check_spends!(node_txn[1], remote_txn[0]);
8159                 check_spends!(node_txn[2], chan.3);
8160                 check_spends!(node_txn[3], node_txn[2]);
8161                 check_spends!(node_txn[4], node_txn[2]);
8162                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8163                         timeout = node_txn[0].txid();
8164                         let index = node_txn[0].input[0].previous_output.vout;
8165                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8166                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8167
8168                         preimage = node_txn[1].txid();
8169                         let index = node_txn[1].input[0].previous_output.vout;
8170                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8171                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8172                 } else {
8173                         timeout = node_txn[1].txid();
8174                         let index = node_txn[1].input[0].previous_output.vout;
8175                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8176                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8177
8178                         preimage = node_txn[0].txid();
8179                         let index = node_txn[0].input[0].previous_output.vout;
8180                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8181                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8182                 }
8183                 node_txn.clear();
8184         };
8185         assert_ne!(feerate_timeout, 0);
8186         assert_ne!(feerate_preimage, 0);
8187
8188         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8189         connect_blocks(&nodes[1], 15);
8190         {
8191                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8192                 assert_eq!(node_txn.len(), 2);
8193                 assert_eq!(node_txn[0].input.len(), 1);
8194                 assert_eq!(node_txn[1].input.len(), 1);
8195                 check_spends!(node_txn[0], remote_txn[0]);
8196                 check_spends!(node_txn[1], remote_txn[0]);
8197                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8198                         let index = node_txn[0].input[0].previous_output.vout;
8199                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8200                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8201                         assert!(new_feerate * 100 > feerate_timeout * 125);
8202                         assert_ne!(timeout, node_txn[0].txid());
8203
8204                         let index = node_txn[1].input[0].previous_output.vout;
8205                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8206                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8207                         assert!(new_feerate * 100 > feerate_preimage * 125);
8208                         assert_ne!(preimage, node_txn[1].txid());
8209                 } else {
8210                         let index = node_txn[1].input[0].previous_output.vout;
8211                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8212                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8213                         assert!(new_feerate * 100 > feerate_timeout * 125);
8214                         assert_ne!(timeout, node_txn[1].txid());
8215
8216                         let index = node_txn[0].input[0].previous_output.vout;
8217                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8218                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8219                         assert!(new_feerate * 100 > feerate_preimage * 125);
8220                         assert_ne!(preimage, node_txn[0].txid());
8221                 }
8222                 node_txn.clear();
8223         }
8224
8225         nodes[1].node.get_and_clear_pending_events();
8226         nodes[1].node.get_and_clear_pending_msg_events();
8227 }
8228
8229 #[test]
8230 fn test_counterparty_raa_skip_no_crash() {
8231         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8232         // commitment transaction, we would have happily carried on and provided them the next
8233         // commitment transaction based on one RAA forward. This would probably eventually have led to
8234         // channel closure, but it would not have resulted in funds loss. Still, our
8235         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8236         // check simply that the channel is closed in response to such an RAA, but don't check whether
8237         // we decide to punish our counterparty for revoking their funds (as we don't currently
8238         // implement that).
8239         let chanmon_cfgs = create_chanmon_cfgs(2);
8240         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8241         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8242         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8243         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8244
8245         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8246         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8247         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8248         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8249         // Must revoke without gaps
8250         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8251         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8252                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8253
8254         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8255                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8256         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8257         check_added_monitors!(nodes[1], 1);
8258 }
8259
8260 #[test]
8261 fn test_bump_txn_sanitize_tracking_maps() {
8262         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8263         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8264
8265         let chanmon_cfgs = create_chanmon_cfgs(2);
8266         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8267         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8268         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8269
8270         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8271         // Lock HTLC in both directions
8272         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8273         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8274
8275         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8276         assert_eq!(revoked_local_txn[0].input.len(), 1);
8277         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8278
8279         // Revoke local commitment tx
8280         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8281
8282         // Broadcast set of revoked txn on A
8283         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8284         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8285         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8286
8287         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8288         check_closed_broadcast!(nodes[0], true);
8289         check_added_monitors!(nodes[0], 1);
8290         let penalty_txn = {
8291                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8292                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8293                 check_spends!(node_txn[0], revoked_local_txn[0]);
8294                 check_spends!(node_txn[1], revoked_local_txn[0]);
8295                 check_spends!(node_txn[2], revoked_local_txn[0]);
8296                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8297                 node_txn.clear();
8298                 penalty_txn
8299         };
8300         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8301         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8302         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8303         {
8304                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8305                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8306                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8307                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8308                 }
8309         }
8310 }
8311
8312 #[test]
8313 fn test_override_channel_config() {
8314         let chanmon_cfgs = create_chanmon_cfgs(2);
8315         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8316         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8317         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8318
8319         // Node0 initiates a channel to node1 using the override config.
8320         let mut override_config = UserConfig::default();
8321         override_config.own_channel_config.our_to_self_delay = 200;
8322
8323         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8324
8325         // Assert the channel created by node0 is using the override config.
8326         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8327         assert_eq!(res.channel_flags, 0);
8328         assert_eq!(res.to_self_delay, 200);
8329 }
8330
8331 #[test]
8332 fn test_override_0msat_htlc_minimum() {
8333         let mut zero_config = UserConfig::default();
8334         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8335         let chanmon_cfgs = create_chanmon_cfgs(2);
8336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8338         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8339
8340         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8341         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8342         assert_eq!(res.htlc_minimum_msat, 1);
8343
8344         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8345         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8346         assert_eq!(res.htlc_minimum_msat, 1);
8347 }
8348
8349 #[test]
8350 fn test_simple_mpp() {
8351         // Simple test of sending a multi-path payment.
8352         let chanmon_cfgs = create_chanmon_cfgs(4);
8353         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8354         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8355         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8356
8357         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8358         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8359         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8360         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8361         let logger = test_utils::TestLogger::new();
8362
8363         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8364         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8365         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(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8366         let path = route.paths[0].clone();
8367         route.paths.push(path);
8368         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8369         route.paths[0][0].short_channel_id = chan_1_id;
8370         route.paths[0][1].short_channel_id = chan_3_id;
8371         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8372         route.paths[1][0].short_channel_id = chan_2_id;
8373         route.paths[1][1].short_channel_id = chan_4_id;
8374         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8375         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8376 }
8377
8378 #[test]
8379 fn test_preimage_storage() {
8380         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8381         let chanmon_cfgs = create_chanmon_cfgs(2);
8382         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8383         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8384         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8385
8386         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8387
8388         {
8389                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8390
8391                 let logger = test_utils::TestLogger::new();
8392                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8393                 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(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8394                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8395                 check_added_monitors!(nodes[0], 1);
8396                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8397                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8398                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8399                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8400         }
8401         // Note that after leaving the above scope we have no knowledge of any arguments or return
8402         // values from previous calls.
8403         expect_pending_htlcs_forwardable!(nodes[1]);
8404         let events = nodes[1].node.get_and_clear_pending_events();
8405         assert_eq!(events.len(), 1);
8406         match events[0] {
8407                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8408                         assert_eq!(user_payment_id, 42);
8409                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8410                 },
8411                 _ => panic!("Unexpected event"),
8412         }
8413 }
8414
8415 #[test]
8416 fn test_secret_timeout() {
8417         // Simple test of payment secret storage time outs
8418         let chanmon_cfgs = create_chanmon_cfgs(2);
8419         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8420         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8421         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8422
8423         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8424
8425         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8426
8427         // We should fail to register the same payment hash twice, at least until we've connected a
8428         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8429         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8430                 assert_eq!(err, "Duplicate payment hash");
8431         } else { panic!(); }
8432         let mut block = Block {
8433                 header: BlockHeader {
8434                         version: 0x2000000,
8435                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8436                         merkle_root: Default::default(),
8437                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8438                 txdata: vec![],
8439         };
8440         connect_block(&nodes[1], &block);
8441         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8442                 assert_eq!(err, "Duplicate payment hash");
8443         } else { panic!(); }
8444
8445         // If we then connect the second block, we should be able to register the same payment hash
8446         // again with a different user_payment_id (this time getting a new payment secret).
8447         block.header.prev_blockhash = block.header.block_hash();
8448         block.header.time += 1;
8449         connect_block(&nodes[1], &block);
8450         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8451         assert_ne!(payment_secret_1, our_payment_secret);
8452
8453         {
8454                 let logger = test_utils::TestLogger::new();
8455                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8456                 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(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8457                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8458                 check_added_monitors!(nodes[0], 1);
8459                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8460                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8461                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8462                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8463         }
8464         // Note that after leaving the above scope we have no knowledge of any arguments or return
8465         // values from previous calls.
8466         expect_pending_htlcs_forwardable!(nodes[1]);
8467         let events = nodes[1].node.get_and_clear_pending_events();
8468         assert_eq!(events.len(), 1);
8469         match events[0] {
8470                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8471                         assert!(payment_preimage.is_none());
8472                         assert_eq!(user_payment_id, 42);
8473                         assert_eq!(payment_secret, our_payment_secret);
8474                         // We don't actually have the payment preimage with which to claim this payment!
8475                 },
8476                 _ => panic!("Unexpected event"),
8477         }
8478 }
8479
8480 #[test]
8481 fn test_bad_secret_hash() {
8482         // Simple test of unregistered payment hash/invalid payment secret handling
8483         let chanmon_cfgs = create_chanmon_cfgs(2);
8484         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8485         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8486         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8487
8488         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8489
8490         let random_payment_hash = PaymentHash([42; 32]);
8491         let random_payment_secret = PaymentSecret([43; 32]);
8492         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8493
8494         let logger = test_utils::TestLogger::new();
8495         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8496         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(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8497
8498         // All the below cases should end up being handled exactly identically, so we macro the
8499         // resulting events.
8500         macro_rules! handle_unknown_invalid_payment_data {
8501                 () => {
8502                         check_added_monitors!(nodes[0], 1);
8503                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8504                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8505                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8506                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8507
8508                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8509                         // again to process the pending backwards-failure of the HTLC
8510                         expect_pending_htlcs_forwardable!(nodes[1]);
8511                         expect_pending_htlcs_forwardable!(nodes[1]);
8512                         check_added_monitors!(nodes[1], 1);
8513
8514                         // We should fail the payment back
8515                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8516                         match events.pop().unwrap() {
8517                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8518                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8519                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8520                                 },
8521                                 _ => panic!("Unexpected event"),
8522                         }
8523                 }
8524         }
8525
8526         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8527         // Error data is the HTLC value (100,000) and current block height
8528         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8529
8530         // Send a payment with the right payment hash but the wrong payment secret
8531         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8532         handle_unknown_invalid_payment_data!();
8533         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8534
8535         // Send a payment with a random payment hash, but the right payment secret
8536         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8537         handle_unknown_invalid_payment_data!();
8538         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8539
8540         // Send a payment with a random payment hash and random payment secret
8541         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8542         handle_unknown_invalid_payment_data!();
8543         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8544 }
8545
8546 #[test]
8547 fn test_update_err_monitor_lockdown() {
8548         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8549         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8550         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8551         //
8552         // This scenario may happen in a watchtower setup, where watchtower process a block height
8553         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8554         // commitment at same time.
8555
8556         let chanmon_cfgs = create_chanmon_cfgs(2);
8557         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8558         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8559         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8560
8561         // Create some initial channel
8562         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8563         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8564
8565         // Rebalance the network to generate htlc in the two directions
8566         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8567
8568         // Route a HTLC from node 0 to node 1 (but don't settle)
8569         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8570
8571         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8572         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8573         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8574         let persister = test_utils::TestPersister::new();
8575         let watchtower = {
8576                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8577                 let monitor = monitors.get(&outpoint).unwrap();
8578                 let mut w = test_utils::TestVecWriter(Vec::new());
8579                 monitor.write(&mut w).unwrap();
8580                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8581                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8582                 assert!(new_monitor == *monitor);
8583                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8584                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8585                 watchtower
8586         };
8587         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8588         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8589
8590         // Try to update ChannelMonitor
8591         assert!(nodes[1].node.claim_funds(preimage));
8592         check_added_monitors!(nodes[1], 1);
8593         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8594         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8595         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8596         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8597                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8598                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8599                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8600                 } else { assert!(false); }
8601         } else { assert!(false); };
8602         // Our local monitor is in-sync and hasn't processed yet timeout
8603         check_added_monitors!(nodes[0], 1);
8604         let events = nodes[0].node.get_and_clear_pending_events();
8605         assert_eq!(events.len(), 1);
8606 }
8607
8608 #[test]
8609 fn test_concurrent_monitor_claim() {
8610         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8611         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8612         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8613         // state N+1 confirms. Alice claims output from state N+1.
8614
8615         let chanmon_cfgs = create_chanmon_cfgs(2);
8616         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8617         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8618         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8619
8620         // Create some initial channel
8621         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8622         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8623
8624         // Rebalance the network to generate htlc in the two directions
8625         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8626
8627         // Route a HTLC from node 0 to node 1 (but don't settle)
8628         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8629
8630         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8631         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8632         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8633         let persister = test_utils::TestPersister::new();
8634         let watchtower_alice = {
8635                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8636                 let monitor = monitors.get(&outpoint).unwrap();
8637                 let mut w = test_utils::TestVecWriter(Vec::new());
8638                 monitor.write(&mut w).unwrap();
8639                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8640                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8641                 assert!(new_monitor == *monitor);
8642                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8643                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8644                 watchtower
8645         };
8646         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8647         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8648
8649         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8650         {
8651                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8652                 assert_eq!(txn.len(), 2);
8653                 txn.clear();
8654         }
8655
8656         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8657         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8658         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8659         let persister = test_utils::TestPersister::new();
8660         let watchtower_bob = {
8661                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8662                 let monitor = monitors.get(&outpoint).unwrap();
8663                 let mut w = test_utils::TestVecWriter(Vec::new());
8664                 monitor.write(&mut w).unwrap();
8665                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8666                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8667                 assert!(new_monitor == *monitor);
8668                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8669                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8670                 watchtower
8671         };
8672         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8673         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8674
8675         // Route another payment to generate another update with still previous HTLC pending
8676         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8677         {
8678                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8679                 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(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8680                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8681         }
8682         check_added_monitors!(nodes[1], 1);
8683
8684         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8685         assert_eq!(updates.update_add_htlcs.len(), 1);
8686         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8687         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8688                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8689                         // Watchtower Alice should already have seen the block and reject the update
8690                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8691                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8692                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8693                 } else { assert!(false); }
8694         } else { assert!(false); };
8695         // Our local monitor is in-sync and hasn't processed yet timeout
8696         check_added_monitors!(nodes[0], 1);
8697
8698         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8699         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8700         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8701
8702         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8703         let bob_state_y;
8704         {
8705                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8706                 assert_eq!(txn.len(), 2);
8707                 bob_state_y = txn[0].clone();
8708                 txn.clear();
8709         };
8710
8711         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8712         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8713         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![bob_state_y.clone()] }, CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8714         {
8715                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8716                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8717                 // the onchain detection of the HTLC output
8718                 assert_eq!(htlc_txn.len(), 2);
8719                 check_spends!(htlc_txn[0], bob_state_y);
8720                 check_spends!(htlc_txn[1], bob_state_y);
8721         }
8722 }
8723
8724 #[test]
8725 fn test_pre_lockin_no_chan_closed_update() {
8726         // Test that if a peer closes a channel in response to a funding_created message we don't
8727         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8728         // message).
8729         //
8730         // Doing so would imply a channel monitor update before the initial channel monitor
8731         // registration, violating our API guarantees.
8732         //
8733         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8734         // then opening a second channel with the same funding output as the first (which is not
8735         // rejected because the first channel does not exist in the ChannelManager) and closing it
8736         // before receiving funding_signed.
8737         let chanmon_cfgs = create_chanmon_cfgs(2);
8738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8740         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8741
8742         // Create an initial channel
8743         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8744         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8745         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8746         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8747         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8748
8749         // Move the first channel through the funding flow...
8750         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8751
8752         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8753         check_added_monitors!(nodes[0], 0);
8754
8755         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8756         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8757         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8758         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8759 }
8760
8761 #[test]
8762 fn test_htlc_no_detection() {
8763         // This test is a mutation to underscore the detection logic bug we had
8764         // before #653. HTLC value routed is above the remaining balance, thus
8765         // inverting HTLC and `to_remote` output. HTLC will come second and
8766         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8767         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8768         // outputs order detection for correct spending children filtring.
8769
8770         let chanmon_cfgs = create_chanmon_cfgs(2);
8771         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8773         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8774
8775         // Create some initial channels
8776         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8777
8778         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8779         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8780         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8781         assert_eq!(local_txn[0].input.len(), 1);
8782         assert_eq!(local_txn[0].output.len(), 3);
8783         check_spends!(local_txn[0], chan_1.3);
8784
8785         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8786         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8787         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8788         // We deliberately connect the local tx twice as this should provoke a failure calling
8789         // this test before #653 fix.
8790         chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
8791         check_closed_broadcast!(nodes[0], true);
8792         check_added_monitors!(nodes[0], 1);
8793
8794         let htlc_timeout = {
8795                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8796                 assert_eq!(node_txn[0].input.len(), 1);
8797                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8798                 check_spends!(node_txn[0], local_txn[0]);
8799                 node_txn[0].clone()
8800         };
8801
8802         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8803         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8804         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8805         expect_payment_failed!(nodes[0], our_payment_hash, true);
8806 }
8807
8808 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8809         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8810         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8811         // Carol, Alice would be the upstream node, and Carol the downstream.)
8812         //
8813         // Steps of the test:
8814         // 1) Alice sends a HTLC to Carol through Bob.
8815         // 2) Carol doesn't settle the HTLC.
8816         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8817         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8818         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8819         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8820         // 5) Carol release the preimage to Bob off-chain.
8821         // 6) Bob claims the offered output on the broadcasted commitment.
8822         let chanmon_cfgs = create_chanmon_cfgs(3);
8823         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8824         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8825         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8826
8827         // Create some initial channels
8828         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8829         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8830
8831         // Steps (1) and (2):
8832         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8833         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8834
8835         // Check that Alice's commitment transaction now contains an output for this HTLC.
8836         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8837         check_spends!(alice_txn[0], chan_ab.3);
8838         assert_eq!(alice_txn[0].output.len(), 2);
8839         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8840         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8841         assert_eq!(alice_txn.len(), 2);
8842
8843         // Steps (3) and (4):
8844         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8845         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8846         let mut force_closing_node = 0; // Alice force-closes
8847         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8848         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8849         check_closed_broadcast!(nodes[force_closing_node], true);
8850         check_added_monitors!(nodes[force_closing_node], 1);
8851         if go_onchain_before_fulfill {
8852                 let txn_to_broadcast = match broadcast_alice {
8853                         true => alice_txn.clone(),
8854                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8855                 };
8856                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8857                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8858                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8859                 if broadcast_alice {
8860                         check_closed_broadcast!(nodes[1], true);
8861                         check_added_monitors!(nodes[1], 1);
8862                 }
8863                 assert_eq!(bob_txn.len(), 1);
8864                 check_spends!(bob_txn[0], chan_ab.3);
8865         }
8866
8867         // Step (5):
8868         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8869         // process of removing the HTLC from their commitment transactions.
8870         assert!(nodes[2].node.claim_funds(payment_preimage));
8871         check_added_monitors!(nodes[2], 1);
8872         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8873         assert!(carol_updates.update_add_htlcs.is_empty());
8874         assert!(carol_updates.update_fail_htlcs.is_empty());
8875         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8876         assert!(carol_updates.update_fee.is_none());
8877         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8878
8879         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8880         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8881         if !go_onchain_before_fulfill && broadcast_alice {
8882                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8883                 assert_eq!(events.len(), 1);
8884                 match events[0] {
8885                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8886                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8887                         },
8888                         _ => panic!("Unexpected event"),
8889                 };
8890         }
8891         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8892         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8893         // Carol<->Bob's updated commitment transaction info.
8894         check_added_monitors!(nodes[1], 2);
8895
8896         let events = nodes[1].node.get_and_clear_pending_msg_events();
8897         assert_eq!(events.len(), 2);
8898         let bob_revocation = match events[0] {
8899                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8900                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8901                         (*msg).clone()
8902                 },
8903                 _ => panic!("Unexpected event"),
8904         };
8905         let bob_updates = match events[1] {
8906                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8907                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8908                         (*updates).clone()
8909                 },
8910                 _ => panic!("Unexpected event"),
8911         };
8912
8913         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8914         check_added_monitors!(nodes[2], 1);
8915         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8916         check_added_monitors!(nodes[2], 1);
8917
8918         let events = nodes[2].node.get_and_clear_pending_msg_events();
8919         assert_eq!(events.len(), 1);
8920         let carol_revocation = match events[0] {
8921                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8922                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8923                         (*msg).clone()
8924                 },
8925                 _ => panic!("Unexpected event"),
8926         };
8927         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8928         check_added_monitors!(nodes[1], 1);
8929
8930         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8931         // here's where we put said channel's commitment tx on-chain.
8932         let mut txn_to_broadcast = alice_txn.clone();
8933         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8934         if !go_onchain_before_fulfill {
8935                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8936                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8937                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8938                 if broadcast_alice {
8939                         check_closed_broadcast!(nodes[1], true);
8940                         check_added_monitors!(nodes[1], 1);
8941                 }
8942                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8943                 if broadcast_alice {
8944                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8945                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8946                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8947                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8948                         // broadcasted.
8949                         assert_eq!(bob_txn.len(), 3);
8950                         check_spends!(bob_txn[1], chan_ab.3);
8951                 } else {
8952                         assert_eq!(bob_txn.len(), 2);
8953                         check_spends!(bob_txn[0], chan_ab.3);
8954                 }
8955         }
8956
8957         // Step (6):
8958         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8959         // broadcasted commitment transaction.
8960         {
8961                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8962                 if go_onchain_before_fulfill {
8963                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8964                         assert_eq!(bob_txn.len(), 2);
8965                 }
8966                 let script_weight = match broadcast_alice {
8967                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8968                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8969                 };
8970                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8971                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8972                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8973                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8974                 if broadcast_alice && !go_onchain_before_fulfill {
8975                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8976                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8977                 } else {
8978                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8979                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8980                 }
8981         }
8982 }
8983
8984 #[test]
8985 fn test_onchain_htlc_settlement_after_close() {
8986         do_test_onchain_htlc_settlement_after_close(true, true);
8987         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8988         do_test_onchain_htlc_settlement_after_close(true, false);
8989         do_test_onchain_htlc_settlement_after_close(false, false);
8990 }
8991
8992 #[test]
8993 fn test_duplicate_chan_id() {
8994         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8995         // already open we reject it and keep the old channel.
8996         //
8997         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8998         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8999         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9000         // updating logic for the existing channel.
9001         let chanmon_cfgs = create_chanmon_cfgs(2);
9002         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9003         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9004         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9005
9006         // Create an initial channel
9007         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9008         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9009         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9010         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9011
9012         // Try to create a second channel with the same temporary_channel_id as the first and check
9013         // that it is rejected.
9014         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9015         {
9016                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9017                 assert_eq!(events.len(), 1);
9018                 match events[0] {
9019                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9020                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9021                                 // first (valid) and second (invalid) channels are closed, given they both have
9022                                 // the same non-temporary channel_id. However, currently we do not, so we just
9023                                 // move forward with it.
9024                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9025                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9026                         },
9027                         _ => panic!("Unexpected event"),
9028                 }
9029         }
9030
9031         // Move the first channel through the funding flow...
9032         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9033
9034         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9035         check_added_monitors!(nodes[0], 0);
9036
9037         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9038         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9039         {
9040                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9041                 assert_eq!(added_monitors.len(), 1);
9042                 assert_eq!(added_monitors[0].0, funding_output);
9043                 added_monitors.clear();
9044         }
9045         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9046
9047         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9048         let channel_id = funding_outpoint.to_channel_id();
9049
9050         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9051         // temporary one).
9052
9053         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9054         // Technically this is allowed by the spec, but we don't support it and there's little reason
9055         // to. Still, it shouldn't cause any other issues.
9056         open_chan_msg.temporary_channel_id = channel_id;
9057         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9058         {
9059                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9060                 assert_eq!(events.len(), 1);
9061                 match events[0] {
9062                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9063                                 // Technically, at this point, nodes[1] would be justified in thinking both
9064                                 // channels are closed, but currently we do not, so we just move forward with it.
9065                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9066                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9067                         },
9068                         _ => panic!("Unexpected event"),
9069                 }
9070         }
9071
9072         // Now try to create a second channel which has a duplicate funding output.
9073         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9074         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9075         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9076         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9077         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9078
9079         let funding_created = {
9080                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9081                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9082                 let logger = test_utils::TestLogger::new();
9083                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9084         };
9085         check_added_monitors!(nodes[0], 0);
9086         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9087         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9088         // still needs to be cleared here.
9089         check_added_monitors!(nodes[1], 1);
9090
9091         // ...still, nodes[1] will reject the duplicate channel.
9092         {
9093                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9094                 assert_eq!(events.len(), 1);
9095                 match events[0] {
9096                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9097                                 // Technically, at this point, nodes[1] would be justified in thinking both
9098                                 // channels are closed, but currently we do not, so we just move forward with it.
9099                                 assert_eq!(msg.channel_id, channel_id);
9100                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9101                         },
9102                         _ => panic!("Unexpected event"),
9103                 }
9104         }
9105
9106         // finally, finish creating the original channel and send a payment over it to make sure
9107         // everything is functional.
9108         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9109         {
9110                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9111                 assert_eq!(added_monitors.len(), 1);
9112                 assert_eq!(added_monitors[0].0, funding_output);
9113                 added_monitors.clear();
9114         }
9115
9116         let events_4 = nodes[0].node.get_and_clear_pending_events();
9117         assert_eq!(events_4.len(), 0);
9118         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9119         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9120
9121         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9122         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9123         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9124         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9125 }
9126
9127 #[test]
9128 fn test_error_chans_closed() {
9129         // Test that we properly handle error messages, closing appropriate channels.
9130         //
9131         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9132         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9133         // we can test various edge cases around it to ensure we don't regress.
9134         let chanmon_cfgs = create_chanmon_cfgs(3);
9135         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9136         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9137         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9138
9139         // Create some initial channels
9140         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9141         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9142         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9143
9144         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9145         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9146         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9147
9148         // Closing a channel from a different peer has no effect
9149         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9150         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9151
9152         // Closing one channel doesn't impact others
9153         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9154         check_added_monitors!(nodes[0], 1);
9155         check_closed_broadcast!(nodes[0], false);
9156         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9157         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9158         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_1.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_1.2);
9159         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_3.2);
9160
9161         // A null channel ID should close all channels
9162         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9163         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9164         check_added_monitors!(nodes[0], 2);
9165         let events = nodes[0].node.get_and_clear_pending_msg_events();
9166         assert_eq!(events.len(), 2);
9167         match events[0] {
9168                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9169                         assert_eq!(msg.contents.flags & 2, 2);
9170                 },
9171                 _ => panic!("Unexpected event"),
9172         }
9173         match events[1] {
9174                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9175                         assert_eq!(msg.contents.flags & 2, 2);
9176                 },
9177                 _ => panic!("Unexpected event"),
9178         }
9179         // Note that at this point users of a standard PeerHandler will end up calling
9180         // peer_disconnected with no_connection_possible set to false, duplicating the
9181         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9182         // users with their own peer handling logic. We duplicate the call here, however.
9183         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9184         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9185
9186         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9187         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9188         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9189 }
9190
9191 #[test]
9192 fn test_invalid_funding_tx() {
9193         // Test that we properly handle invalid funding transactions sent to us from a peer.
9194         //
9195         // Previously, all other major lightning implementations had failed to properly sanitize
9196         // funding transactions from their counterparties, leading to a multi-implementation critical
9197         // security vulnerability (though we always sanitized properly, we've previously had
9198         // un-released crashes in the sanitization process).
9199         let chanmon_cfgs = create_chanmon_cfgs(2);
9200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9202         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9203
9204         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9205         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()));
9206         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
9207
9208         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9209         for output in tx.output.iter_mut() {
9210                 // Make the confirmed funding transaction have a bogus script_pubkey
9211                 output.script_pubkey = bitcoin::Script::new();
9212         }
9213
9214         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9215         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
9216         check_added_monitors!(nodes[1], 1);
9217
9218         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
9219         check_added_monitors!(nodes[0], 1);
9220
9221         let events_1 = nodes[0].node.get_and_clear_pending_events();
9222         assert_eq!(events_1.len(), 0);
9223
9224         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9225         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9226         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9227
9228         confirm_transaction_at(&nodes[1], &tx, 1);
9229         check_added_monitors!(nodes[1], 1);
9230         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9231         assert_eq!(events_2.len(), 1);
9232         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9233                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9234                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9235                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9236                 } else { panic!(); }
9237         } else { panic!(); }
9238         assert_eq!(nodes[1].node.list_channels().len(), 0);
9239 }