_ 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::{Confirm, Listen, Watch};
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface::{KeysInterface, BaseSign};
  20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use routing::router::{Route, RouteHop, get_route};
  26 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  27 use ln::msgs;
  28 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  29 use util::enforcing_trait_impls::EnforcingSigner;
  30 use util::{byte_utils, test_utils};
  31 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
  32 use util::errors::APIError;
  33 use util::ser::{Writeable, ReadableArgs};
  34 use util::config::UserConfig;
  35
  36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  37 use bitcoin::hash_types::{Txid, BlockHash};
  38 use bitcoin::blockdata::block::{Block, BlockHeader};
  39 use bitcoin::blockdata::script::Builder;
  40 use bitcoin::blockdata::opcodes;
  41 use bitcoin::blockdata::constants::genesis_block;
  42 use bitcoin::network::constants::Network;
  43
  44 use bitcoin::hashes::sha256::Hash as Sha256;
  45 use bitcoin::hashes::Hash;
  46
  47 use bitcoin::secp256k1::{Secp256k1, Message};
  48 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  49
  50 use regex;
  51
  52 use prelude::*;
  53 use alloc::collections::BTreeSet;
  54 use core::default::Default;
  55 use std::sync::{Arc, Mutex};
  56
  57 use ln::functional_test_utils::*;
  58 use ln::chan_utils::CommitmentTransaction;
  59 use ln::msgs::OptionalField::Present;
  60
  61 #[test]
  62 fn test_insane_channel_opens() {
  63         // Stand up a network of 2 nodes
  64         let chanmon_cfgs = create_chanmon_cfgs(2);
  65         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  66         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  67         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  68
  69         // Instantiate channel parameters where we push the maximum msats given our
  70         // funding satoshis
  71         let channel_value_sat = 31337; // same as funding satoshis
  72         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  73         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  74
  75         // Have node0 initiate a channel to node1 with aforementioned parameters
  76         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  77
  78         // Extract the channel open message from node0 to node1
  79         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  80
  81         // Test helper that asserts we get the correct error string given a mutator
  82         // that supposedly makes the channel open message insane
  83         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  84                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  85                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  86                 assert_eq!(msg_events.len(), 1);
  87                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  88                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  89                         match action {
  90                                 &ErrorAction::SendErrorMessage { .. } => {
  91                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  92                                 },
  93                                 _ => panic!("unexpected event!"),
  94                         }
  95                 } else { assert!(false); }
  96         };
  97
  98         use ln::channel::MAX_FUNDING_SATOSHIS;
  99         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 100
 101         // Test all mutations that would make the channel open message insane
 102         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 });
 103
 104         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 105
 106         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 });
 107
 108         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 109
 110         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 });
 111
 112         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 });
 113
 114         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 });
 115
 116         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 117
 118         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 119 }
 120
 121 #[test]
 122 fn test_async_inbound_update_fee() {
 123         let chanmon_cfgs = create_chanmon_cfgs(2);
 124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 127         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 128         let logger = test_utils::TestLogger::new();
 129         let channel_id = chan.2;
 130
 131         // balancing
 132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 133
 134         // A                                        B
 135         // update_fee                            ->
 136         // send (1) commitment_signed            -.
 137         //                                       <- update_add_htlc/commitment_signed
 138         // send (2) RAA (awaiting remote revoke) -.
 139         // (1) commitment_signed is delivered    ->
 140         //                                       .- send (3) RAA (awaiting remote revoke)
 141         // (2) RAA is delivered                  ->
 142         //                                       .- send (4) commitment_signed
 143         //                                       <- (3) RAA is delivered
 144         // send (5) commitment_signed            -.
 145         //                                       <- (4) commitment_signed is delivered
 146         // send (6) RAA                          -.
 147         // (5) commitment_signed is delivered    ->
 148         //                                       <- RAA
 149         // (6) RAA is delivered                  ->
 150
 151         // First nodes[0] generates an update_fee
 152         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 153         check_added_monitors!(nodes[0], 1);
 154
 155         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 156         assert_eq!(events_0.len(), 1);
 157         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 158                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 159                         (update_fee.as_ref(), commitment_signed)
 160                 },
 161                 _ => panic!("Unexpected event"),
 162         };
 163
 164         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 165
 166         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 167         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 168         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 169         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();
 170         check_added_monitors!(nodes[1], 1);
 171
 172         let payment_event = {
 173                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 174                 assert_eq!(events_1.len(), 1);
 175                 SendEvent::from_event(events_1.remove(0))
 176         };
 177         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 178         assert_eq!(payment_event.msgs.len(), 1);
 179
 180         // ...now when the messages get delivered everyone should be happy
 181         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 182         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 183         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 184         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 185         check_added_monitors!(nodes[0], 1);
 186
 187         // deliver(1), generate (3):
 188         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 189         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 190         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 191         check_added_monitors!(nodes[1], 1);
 192
 193         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 194         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 195         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 196         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 199         assert!(bs_update.update_fee.is_none()); // (4)
 200         check_added_monitors!(nodes[1], 1);
 201
 202         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 203         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 204         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 205         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 208         assert!(as_update.update_fee.is_none()); // (5)
 209         check_added_monitors!(nodes[0], 1);
 210
 211         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 212         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 213         // only (6) so get_event_msg's assert(len == 1) passes
 214         check_added_monitors!(nodes[0], 1);
 215
 216         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 217         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 218         check_added_monitors!(nodes[1], 1);
 219
 220         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 221         check_added_monitors!(nodes[0], 1);
 222
 223         let events_2 = nodes[0].node.get_and_clear_pending_events();
 224         assert_eq!(events_2.len(), 1);
 225         match events_2[0] {
 226                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 227                 _ => panic!("Unexpected event"),
 228         }
 229
 230         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 231         check_added_monitors!(nodes[1], 1);
 232 }
 233
 234 #[test]
 235 fn test_update_fee_unordered_raa() {
 236         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 237         // crash in an earlier version of the update_fee patch)
 238         let chanmon_cfgs = create_chanmon_cfgs(2);
 239         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 241         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 242         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 243         let channel_id = chan.2;
 244         let logger = test_utils::TestLogger::new();
 245
 246         // balancing
 247         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 248
 249         // First nodes[0] generates an update_fee
 250         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 251         check_added_monitors!(nodes[0], 1);
 252
 253         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 254         assert_eq!(events_0.len(), 1);
 255         let update_msg = match events_0[0] { // (1)
 256                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 257                         update_fee.as_ref()
 258                 },
 259                 _ => panic!("Unexpected event"),
 260         };
 261
 262         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 263
 264         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 265         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 266         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 267         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();
 268         check_added_monitors!(nodes[1], 1);
 269
 270         let payment_event = {
 271                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 272                 assert_eq!(events_1.len(), 1);
 273                 SendEvent::from_event(events_1.remove(0))
 274         };
 275         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 276         assert_eq!(payment_event.msgs.len(), 1);
 277
 278         // ...now when the messages get delivered everyone should be happy
 279         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 280         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 281         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 282         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 283         check_added_monitors!(nodes[0], 1);
 284
 285         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 286         check_added_monitors!(nodes[1], 1);
 287
 288         // We can't continue, sadly, because our (1) now has a bogus signature
 289 }
 290
 291 #[test]
 292 fn test_multi_flight_update_fee() {
 293         let chanmon_cfgs = create_chanmon_cfgs(2);
 294         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 295         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 296         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 297         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 298         let channel_id = chan.2;
 299
 300         // A                                        B
 301         // update_fee/commitment_signed          ->
 302         //                                       .- send (1) RAA and (2) commitment_signed
 303         // update_fee (never committed)          ->
 304         // (3) update_fee                        ->
 305         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 306         // don't track which updates correspond to which revoke_and_ack responses so we're in
 307         // AwaitingRAA mode and will not generate the update_fee yet.
 308         //                                       <- (1) RAA delivered
 309         // (3) is generated and send (4) CS      -.
 310         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 311         // know the per_commitment_point to use for it.
 312         //                                       <- (2) commitment_signed delivered
 313         // revoke_and_ack                        ->
 314         //                                          B should send no response here
 315         // (4) commitment_signed delivered       ->
 316         //                                       <- RAA/commitment_signed delivered
 317         // revoke_and_ack                        ->
 318
 319         // First nodes[0] generates an update_fee
 320         let initial_feerate = get_feerate!(nodes[0], channel_id);
 321         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 322         check_added_monitors!(nodes[0], 1);
 323
 324         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 325         assert_eq!(events_0.len(), 1);
 326         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 327                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 328                         (update_fee.as_ref().unwrap(), commitment_signed)
 329                 },
 330                 _ => panic!("Unexpected event"),
 331         };
 332
 333         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 334         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 335         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 336         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 337         check_added_monitors!(nodes[1], 1);
 338
 339         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 340         // transaction:
 341         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 342         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 343         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 344
 345         // Create the (3) update_fee message that nodes[0] will generate before it does...
 346         let mut update_msg_2 = msgs::UpdateFee {
 347                 channel_id: update_msg_1.channel_id.clone(),
 348                 feerate_per_kw: (initial_feerate + 30) as u32,
 349         };
 350
 351         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 352
 353         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 354         // Deliver (3)
 355         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 356
 357         // Deliver (1), generating (3) and (4)
 358         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 359         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 360         check_added_monitors!(nodes[0], 1);
 361         assert!(as_second_update.update_add_htlcs.is_empty());
 362         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 363         assert!(as_second_update.update_fail_htlcs.is_empty());
 364         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 365         // Check that the update_fee newly generated matches what we delivered:
 366         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 367         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 368
 369         // Deliver (2) commitment_signed
 370         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 371         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 372         check_added_monitors!(nodes[0], 1);
 373         // No commitment_signed so get_event_msg's assert(len == 1) passes
 374
 375         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 376         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 377         check_added_monitors!(nodes[1], 1);
 378
 379         // Delever (4)
 380         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 381         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 382         check_added_monitors!(nodes[1], 1);
 383
 384         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 385         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 386         check_added_monitors!(nodes[0], 1);
 387
 388         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 389         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 390         // No commitment_signed so get_event_msg's assert(len == 1) passes
 391         check_added_monitors!(nodes[0], 1);
 392
 393         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 394         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 395         check_added_monitors!(nodes[1], 1);
 396 }
 397
 398 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 399         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 400         // tests that we properly send one in that case.
 401         let mut alice_config = UserConfig::default();
 402         alice_config.own_channel_config.minimum_depth = 1;
 403         alice_config.channel_options.announced_channel = true;
 404         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 405         let mut bob_config = UserConfig::default();
 406         bob_config.own_channel_config.minimum_depth = 1;
 407         bob_config.channel_options.announced_channel = true;
 408         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 409         let chanmon_cfgs = create_chanmon_cfgs(2);
 410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 413         *nodes[0].connect_style.borrow_mut() = connect_style;
 414
 415         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 416         mine_transaction(&nodes[1], &tx);
 417         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()));
 418
 419         mine_transaction(&nodes[0], &tx);
 420         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 421         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 422
 423         for node in nodes {
 424                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 425                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 426                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 427         }
 428 }
 429 #[test]
 430 fn test_1_conf_open() {
 431         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 432         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 433         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 434 }
 435
 436 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 437         // Previously, we had issues deserializing channels when we hadn't connected the first block
 438         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 439         // serialization round-trips and simply do steps towards opening a channel and then drop the
 440         // Node objects.
 441
 442         let chanmon_cfgs = create_chanmon_cfgs(2);
 443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 444         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 445         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 446
 447         if steps & 0b1000_0000 != 0{
 448                 let block = Block {
 449                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 450                         txdata: vec![],
 451                 };
 452                 connect_block(&nodes[0], &block);
 453                 connect_block(&nodes[1], &block);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 0);
 495
 496         if steps & 0x0f == 6 { return; }
 497         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 498
 499         if steps & 0x0f == 7 { return; }
 500         confirm_transaction_at(&nodes[0], &tx, 2);
 501         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 502         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 503 }
 504
 505 #[test]
 506 fn test_sanity_on_in_flight_opens() {
 507         do_test_sanity_on_in_flight_opens(0);
 508         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(1);
 510         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(2);
 512         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(3);
 514         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(4);
 516         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(5);
 518         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(6);
 520         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(7);
 522         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(8);
 524         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 525 }
 526
 527 #[test]
 528 fn test_update_fee_vanilla() {
 529         let chanmon_cfgs = create_chanmon_cfgs(2);
 530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 533         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 534         let channel_id = chan.2;
 535
 536         let feerate = get_feerate!(nodes[0], channel_id);
 537         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 538         check_added_monitors!(nodes[0], 1);
 539
 540         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 541         assert_eq!(events_0.len(), 1);
 542         let (update_msg, commitment_signed) = match events_0[0] {
 543                         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 } } => {
 544                         (update_fee.as_ref(), commitment_signed)
 545                 },
 546                 _ => panic!("Unexpected event"),
 547         };
 548         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 549
 550         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 551         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 552         check_added_monitors!(nodes[1], 1);
 553
 554         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 555         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 556         check_added_monitors!(nodes[0], 1);
 557
 558         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 559         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 560         // No commitment_signed so get_event_msg's assert(len == 1) passes
 561         check_added_monitors!(nodes[0], 1);
 562
 563         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 564         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 565         check_added_monitors!(nodes[1], 1);
 566 }
 567
 568 #[test]
 569 fn test_update_fee_that_funder_cannot_afford() {
 570         let chanmon_cfgs = create_chanmon_cfgs(2);
 571         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 572         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 573         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 574         let channel_value = 1888;
 575         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 576         let channel_id = chan.2;
 577
 578         let feerate = 260;
 579         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 580         check_added_monitors!(nodes[0], 1);
 581         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 582
 583         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 584
 585         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 586
 587         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 588         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 589         {
 590                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 591
 592                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 593                 let num_htlcs = commitment_tx.output.len() - 2;
 594                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 595                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 596                 actual_fee = channel_value - actual_fee;
 597                 assert_eq!(total_fee, actual_fee);
 598         }
 599
 600         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 601         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 602         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 603         check_added_monitors!(nodes[0], 1);
 604
 605         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 606
 607         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 608
 609         //While producing the commitment_signed response after handling a received update_fee request the
 610         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 611         //Should produce and error.
 612         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 613         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 614         check_added_monitors!(nodes[1], 1);
 615         check_closed_broadcast!(nodes[1], true);
 616 }
 617
 618 #[test]
 619 fn test_update_fee_with_fundee_update_add_htlc() {
 620         let chanmon_cfgs = create_chanmon_cfgs(2);
 621         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 622         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 623         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 624         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 625         let channel_id = chan.2;
 626         let logger = test_utils::TestLogger::new();
 627
 628         // balancing
 629         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 630
 631         let feerate = get_feerate!(nodes[0], channel_id);
 632         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 633         check_added_monitors!(nodes[0], 1);
 634
 635         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 636         assert_eq!(events_0.len(), 1);
 637         let (update_msg, commitment_signed) = match events_0[0] {
 638                         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 } } => {
 639                         (update_fee.as_ref(), commitment_signed)
 640                 },
 641                 _ => panic!("Unexpected event"),
 642         };
 643         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 644         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 645         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 646         check_added_monitors!(nodes[1], 1);
 647
 648         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 649         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 650         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();
 651
 652         // nothing happens since node[1] is in AwaitingRemoteRevoke
 653         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 654         {
 655                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 656                 assert_eq!(added_monitors.len(), 0);
 657                 added_monitors.clear();
 658         }
 659         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 660         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 661         // node[1] has nothing to do
 662
 663         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 664         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 665         check_added_monitors!(nodes[0], 1);
 666
 667         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 668         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 669         // No commitment_signed so get_event_msg's assert(len == 1) passes
 670         check_added_monitors!(nodes[0], 1);
 671         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 672         check_added_monitors!(nodes[1], 1);
 673         // AwaitingRemoteRevoke ends here
 674
 675         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 676         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 677         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 678         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 679         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fee.is_none(), true);
 681
 682         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 683         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 684         check_added_monitors!(nodes[0], 1);
 685         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 686
 687         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 688         check_added_monitors!(nodes[1], 1);
 689         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 690
 691         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 692         check_added_monitors!(nodes[1], 1);
 693         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 694         // No commitment_signed so get_event_msg's assert(len == 1) passes
 695
 696         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 697         check_added_monitors!(nodes[0], 1);
 698         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 699
 700         expect_pending_htlcs_forwardable!(nodes[0]);
 701
 702         let events = nodes[0].node.get_and_clear_pending_events();
 703         assert_eq!(events.len(), 1);
 704         match events[0] {
 705                 Event::PaymentReceived { .. } => { },
 706                 _ => panic!("Unexpected event"),
 707         };
 708
 709         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 710
 711         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 712         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 713         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 714 }
 715
 716 #[test]
 717 fn test_update_fee() {
 718         let chanmon_cfgs = create_chanmon_cfgs(2);
 719         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 720         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 721         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 722         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 723         let channel_id = chan.2;
 724
 725         // A                                        B
 726         // (1) update_fee/commitment_signed      ->
 727         //                                       <- (2) revoke_and_ack
 728         //                                       .- send (3) commitment_signed
 729         // (4) update_fee/commitment_signed      ->
 730         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 731         //                                       <- (3) commitment_signed delivered
 732         // send (6) revoke_and_ack               -.
 733         //                                       <- (5) deliver revoke_and_ack
 734         // (6) deliver revoke_and_ack            ->
 735         //                                       .- send (7) commitment_signed in response to (4)
 736         //                                       <- (7) deliver commitment_signed
 737         // revoke_and_ack                        ->
 738
 739         // Create and deliver (1)...
 740         let feerate = get_feerate!(nodes[0], channel_id);
 741         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 742         check_added_monitors!(nodes[0], 1);
 743
 744         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 745         assert_eq!(events_0.len(), 1);
 746         let (update_msg, commitment_signed) = match events_0[0] {
 747                         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 } } => {
 748                         (update_fee.as_ref(), commitment_signed)
 749                 },
 750                 _ => panic!("Unexpected event"),
 751         };
 752         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 753
 754         // Generate (2) and (3):
 755         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 756         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 757         check_added_monitors!(nodes[1], 1);
 758
 759         // Deliver (2):
 760         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 761         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 762         check_added_monitors!(nodes[0], 1);
 763
 764         // Create and deliver (4)...
 765         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 766         check_added_monitors!(nodes[0], 1);
 767         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 768         assert_eq!(events_0.len(), 1);
 769         let (update_msg, commitment_signed) = match events_0[0] {
 770                         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 } } => {
 771                         (update_fee.as_ref(), commitment_signed)
 772                 },
 773                 _ => panic!("Unexpected event"),
 774         };
 775
 776         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 777         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 778         check_added_monitors!(nodes[1], 1);
 779         // ... creating (5)
 780         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 781         // No commitment_signed so get_event_msg's assert(len == 1) passes
 782
 783         // Handle (3), creating (6):
 784         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 785         check_added_monitors!(nodes[0], 1);
 786         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Deliver (5):
 790         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 791         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 792         check_added_monitors!(nodes[0], 1);
 793
 794         // Deliver (6), creating (7):
 795         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 796         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 797         assert!(commitment_update.update_add_htlcs.is_empty());
 798         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 799         assert!(commitment_update.update_fail_htlcs.is_empty());
 800         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 801         assert!(commitment_update.update_fee.is_none());
 802         check_added_monitors!(nodes[1], 1);
 803
 804         // Deliver (7)
 805         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 806         check_added_monitors!(nodes[0], 1);
 807         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 808         // No commitment_signed so get_event_msg's assert(len == 1) passes
 809
 810         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 811         check_added_monitors!(nodes[1], 1);
 812         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 813
 814         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 815         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 816         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 817 }
 818
 819 #[test]
 820 fn pre_funding_lock_shutdown_test() {
 821         // Test sending a shutdown prior to funding_locked after funding generation
 822         let chanmon_cfgs = create_chanmon_cfgs(2);
 823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 825         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 826         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 827         mine_transaction(&nodes[0], &tx);
 828         mine_transaction(&nodes[1], &tx);
 829
 830         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 831         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 832         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 833         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 834         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 835
 836         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 837         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 838         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 839         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 840         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 841         assert!(node_0_none.is_none());
 842
 843         assert!(nodes[0].node.list_channels().is_empty());
 844         assert!(nodes[1].node.list_channels().is_empty());
 845 }
 846
 847 #[test]
 848 fn updates_shutdown_wait() {
 849         // Test sending a shutdown with outstanding updates pending
 850         let chanmon_cfgs = create_chanmon_cfgs(3);
 851         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 852         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 853         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 854         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 855         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 856         let logger = test_utils::TestLogger::new();
 857
 858         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 859
 860         nodes[0].node.close_channel(&chan_1.2).unwrap();
 861         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 862         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 863         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 864         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 865
 866         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 867         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 868
 869         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 870
 871         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 872         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 873         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();
 874         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();
 875         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 876         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 877
 878         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 879         check_added_monitors!(nodes[2], 1);
 880         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 881         assert!(updates.update_add_htlcs.is_empty());
 882         assert!(updates.update_fail_htlcs.is_empty());
 883         assert!(updates.update_fail_malformed_htlcs.is_empty());
 884         assert!(updates.update_fee.is_none());
 885         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 886         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 887         check_added_monitors!(nodes[1], 1);
 888         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 889         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 890
 891         assert!(updates_2.update_add_htlcs.is_empty());
 892         assert!(updates_2.update_fail_htlcs.is_empty());
 893         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 894         assert!(updates_2.update_fee.is_none());
 895         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 896         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 897         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 898
 899         let events = nodes[0].node.get_and_clear_pending_events();
 900         assert_eq!(events.len(), 1);
 901         match events[0] {
 902                 Event::PaymentSent { ref payment_preimage } => {
 903                         assert_eq!(our_payment_preimage, *payment_preimage);
 904                 },
 905                 _ => panic!("Unexpected event"),
 906         }
 907
 908         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 909         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 910         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 911         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 912         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 913         assert!(node_0_none.is_none());
 914
 915         assert!(nodes[0].node.list_channels().is_empty());
 916
 917         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 918         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 919         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 920         assert!(nodes[1].node.list_channels().is_empty());
 921         assert!(nodes[2].node.list_channels().is_empty());
 922 }
 923
 924 #[test]
 925 fn htlc_fail_async_shutdown() {
 926         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 927         let chanmon_cfgs = create_chanmon_cfgs(3);
 928         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 929         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 930         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 932         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 933         let logger = test_utils::TestLogger::new();
 934
 935         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 936         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 937         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();
 938         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 939         check_added_monitors!(nodes[0], 1);
 940         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 941         assert_eq!(updates.update_add_htlcs.len(), 1);
 942         assert!(updates.update_fulfill_htlcs.is_empty());
 943         assert!(updates.update_fail_htlcs.is_empty());
 944         assert!(updates.update_fail_malformed_htlcs.is_empty());
 945         assert!(updates.update_fee.is_none());
 946
 947         nodes[1].node.close_channel(&chan_1.2).unwrap();
 948         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 949         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 950         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 951
 952         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 953         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 954         check_added_monitors!(nodes[1], 1);
 955         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 956         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 957
 958         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 959         assert!(updates_2.update_add_htlcs.is_empty());
 960         assert!(updates_2.update_fulfill_htlcs.is_empty());
 961         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 962         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 963         assert!(updates_2.update_fee.is_none());
 964
 965         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 966         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 967
 968         expect_payment_failed!(nodes[0], our_payment_hash, false);
 969
 970         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 971         assert_eq!(msg_events.len(), 2);
 972         let node_0_closing_signed = match msg_events[0] {
 973                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 974                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 975                         (*msg).clone()
 976                 },
 977                 _ => panic!("Unexpected event"),
 978         };
 979         match msg_events[1] {
 980                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 981                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 982                 },
 983                 _ => panic!("Unexpected event"),
 984         }
 985
 986         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 987         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 988         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 989         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 990         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 991         assert!(node_0_none.is_none());
 992
 993         assert!(nodes[0].node.list_channels().is_empty());
 994
 995         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 996         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 997         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 998         assert!(nodes[1].node.list_channels().is_empty());
 999         assert!(nodes[2].node.list_channels().is_empty());
1000 }
1001
1002 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1003         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1004         // messages delivered prior to disconnect
1005         let chanmon_cfgs = create_chanmon_cfgs(3);
1006         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1007         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1008         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1009         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011
1012         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013
1014         nodes[1].node.close_channel(&chan_1.2).unwrap();
1015         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016         if recv_count > 0 {
1017                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1018                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019                 if recv_count > 1 {
1020                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1021                 }
1022         }
1023
1024         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1025         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026
1027         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1028         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1029         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1030         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031
1032         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1033         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1034         assert!(node_1_shutdown == node_1_2nd_shutdown);
1035
1036         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1037         let node_0_2nd_shutdown = if recv_count > 0 {
1038                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1039                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1040                 node_0_2nd_shutdown
1041         } else {
1042                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1043                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1044                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1045                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1046         };
1047         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1048
1049         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1051
1052         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1053         check_added_monitors!(nodes[2], 1);
1054         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1055         assert!(updates.update_add_htlcs.is_empty());
1056         assert!(updates.update_fail_htlcs.is_empty());
1057         assert!(updates.update_fail_malformed_htlcs.is_empty());
1058         assert!(updates.update_fee.is_none());
1059         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1060         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1061         check_added_monitors!(nodes[1], 1);
1062         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1063         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1064
1065         assert!(updates_2.update_add_htlcs.is_empty());
1066         assert!(updates_2.update_fail_htlcs.is_empty());
1067         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1068         assert!(updates_2.update_fee.is_none());
1069         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1070         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1071         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1072
1073         let events = nodes[0].node.get_and_clear_pending_events();
1074         assert_eq!(events.len(), 1);
1075         match events[0] {
1076                 Event::PaymentSent { ref payment_preimage } => {
1077                         assert_eq!(our_payment_preimage, *payment_preimage);
1078                 },
1079                 _ => panic!("Unexpected event"),
1080         }
1081
1082         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1083         if recv_count > 0 {
1084                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1085                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1086                 assert!(node_1_closing_signed.is_some());
1087         }
1088
1089         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1090         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1091
1092         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1094         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         if recv_count == 0 {
1096                 // If all closing_signeds weren't delivered we can just resume where we left off...
1097                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1098
1099                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1100                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1101                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1102
1103                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1104                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1105                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1106
1107                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1108                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1109
1110                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1111                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1112                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1113
1114                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1115                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1116                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1117                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1118                 assert!(node_0_none.is_none());
1119         } else {
1120                 // If one node, however, received + responded with an identical closing_signed we end
1121                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1122                 // There isn't really anything better we can do simply, but in the future we might
1123                 // explore storing a set of recently-closed channels that got disconnected during
1124                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1125                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1126                 // transaction.
1127                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1128
1129                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1130                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1131                 assert_eq!(msg_events.len(), 1);
1132                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1133                         match action {
1134                                 &ErrorAction::SendErrorMessage { ref msg } => {
1135                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1136                                         assert_eq!(msg.channel_id, chan_1.2);
1137                                 },
1138                                 _ => panic!("Unexpected event!"),
1139                         }
1140                 } else { panic!("Needed SendErrorMessage close"); }
1141
1142                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1143                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1144                 // closing_signed so we do it ourselves
1145                 check_closed_broadcast!(nodes[0], false);
1146                 check_added_monitors!(nodes[0], 1);
1147         }
1148
1149         assert!(nodes[0].node.list_channels().is_empty());
1150
1151         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1152         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1153         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1154         assert!(nodes[1].node.list_channels().is_empty());
1155         assert!(nodes[2].node.list_channels().is_empty());
1156 }
1157
1158 #[test]
1159 fn test_shutdown_rebroadcast() {
1160         do_test_shutdown_rebroadcast(0);
1161         do_test_shutdown_rebroadcast(1);
1162         do_test_shutdown_rebroadcast(2);
1163 }
1164
1165 #[test]
1166 fn fake_network_test() {
1167         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1168         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1169         let chanmon_cfgs = create_chanmon_cfgs(4);
1170         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1171         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1172         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1173
1174         // Create some initial channels
1175         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1176         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1177         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1178
1179         // Rebalance the network a bit by relaying one payment through all the channels...
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
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
1185         // Send some more payments
1186         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1187         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1188         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1189
1190         // Test failure packets
1191         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1192         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1193
1194         // Add a new channel that skips 3
1195         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1196
1197         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1198         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
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
1205         // Do some rebalance loop payments, simultaneously
1206         let mut hops = Vec::with_capacity(3);
1207         hops.push(RouteHop {
1208                 pubkey: nodes[2].node.get_our_node_id(),
1209                 node_features: NodeFeatures::empty(),
1210                 short_channel_id: chan_2.0.contents.short_channel_id,
1211                 channel_features: ChannelFeatures::empty(),
1212                 fee_msat: 0,
1213                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1214         });
1215         hops.push(RouteHop {
1216                 pubkey: nodes[3].node.get_our_node_id(),
1217                 node_features: NodeFeatures::empty(),
1218                 short_channel_id: chan_3.0.contents.short_channel_id,
1219                 channel_features: ChannelFeatures::empty(),
1220                 fee_msat: 0,
1221                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1222         });
1223         hops.push(RouteHop {
1224                 pubkey: nodes[1].node.get_our_node_id(),
1225                 node_features: NodeFeatures::known(),
1226                 short_channel_id: chan_4.0.contents.short_channel_id,
1227                 channel_features: ChannelFeatures::known(),
1228                 fee_msat: 1000000,
1229                 cltv_expiry_delta: TEST_FINAL_CLTV,
1230         });
1231         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;
1232         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;
1233         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1234
1235         let mut hops = Vec::with_capacity(3);
1236         hops.push(RouteHop {
1237                 pubkey: nodes[3].node.get_our_node_id(),
1238                 node_features: NodeFeatures::empty(),
1239                 short_channel_id: chan_4.0.contents.short_channel_id,
1240                 channel_features: ChannelFeatures::empty(),
1241                 fee_msat: 0,
1242                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1243         });
1244         hops.push(RouteHop {
1245                 pubkey: nodes[2].node.get_our_node_id(),
1246                 node_features: NodeFeatures::empty(),
1247                 short_channel_id: chan_3.0.contents.short_channel_id,
1248                 channel_features: ChannelFeatures::empty(),
1249                 fee_msat: 0,
1250                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1251         });
1252         hops.push(RouteHop {
1253                 pubkey: nodes[1].node.get_our_node_id(),
1254                 node_features: NodeFeatures::known(),
1255                 short_channel_id: chan_2.0.contents.short_channel_id,
1256                 channel_features: ChannelFeatures::known(),
1257                 fee_msat: 1000000,
1258                 cltv_expiry_delta: TEST_FINAL_CLTV,
1259         });
1260         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;
1261         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;
1262         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1263
1264         // Claim the rebalances...
1265         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1266         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1267
1268         // Add a duplicate new channel from 2 to 4
1269         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1270
1271         // Send some payments across both channels
1272         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1274         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275
1276
1277         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1278         let events = nodes[0].node.get_and_clear_pending_msg_events();
1279         assert_eq!(events.len(), 0);
1280         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);
1281
1282         //TODO: Test that routes work again here as we've been notified that the channel is full
1283
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1285         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1287
1288         // Close down the channels...
1289         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1290         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1291         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1292         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1293         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1294 }
1295
1296 #[test]
1297 fn holding_cell_htlc_counting() {
1298         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1299         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1300         // commitment dance rounds.
1301         let chanmon_cfgs = create_chanmon_cfgs(3);
1302         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1303         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1304         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1305         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1306         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1307         let logger = test_utils::TestLogger::new();
1308
1309         let mut payments = Vec::new();
1310         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1311                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1312                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1313                 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();
1314                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1315                 payments.push((payment_preimage, payment_hash));
1316         }
1317         check_added_monitors!(nodes[1], 1);
1318
1319         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1320         assert_eq!(events.len(), 1);
1321         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1322         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1323
1324         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1325         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1326         // another HTLC.
1327         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1328         {
1329                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1330                 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();
1331                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1332                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1333                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1334                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1335         }
1336
1337         // This should also be true if we try to forward a payment.
1338         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1339         {
1340                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1341                 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();
1342                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1343                 check_added_monitors!(nodes[0], 1);
1344         }
1345
1346         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1347         assert_eq!(events.len(), 1);
1348         let payment_event = SendEvent::from_event(events.pop().unwrap());
1349         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1350
1351         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1352         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1353         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1354         // fails), the second will process the resulting failure and fail the HTLC backward.
1355         expect_pending_htlcs_forwardable!(nodes[1]);
1356         expect_pending_htlcs_forwardable!(nodes[1]);
1357         check_added_monitors!(nodes[1], 1);
1358
1359         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1360         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1361         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1362
1363         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
1364         expect_payment_failed!(nodes[0], payment_hash_2, false);
1365
1366         // Now forward all the pending HTLCs and claim them back
1367         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1368         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1369         check_added_monitors!(nodes[2], 1);
1370
1371         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1372         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1373         check_added_monitors!(nodes[1], 1);
1374         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1375
1376         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1379
1380         for ref update in as_updates.update_add_htlcs.iter() {
1381                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1382         }
1383         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1384         check_added_monitors!(nodes[2], 1);
1385         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1386         check_added_monitors!(nodes[2], 1);
1387         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1388
1389         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1390         check_added_monitors!(nodes[1], 1);
1391         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1392         check_added_monitors!(nodes[1], 1);
1393         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1394
1395         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1396         check_added_monitors!(nodes[2], 1);
1397
1398         expect_pending_htlcs_forwardable!(nodes[2]);
1399
1400         let events = nodes[2].node.get_and_clear_pending_events();
1401         assert_eq!(events.len(), payments.len());
1402         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1403                 match event {
1404                         &Event::PaymentReceived { ref payment_hash, .. } => {
1405                                 assert_eq!(*payment_hash, *hash);
1406                         },
1407                         _ => panic!("Unexpected event"),
1408                 };
1409         }
1410
1411         for (preimage, _) in payments.drain(..) {
1412                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1413         }
1414
1415         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1416 }
1417
1418 #[test]
1419 fn duplicate_htlc_test() {
1420         // Test that we accept duplicate payment_hash HTLCs across the network and that
1421         // claiming/failing them are all separate and don't affect each other
1422         let chanmon_cfgs = create_chanmon_cfgs(6);
1423         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1424         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1425         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1426
1427         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1428         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1429         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1430         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1431         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1432         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1433
1434         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1435
1436         *nodes[0].network_payment_count.borrow_mut() -= 1;
1437         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1438
1439         *nodes[0].network_payment_count.borrow_mut() -= 1;
1440         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1441
1442         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1443         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1444         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1445 }
1446
1447 #[test]
1448 fn test_duplicate_htlc_different_direction_onchain() {
1449         // Test that ChannelMonitor doesn't generate 2 preimage txn
1450         // when we have 2 HTLCs with same preimage that go across a node
1451         // in opposite directions, even with the same payment secret.
1452         let chanmon_cfgs = create_chanmon_cfgs(2);
1453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1456
1457         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1458         let logger = test_utils::TestLogger::new();
1459
1460         // balancing
1461         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1462
1463         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1464
1465         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1466         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();
1467         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1468         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1469
1470         // Provide preimage to node 0 by claiming payment
1471         nodes[0].node.claim_funds(payment_preimage);
1472         check_added_monitors!(nodes[0], 1);
1473
1474         // Broadcast node 1 commitment txn
1475         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1476
1477         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1478         let mut has_both_htlcs = 0; // check htlcs match ones committed
1479         for outp in remote_txn[0].output.iter() {
1480                 if outp.value == 800_000 / 1000 {
1481                         has_both_htlcs += 1;
1482                 } else if outp.value == 900_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 }
1485         }
1486         assert_eq!(has_both_htlcs, 2);
1487
1488         mine_transaction(&nodes[0], &remote_txn[0]);
1489         check_added_monitors!(nodes[0], 1);
1490         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1491
1492         // Check we only broadcast 1 timeout tx
1493         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1494         assert_eq!(claim_txn.len(), 8);
1495         assert_eq!(claim_txn[1], claim_txn[4]);
1496         assert_eq!(claim_txn[2], claim_txn[5]);
1497         check_spends!(claim_txn[1], chan_1.3);
1498         check_spends!(claim_txn[2], claim_txn[1]);
1499         check_spends!(claim_txn[7], claim_txn[1]);
1500
1501         assert_eq!(claim_txn[0].input.len(), 1);
1502         assert_eq!(claim_txn[3].input.len(), 1);
1503         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1504
1505         assert_eq!(claim_txn[0].input.len(), 1);
1506         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1507         check_spends!(claim_txn[0], remote_txn[0]);
1508         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1509         assert_eq!(claim_txn[6].input.len(), 1);
1510         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1511         check_spends!(claim_txn[6], remote_txn[0]);
1512         assert_eq!(remote_txn[0].output[claim_txn[6].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(),
1690                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1691
1692         check_added_monitors!(nodes[1], 2);
1693 }
1694
1695 #[test]
1696 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1697         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1698         // Set the fee rate for the channel very high, to the point where the fundee
1699         // sending any above-dust amount would result in a channel reserve violation.
1700         // In this test we check that we would be prevented from sending an HTLC in
1701         // this situation.
1702         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1703         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1704         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1705         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1706         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1707         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1708
1709         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1710         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1711                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1712         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1713         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);
1714 }
1715
1716 #[test]
1717 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1718         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1719         // Set the fee rate for the channel very high, to the point where the funder
1720         // receiving 1 update_add_htlc would result in them closing the channel due
1721         // to channel reserve violation. This close could also happen if the fee went
1722         // up a more realistic amount, but many HTLCs were outstanding at the time of
1723         // the update_add_htlc.
1724         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1725         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1726         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1727         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1728         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1729         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1730
1731         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1732         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1733         let secp_ctx = Secp256k1::new();
1734         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1735         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1736         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1737         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1738         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1739         let msg = msgs::UpdateAddHTLC {
1740                 channel_id: chan.2,
1741                 htlc_id: 1,
1742                 amount_msat: htlc_msat + 1,
1743                 payment_hash: payment_hash,
1744                 cltv_expiry: htlc_cltv,
1745                 onion_routing_packet: onion_packet,
1746         };
1747
1748         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1749         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1750         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);
1751         assert_eq!(nodes[0].node.list_channels().len(), 0);
1752         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1753         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1754         check_added_monitors!(nodes[0], 1);
1755 }
1756
1757 #[test]
1758 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1759         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1760         // calculating our commitment transaction fee (this was previously broken).
1761         let chanmon_cfgs = create_chanmon_cfgs(2);
1762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1764         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1765
1766         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1767         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1768         // transaction fee with 0 HTLCs (183 sats)).
1769         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1770
1771         let dust_amt = 329000; // Dust amount
1772         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1773         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1774         // commitment transaction fee.
1775         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1776 }
1777
1778 #[test]
1779 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1780         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1781         // calculating our counterparty's commitment transaction fee (this was previously broken).
1782         let chanmon_cfgs = create_chanmon_cfgs(2);
1783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1787
1788         let payment_amt = 46000; // Dust amount
1789         // In the previous code, these first four payments would succeed.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794
1795         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
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         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801
1802         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1803         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1804         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1805         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1806 }
1807
1808 #[test]
1809 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1810         let chanmon_cfgs = create_chanmon_cfgs(3);
1811         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1812         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1813         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1814         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1815         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1816
1817         let feemsat = 239;
1818         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1819         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1820         let feerate = get_feerate!(nodes[0], chan.2);
1821
1822         // Add a 2* and +1 for the fee spike reserve.
1823         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1824         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;
1825         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1826
1827         // Add a pending HTLC.
1828         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1829         let payment_event_1 = {
1830                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1831                 check_added_monitors!(nodes[0], 1);
1832
1833                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1834                 assert_eq!(events.len(), 1);
1835                 SendEvent::from_event(events.remove(0))
1836         };
1837         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1838
1839         // Attempt to trigger a channel reserve violation --> payment failure.
1840         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1841         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;
1842         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1843         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1844
1845         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1846         let secp_ctx = Secp256k1::new();
1847         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1848         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1849         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1850         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1851         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1852         let msg = msgs::UpdateAddHTLC {
1853                 channel_id: chan.2,
1854                 htlc_id: 1,
1855                 amount_msat: htlc_msat + 1,
1856                 payment_hash: our_payment_hash_1,
1857                 cltv_expiry: htlc_cltv,
1858                 onion_routing_packet: onion_packet,
1859         };
1860
1861         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1862         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1863         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1864         assert_eq!(nodes[1].node.list_channels().len(), 1);
1865         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1866         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1867         check_added_monitors!(nodes[1], 1);
1868 }
1869
1870 #[test]
1871 fn test_inbound_outbound_capacity_is_not_zero() {
1872         let chanmon_cfgs = create_chanmon_cfgs(2);
1873         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1874         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1875         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1876         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1877         let channels0 = node_chanmgrs[0].list_channels();
1878         let channels1 = node_chanmgrs[1].list_channels();
1879         assert_eq!(channels0.len(), 1);
1880         assert_eq!(channels1.len(), 1);
1881
1882         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1883         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1884         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1885
1886         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1887         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1888 }
1889
1890 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1891         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1892 }
1893
1894 #[test]
1895 fn test_channel_reserve_holding_cell_htlcs() {
1896         let chanmon_cfgs = create_chanmon_cfgs(3);
1897         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1898         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1899         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1900         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1901         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1902
1903         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1904         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1905
1906         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1907         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1908
1909         macro_rules! expect_forward {
1910                 ($node: expr) => {{
1911                         let mut events = $node.node.get_and_clear_pending_msg_events();
1912                         assert_eq!(events.len(), 1);
1913                         check_added_monitors!($node, 1);
1914                         let payment_event = SendEvent::from_event(events.remove(0));
1915                         payment_event
1916                 }}
1917         }
1918
1919         let feemsat = 239; // somehow we know?
1920         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1921         let feerate = get_feerate!(nodes[0], chan_1.2);
1922
1923         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1924
1925         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1926         {
1927                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1928                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1929                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1930                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1931                         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)));
1932                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1933                 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);
1934         }
1935
1936         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1937         // nodes[0]'s wealth
1938         loop {
1939                 let amt_msat = recv_value_0 + total_fee_msat;
1940                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1941                 // Also, ensure that each payment has enough to be over the dust limit to
1942                 // ensure it'll be included in each commit tx fee calculation.
1943                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1944                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1945                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1946                         break;
1947                 }
1948                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1949
1950                 let (stat01_, stat11_, stat12_, stat22_) = (
1951                         get_channel_value_stat!(nodes[0], chan_1.2),
1952                         get_channel_value_stat!(nodes[1], chan_1.2),
1953                         get_channel_value_stat!(nodes[1], chan_2.2),
1954                         get_channel_value_stat!(nodes[2], chan_2.2),
1955                 );
1956
1957                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1958                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1959                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1960                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1961                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1962         }
1963
1964         // adding pending output.
1965         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1966         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1967         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1968         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1969         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1970         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1971         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1972         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1973         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1974         // policy.
1975         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1976         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1977         let amt_msat_1 = recv_value_1 + total_fee_msat;
1978
1979         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);
1980         let payment_event_1 = {
1981                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1982                 check_added_monitors!(nodes[0], 1);
1983
1984                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1985                 assert_eq!(events.len(), 1);
1986                 SendEvent::from_event(events.remove(0))
1987         };
1988         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1989
1990         // channel reserve test with htlc pending output > 0
1991         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1992         {
1993                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1994                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1995                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1996                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1997         }
1998
1999         // split the rest to test holding cell
2000         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2001         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2002         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2003         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2004         {
2005                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2006                 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);
2007         }
2008
2009         // now see if they go through on both sides
2010         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);
2011         // but this will stuck in the holding cell
2012         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2013         check_added_monitors!(nodes[0], 0);
2014         let events = nodes[0].node.get_and_clear_pending_events();
2015         assert_eq!(events.len(), 0);
2016
2017         // test with outbound holding cell amount > 0
2018         {
2019                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2020                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2021                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2022                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2023                 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);
2024         }
2025
2026         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);
2027         // this will also stuck in the holding cell
2028         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2029         check_added_monitors!(nodes[0], 0);
2030         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2031         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2032
2033         // flush the pending htlc
2034         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2035         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2036         check_added_monitors!(nodes[1], 1);
2037
2038         // the pending htlc should be promoted to committed
2039         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2040         check_added_monitors!(nodes[0], 1);
2041         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2042
2043         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2044         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2045         // No commitment_signed so get_event_msg's assert(len == 1) passes
2046         check_added_monitors!(nodes[0], 1);
2047
2048         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2049         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2050         check_added_monitors!(nodes[1], 1);
2051
2052         expect_pending_htlcs_forwardable!(nodes[1]);
2053
2054         let ref payment_event_11 = expect_forward!(nodes[1]);
2055         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2056         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2057
2058         expect_pending_htlcs_forwardable!(nodes[2]);
2059         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2060
2061         // flush the htlcs in the holding cell
2062         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2063         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2064         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2065         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2066         expect_pending_htlcs_forwardable!(nodes[1]);
2067
2068         let ref payment_event_3 = expect_forward!(nodes[1]);
2069         assert_eq!(payment_event_3.msgs.len(), 2);
2070         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2071         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2072
2073         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2074         expect_pending_htlcs_forwardable!(nodes[2]);
2075
2076         let events = nodes[2].node.get_and_clear_pending_events();
2077         assert_eq!(events.len(), 2);
2078         match events[0] {
2079                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2080                         assert_eq!(our_payment_hash_21, *payment_hash);
2081                         assert!(payment_preimage.is_none());
2082                         assert_eq!(our_payment_secret_21, *payment_secret);
2083                         assert_eq!(recv_value_21, amt);
2084                 },
2085                 _ => panic!("Unexpected event"),
2086         }
2087         match events[1] {
2088                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2089                         assert_eq!(our_payment_hash_22, *payment_hash);
2090                         assert!(payment_preimage.is_none());
2091                         assert_eq!(our_payment_secret_22, *payment_secret);
2092                         assert_eq!(recv_value_22, amt);
2093                 },
2094                 _ => panic!("Unexpected event"),
2095         }
2096
2097         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2098         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2099         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2100
2101         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2102         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2103         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2104
2105         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2106         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);
2107         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2108         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2109         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2110
2111         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2112         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2113 }
2114
2115 #[test]
2116 fn channel_reserve_in_flight_removes() {
2117         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2118         // can send to its counterparty, but due to update ordering, the other side may not yet have
2119         // considered those HTLCs fully removed.
2120         // This tests that we don't count HTLCs which will not be included in the next remote
2121         // commitment transaction towards the reserve value (as it implies no commitment transaction
2122         // will be generated which violates the remote reserve value).
2123         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2124         // To test this we:
2125         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2126         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2127         //    you only consider the value of the first HTLC, it may not),
2128         //  * start routing a third HTLC from A to B,
2129         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2130         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2131         //  * deliver the first fulfill from B
2132         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2133         //    claim,
2134         //  * deliver A's response CS and RAA.
2135         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2136         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2137         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2138         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2139         let chanmon_cfgs = create_chanmon_cfgs(2);
2140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2142         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2143         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2144         let logger = test_utils::TestLogger::new();
2145
2146         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2147         // Route the first two HTLCs.
2148         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2149         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2150
2151         // Start routing the third HTLC (this is just used to get everyone in the right state).
2152         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2153         let send_1 = {
2154                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2155                 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();
2156                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2157                 check_added_monitors!(nodes[0], 1);
2158                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2159                 assert_eq!(events.len(), 1);
2160                 SendEvent::from_event(events.remove(0))
2161         };
2162
2163         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2164         // initial fulfill/CS.
2165         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2166         check_added_monitors!(nodes[1], 1);
2167         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2168
2169         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2170         // remove the second HTLC when we send the HTLC back from B to A.
2171         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2172         check_added_monitors!(nodes[1], 1);
2173         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2174
2175         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2176         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2177         check_added_monitors!(nodes[0], 1);
2178         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2179         expect_payment_sent!(nodes[0], payment_preimage_1);
2180
2181         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2182         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2183         check_added_monitors!(nodes[1], 1);
2184         // B is already AwaitingRAA, so cant generate a CS here
2185         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2186
2187         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2188         check_added_monitors!(nodes[1], 1);
2189         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2190
2191         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2192         check_added_monitors!(nodes[0], 1);
2193         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2194
2195         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2196         check_added_monitors!(nodes[1], 1);
2197         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2198
2199         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2200         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2201         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2202         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2203         // on-chain as necessary).
2204         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2205         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2206         check_added_monitors!(nodes[0], 1);
2207         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2208         expect_payment_sent!(nodes[0], payment_preimage_2);
2209
2210         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2211         check_added_monitors!(nodes[1], 1);
2212         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2213
2214         expect_pending_htlcs_forwardable!(nodes[1]);
2215         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2216
2217         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2218         // resolve the second HTLC from A's point of view.
2219         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2220         check_added_monitors!(nodes[0], 1);
2221         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2222
2223         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2224         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2225         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2226         let send_2 = {
2227                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2228                 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();
2229                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2230                 check_added_monitors!(nodes[1], 1);
2231                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2232                 assert_eq!(events.len(), 1);
2233                 SendEvent::from_event(events.remove(0))
2234         };
2235
2236         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2237         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2238         check_added_monitors!(nodes[0], 1);
2239         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2240
2241         // Now just resolve all the outstanding messages/HTLCs for completeness...
2242
2243         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2244         check_added_monitors!(nodes[1], 1);
2245         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2246
2247         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2248         check_added_monitors!(nodes[1], 1);
2249
2250         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2251         check_added_monitors!(nodes[0], 1);
2252         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2253
2254         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2255         check_added_monitors!(nodes[1], 1);
2256         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2257
2258         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2259         check_added_monitors!(nodes[0], 1);
2260
2261         expect_pending_htlcs_forwardable!(nodes[0]);
2262         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2263
2264         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2265         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2266 }
2267
2268 #[test]
2269 fn channel_monitor_network_test() {
2270         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2271         // tests that ChannelMonitor is able to recover from various states.
2272         let chanmon_cfgs = create_chanmon_cfgs(5);
2273         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2274         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2275         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2276
2277         // Create some initial channels
2278         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2279         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2280         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2281         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2282
2283         // Make sure all nodes are at the same starting height
2284         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2285         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2286         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2287         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2288         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2289
2290         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2294         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2295
2296         // Simple case with no pending HTLCs:
2297         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2298         check_added_monitors!(nodes[1], 1);
2299         check_closed_broadcast!(nodes[1], false);
2300         {
2301                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2302                 assert_eq!(node_txn.len(), 1);
2303                 mine_transaction(&nodes[0], &node_txn[0]);
2304                 check_added_monitors!(nodes[0], 1);
2305                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2306         }
2307         check_closed_broadcast!(nodes[0], true);
2308         assert_eq!(nodes[0].node.list_channels().len(), 0);
2309         assert_eq!(nodes[1].node.list_channels().len(), 1);
2310
2311         // One pending HTLC is discarded by the force-close:
2312         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2313
2314         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2315         // broadcasted until we reach the timelock time).
2316         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2317         check_closed_broadcast!(nodes[1], false);
2318         check_added_monitors!(nodes[1], 1);
2319         {
2320                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2321                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2322                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2323                 mine_transaction(&nodes[2], &node_txn[0]);
2324                 check_added_monitors!(nodes[2], 1);
2325                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2326         }
2327         check_closed_broadcast!(nodes[2], true);
2328         assert_eq!(nodes[1].node.list_channels().len(), 0);
2329         assert_eq!(nodes[2].node.list_channels().len(), 1);
2330
2331         macro_rules! claim_funds {
2332                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2333                         {
2334                                 assert!($node.node.claim_funds($preimage));
2335                                 check_added_monitors!($node, 1);
2336
2337                                 let events = $node.node.get_and_clear_pending_msg_events();
2338                                 assert_eq!(events.len(), 1);
2339                                 match events[0] {
2340                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2341                                                 assert!(update_add_htlcs.is_empty());
2342                                                 assert!(update_fail_htlcs.is_empty());
2343                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2344                                         },
2345                                         _ => panic!("Unexpected event"),
2346                                 };
2347                         }
2348                 }
2349         }
2350
2351         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2352         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2353         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2354         check_added_monitors!(nodes[2], 1);
2355         check_closed_broadcast!(nodes[2], false);
2356         let node2_commitment_txid;
2357         {
2358                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2359                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2360                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2361                 node2_commitment_txid = node_txn[0].txid();
2362
2363                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2364                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2365                 mine_transaction(&nodes[3], &node_txn[0]);
2366                 check_added_monitors!(nodes[3], 1);
2367                 check_preimage_claim(&nodes[3], &node_txn);
2368         }
2369         check_closed_broadcast!(nodes[3], true);
2370         assert_eq!(nodes[2].node.list_channels().len(), 0);
2371         assert_eq!(nodes[3].node.list_channels().len(), 1);
2372
2373         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2374         // confusing us in the following tests.
2375         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2376
2377         // One pending HTLC to time out:
2378         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2379         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2380         // buffer space).
2381
2382         let (close_chan_update_1, close_chan_update_2) = {
2383                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2384                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2385                 assert_eq!(events.len(), 2);
2386                 let close_chan_update_1 = match events[0] {
2387                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2388                                 msg.clone()
2389                         },
2390                         _ => panic!("Unexpected event"),
2391                 };
2392                 match events[1] {
2393                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2394                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2395                         },
2396                         _ => panic!("Unexpected event"),
2397                 }
2398                 check_added_monitors!(nodes[3], 1);
2399
2400                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2401                 {
2402                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2403                         node_txn.retain(|tx| {
2404                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2405                                         false
2406                                 } else { true }
2407                         });
2408                 }
2409
2410                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2411
2412                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2413                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2414
2415                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2416                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2417                 assert_eq!(events.len(), 2);
2418                 let close_chan_update_2 = match events[0] {
2419                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2420                                 msg.clone()
2421                         },
2422                         _ => panic!("Unexpected event"),
2423                 };
2424                 match events[1] {
2425                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2426                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2427                         },
2428                         _ => panic!("Unexpected event"),
2429                 }
2430                 check_added_monitors!(nodes[4], 1);
2431                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2432
2433                 mine_transaction(&nodes[4], &node_txn[0]);
2434                 check_preimage_claim(&nodes[4], &node_txn);
2435                 (close_chan_update_1, close_chan_update_2)
2436         };
2437         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2438         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2439         assert_eq!(nodes[3].node.list_channels().len(), 0);
2440         assert_eq!(nodes[4].node.list_channels().len(), 0);
2441
2442         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2443 }
2444
2445 #[test]
2446 fn test_justice_tx() {
2447         // Test justice txn built on revoked HTLC-Success tx, against both sides
2448         let mut alice_config = UserConfig::default();
2449         alice_config.channel_options.announced_channel = true;
2450         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2451         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2452         let mut bob_config = UserConfig::default();
2453         bob_config.channel_options.announced_channel = true;
2454         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2455         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2456         let user_cfgs = [Some(alice_config), Some(bob_config)];
2457         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2458         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2459         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2463         // Create some new channels:
2464         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2465
2466         // A pending HTLC which will be revoked:
2467         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2468         // Get the will-be-revoked local txn from nodes[0]
2469         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2470         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2471         assert_eq!(revoked_local_txn[0].input.len(), 1);
2472         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2473         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2474         assert_eq!(revoked_local_txn[1].input.len(), 1);
2475         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2476         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2477         // Revoke the old state
2478         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2479
2480         {
2481                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2482                 {
2483                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2484                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2485                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2486
2487                         check_spends!(node_txn[0], revoked_local_txn[0]);
2488                         node_txn.swap_remove(0);
2489                         node_txn.truncate(1);
2490                 }
2491                 check_added_monitors!(nodes[1], 1);
2492                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2493
2494                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2495                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2496                 // Verify broadcast of revoked HTLC-timeout
2497                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2498                 check_added_monitors!(nodes[0], 1);
2499                 // Broadcast revoked HTLC-timeout on node 1
2500                 mine_transaction(&nodes[1], &node_txn[1]);
2501                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2502         }
2503         get_announce_close_broadcast_events(&nodes, 0, 1);
2504
2505         assert_eq!(nodes[0].node.list_channels().len(), 0);
2506         assert_eq!(nodes[1].node.list_channels().len(), 0);
2507
2508         // We test justice_tx build by A on B's revoked HTLC-Success tx
2509         // Create some new channels:
2510         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2511         {
2512                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2513                 node_txn.clear();
2514         }
2515
2516         // A pending HTLC which will be revoked:
2517         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2518         // Get the will-be-revoked local txn from B
2519         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2520         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2521         assert_eq!(revoked_local_txn[0].input.len(), 1);
2522         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2523         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2524         // Revoke the old state
2525         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2526         {
2527                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2528                 {
2529                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2530                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2531                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2532
2533                         check_spends!(node_txn[0], revoked_local_txn[0]);
2534                         node_txn.swap_remove(0);
2535                 }
2536                 check_added_monitors!(nodes[0], 1);
2537                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2538
2539                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2540                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2541                 check_added_monitors!(nodes[1], 1);
2542                 mine_transaction(&nodes[0], &node_txn[1]);
2543                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2544         }
2545         get_announce_close_broadcast_events(&nodes, 0, 1);
2546         assert_eq!(nodes[0].node.list_channels().len(), 0);
2547         assert_eq!(nodes[1].node.list_channels().len(), 0);
2548 }
2549
2550 #[test]
2551 fn revoked_output_claim() {
2552         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2553         // transaction is broadcast by its counterparty
2554         let chanmon_cfgs = create_chanmon_cfgs(2);
2555         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2557         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2558         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2559         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2560         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2561         assert_eq!(revoked_local_txn.len(), 1);
2562         // Only output is the full channel value back to nodes[0]:
2563         assert_eq!(revoked_local_txn[0].output.len(), 1);
2564         // Send a payment through, updating everyone's latest commitment txn
2565         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2566
2567         // Inform nodes[1] that nodes[0] broadcast a stale tx
2568         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2569         check_added_monitors!(nodes[1], 1);
2570         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2571         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2572
2573         check_spends!(node_txn[0], revoked_local_txn[0]);
2574         check_spends!(node_txn[1], chan_1.3);
2575
2576         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2577         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2578         get_announce_close_broadcast_events(&nodes, 0, 1);
2579         check_added_monitors!(nodes[0], 1)
2580 }
2581
2582 #[test]
2583 fn claim_htlc_outputs_shared_tx() {
2584         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2585         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2586         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2587         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2588         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2589         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2590
2591         // Create some new channel:
2592         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2593
2594         // Rebalance the network to generate htlc in the two directions
2595         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2596         // 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
2597         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2598         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2599
2600         // Get the will-be-revoked local txn from node[0]
2601         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2602         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2603         assert_eq!(revoked_local_txn[0].input.len(), 1);
2604         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2605         assert_eq!(revoked_local_txn[1].input.len(), 1);
2606         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2607         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2608         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2609
2610         //Revoke the old state
2611         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2612
2613         {
2614                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2615                 check_added_monitors!(nodes[0], 1);
2616                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2617                 check_added_monitors!(nodes[1], 1);
2618                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2619                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2620
2621                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2622                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2623
2624                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2625                 check_spends!(node_txn[0], revoked_local_txn[0]);
2626
2627                 let mut witness_lens = BTreeSet::new();
2628                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2629                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2630                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2631                 assert_eq!(witness_lens.len(), 3);
2632                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2633                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2634                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2635
2636                 // Next nodes[1] broadcasts its current local tx state:
2637                 assert_eq!(node_txn[1].input.len(), 1);
2638                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2639         }
2640         get_announce_close_broadcast_events(&nodes, 0, 1);
2641         assert_eq!(nodes[0].node.list_channels().len(), 0);
2642         assert_eq!(nodes[1].node.list_channels().len(), 0);
2643 }
2644
2645 #[test]
2646 fn claim_htlc_outputs_single_tx() {
2647         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2648         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2649         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2650         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2651         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2652         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2653
2654         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2655
2656         // Rebalance the network to generate htlc in the two directions
2657         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2658         // 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
2659         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2660         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2661         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2662
2663         // Get the will-be-revoked local txn from node[0]
2664         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2665
2666         //Revoke the old state
2667         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2668
2669         {
2670                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2671                 check_added_monitors!(nodes[0], 1);
2672                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2673                 check_added_monitors!(nodes[1], 1);
2674                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2675
2676                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2677                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2678
2679                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2680                 assert_eq!(node_txn.len(), 9);
2681                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2682                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2683                 // 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)
2684                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2685
2686                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2687                 assert_eq!(node_txn[0].input.len(), 1);
2688                 check_spends!(node_txn[0], chan_1.3);
2689                 assert_eq!(node_txn[1].input.len(), 1);
2690                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2691                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2692                 check_spends!(node_txn[1], node_txn[0]);
2693
2694                 // Justice transactions are indices 1-2-4
2695                 assert_eq!(node_txn[2].input.len(), 1);
2696                 assert_eq!(node_txn[3].input.len(), 1);
2697                 assert_eq!(node_txn[4].input.len(), 1);
2698
2699                 check_spends!(node_txn[2], revoked_local_txn[0]);
2700                 check_spends!(node_txn[3], revoked_local_txn[0]);
2701                 check_spends!(node_txn[4], revoked_local_txn[0]);
2702
2703                 let mut witness_lens = BTreeSet::new();
2704                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2705                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2706                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2707                 assert_eq!(witness_lens.len(), 3);
2708                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2709                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2710                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2711         }
2712         get_announce_close_broadcast_events(&nodes, 0, 1);
2713         assert_eq!(nodes[0].node.list_channels().len(), 0);
2714         assert_eq!(nodes[1].node.list_channels().len(), 0);
2715 }
2716
2717 #[test]
2718 fn test_htlc_on_chain_success() {
2719         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2720         // the preimage backward accordingly. So here we test that ChannelManager is
2721         // broadcasting the right event to other nodes in payment path.
2722         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2723         // A --------------------> B ----------------------> C (preimage)
2724         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2725         // commitment transaction was broadcast.
2726         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2727         // towards B.
2728         // B should be able to claim via preimage if A then broadcasts its local tx.
2729         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2730         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2731         // PaymentSent event).
2732
2733         let chanmon_cfgs = create_chanmon_cfgs(3);
2734         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2735         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2736         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2737
2738         // Create some initial channels
2739         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2740         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2741
2742         // Ensure all nodes are at the same height
2743         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2744         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2745         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2746         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2747
2748         // Rebalance the network a bit by relaying one payment through all the channels...
2749         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2750         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2751
2752         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2753         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2754
2755         // Broadcast legit commitment tx from C on B's chain
2756         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2757         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2758         assert_eq!(commitment_tx.len(), 1);
2759         check_spends!(commitment_tx[0], chan_2.3);
2760         nodes[2].node.claim_funds(our_payment_preimage);
2761         nodes[2].node.claim_funds(our_payment_preimage_2);
2762         check_added_monitors!(nodes[2], 2);
2763         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2764         assert!(updates.update_add_htlcs.is_empty());
2765         assert!(updates.update_fail_htlcs.is_empty());
2766         assert!(updates.update_fail_malformed_htlcs.is_empty());
2767         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2768
2769         mine_transaction(&nodes[2], &commitment_tx[0]);
2770         check_closed_broadcast!(nodes[2], true);
2771         check_added_monitors!(nodes[2], 1);
2772         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)
2773         assert_eq!(node_txn.len(), 5);
2774         assert_eq!(node_txn[0], node_txn[3]);
2775         assert_eq!(node_txn[1], node_txn[4]);
2776         assert_eq!(node_txn[2], commitment_tx[0]);
2777         check_spends!(node_txn[0], commitment_tx[0]);
2778         check_spends!(node_txn[1], commitment_tx[0]);
2779         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2780         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2781         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2782         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2783         assert_eq!(node_txn[0].lock_time, 0);
2784         assert_eq!(node_txn[1].lock_time, 0);
2785
2786         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2787         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2788         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2789         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2790         {
2791                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2792                 assert_eq!(added_monitors.len(), 1);
2793                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2794                 added_monitors.clear();
2795         }
2796         let events = nodes[1].node.get_and_clear_pending_msg_events();
2797         {
2798                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2799                 assert_eq!(added_monitors.len(), 2);
2800                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2801                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2802                 added_monitors.clear();
2803         }
2804         assert_eq!(events.len(), 3);
2805         match events[0] {
2806                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2807                 _ => panic!("Unexpected event"),
2808         }
2809         match events[1] {
2810                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2811                 _ => panic!("Unexpected event"),
2812         }
2813
2814         match events[2] {
2815                 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, .. } } => {
2816                         assert!(update_add_htlcs.is_empty());
2817                         assert!(update_fail_htlcs.is_empty());
2818                         assert_eq!(update_fulfill_htlcs.len(), 1);
2819                         assert!(update_fail_malformed_htlcs.is_empty());
2820                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2821                 },
2822                 _ => panic!("Unexpected event"),
2823         };
2824         macro_rules! check_tx_local_broadcast {
2825                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2826                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2827                         assert_eq!(node_txn.len(), 3);
2828                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2829                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2830                         check_spends!(node_txn[1], $commitment_tx);
2831                         check_spends!(node_txn[2], $commitment_tx);
2832                         assert_ne!(node_txn[1].lock_time, 0);
2833                         assert_ne!(node_txn[2].lock_time, 0);
2834                         if $htlc_offered {
2835                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2837                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2839                         } else {
2840                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2841                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2842                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2843                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2844                         }
2845                         check_spends!(node_txn[0], $chan_tx);
2846                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
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 node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2858         check_spends!(node_a_commitment_tx[0], chan_1.3);
2859         mine_transaction(&nodes[1], &node_a_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();
2863         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2864         let commitment_spend =
2865                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2866                         check_spends!(node_txn[1], commitment_tx[0]);
2867                         check_spends!(node_txn[2], commitment_tx[0]);
2868                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2869                         &node_txn[0]
2870                 } else {
2871                         check_spends!(node_txn[0], commitment_tx[0]);
2872                         check_spends!(node_txn[1], commitment_tx[0]);
2873                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2874                         &node_txn[2]
2875                 };
2876
2877         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2878         assert_eq!(commitment_spend.input.len(), 2);
2879         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2880         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2881         assert_eq!(commitment_spend.lock_time, 0);
2882         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2883         check_spends!(node_txn[3], chan_1.3);
2884         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2885         check_spends!(node_txn[4], node_txn[3]);
2886         check_spends!(node_txn[5], node_txn[3]);
2887         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2888         // we already checked the same situation with A.
2889
2890         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2891         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2892         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2893         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2894         check_closed_broadcast!(nodes[0], true);
2895         check_added_monitors!(nodes[0], 1);
2896         let events = nodes[0].node.get_and_clear_pending_events();
2897         assert_eq!(events.len(), 2);
2898         let mut first_claimed = false;
2899         for event in events {
2900                 match event {
2901                         Event::PaymentSent { payment_preimage } => {
2902                                 if payment_preimage == our_payment_preimage {
2903                                         assert!(!first_claimed);
2904                                         first_claimed = true;
2905                                 } else {
2906                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2907                                 }
2908                         },
2909                         _ => panic!("Unexpected event"),
2910                 }
2911         }
2912         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2913 }
2914
2915 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2916         // Test that in case of a unilateral close onchain, we detect the state of output and
2917         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2918         // broadcasting the right event to other nodes in payment path.
2919         // A ------------------> B ----------------------> C (timeout)
2920         //    B's commitment tx                 C's commitment tx
2921         //            \                                  \
2922         //         B's HTLC timeout tx               B's timeout tx
2923
2924         let chanmon_cfgs = create_chanmon_cfgs(3);
2925         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2926         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2927         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2928         *nodes[0].connect_style.borrow_mut() = connect_style;
2929         *nodes[1].connect_style.borrow_mut() = connect_style;
2930         *nodes[2].connect_style.borrow_mut() = connect_style;
2931
2932         // Create some intial channels
2933         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2934         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2935
2936         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2937         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2938         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2939
2940         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2941
2942         // Broadcast legit commitment tx from C on B's chain
2943         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2944         check_spends!(commitment_tx[0], chan_2.3);
2945         nodes[2].node.fail_htlc_backwards(&payment_hash);
2946         check_added_monitors!(nodes[2], 0);
2947         expect_pending_htlcs_forwardable!(nodes[2]);
2948         check_added_monitors!(nodes[2], 1);
2949
2950         let events = nodes[2].node.get_and_clear_pending_msg_events();
2951         assert_eq!(events.len(), 1);
2952         match events[0] {
2953                 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, .. } } => {
2954                         assert!(update_add_htlcs.is_empty());
2955                         assert!(!update_fail_htlcs.is_empty());
2956                         assert!(update_fulfill_htlcs.is_empty());
2957                         assert!(update_fail_malformed_htlcs.is_empty());
2958                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2959                 },
2960                 _ => panic!("Unexpected event"),
2961         };
2962         mine_transaction(&nodes[2], &commitment_tx[0]);
2963         check_closed_broadcast!(nodes[2], true);
2964         check_added_monitors!(nodes[2], 1);
2965         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2966         assert_eq!(node_txn.len(), 1);
2967         check_spends!(node_txn[0], chan_2.3);
2968         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2969
2970         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2971         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2972         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2973         mine_transaction(&nodes[1], &commitment_tx[0]);
2974         let timeout_tx;
2975         {
2976                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2977                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2978                 assert_eq!(node_txn[0], node_txn[3]);
2979                 assert_eq!(node_txn[1], node_txn[4]);
2980
2981                 check_spends!(node_txn[2], commitment_tx[0]);
2982                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2983
2984                 check_spends!(node_txn[0], chan_2.3);
2985                 check_spends!(node_txn[1], node_txn[0]);
2986                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2987                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2988
2989                 timeout_tx = node_txn[2].clone();
2990                 node_txn.clear();
2991         }
2992
2993         mine_transaction(&nodes[1], &timeout_tx);
2994         check_added_monitors!(nodes[1], 1);
2995         check_closed_broadcast!(nodes[1], true);
2996         {
2997                 // B will rebroadcast a fee-bumped timeout transaction here.
2998                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2999                 assert_eq!(node_txn.len(), 1);
3000                 check_spends!(node_txn[0], commitment_tx[0]);
3001         }
3002
3003         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3004         {
3005                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3006                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3007                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3008                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3009                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3010                 if node_txn.len() == 1 {
3011                         check_spends!(node_txn[0], chan_2.3);
3012                 } else {
3013                         assert_eq!(node_txn.len(), 0);
3014                 }
3015         }
3016
3017         expect_pending_htlcs_forwardable!(nodes[1]);
3018         check_added_monitors!(nodes[1], 1);
3019         let events = nodes[1].node.get_and_clear_pending_msg_events();
3020         assert_eq!(events.len(), 1);
3021         match events[0] {
3022                 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, .. } } => {
3023                         assert!(update_add_htlcs.is_empty());
3024                         assert!(!update_fail_htlcs.is_empty());
3025                         assert!(update_fulfill_htlcs.is_empty());
3026                         assert!(update_fail_malformed_htlcs.is_empty());
3027                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3028                 },
3029                 _ => panic!("Unexpected event"),
3030         };
3031
3032         // Broadcast legit commitment tx from B on A's chain
3033         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3034         check_spends!(commitment_tx[0], chan_1.3);
3035
3036         mine_transaction(&nodes[0], &commitment_tx[0]);
3037         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3038
3039         check_closed_broadcast!(nodes[0], true);
3040         check_added_monitors!(nodes[0], 1);
3041         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3042         assert_eq!(node_txn.len(), 2);
3043         check_spends!(node_txn[0], chan_1.3);
3044         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3045         check_spends!(node_txn[1], commitment_tx[0]);
3046         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3047 }
3048
3049 #[test]
3050 fn test_htlc_on_chain_timeout() {
3051         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3052         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3053         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3054 }
3055
3056 #[test]
3057 fn test_simple_commitment_revoked_fail_backward() {
3058         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3059         // and fail backward accordingly.
3060
3061         let chanmon_cfgs = create_chanmon_cfgs(3);
3062         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3063         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3064         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3065
3066         // Create some initial channels
3067         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3068         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3069
3070         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3071         // Get the will-be-revoked local txn from nodes[2]
3072         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3073         // Revoke the old state
3074         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3075
3076         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3077
3078         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3079         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3080         check_added_monitors!(nodes[1], 1);
3081         check_closed_broadcast!(nodes[1], true);
3082
3083         expect_pending_htlcs_forwardable!(nodes[1]);
3084         check_added_monitors!(nodes[1], 1);
3085         let events = nodes[1].node.get_and_clear_pending_msg_events();
3086         assert_eq!(events.len(), 1);
3087         match events[0] {
3088                 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, .. } } => {
3089                         assert!(update_add_htlcs.is_empty());
3090                         assert_eq!(update_fail_htlcs.len(), 1);
3091                         assert!(update_fulfill_htlcs.is_empty());
3092                         assert!(update_fail_malformed_htlcs.is_empty());
3093                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3094
3095                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3096                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3097                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3098                         expect_payment_failed!(nodes[0], payment_hash, false);
3099                 },
3100                 _ => panic!("Unexpected event"),
3101         }
3102 }
3103
3104 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3105         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3106         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3107         // commitment transaction anymore.
3108         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3109         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3110         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3111         // technically disallowed and we should probably handle it reasonably.
3112         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3113         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3114         // transactions:
3115         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3116         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3117         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3118         //   and once they revoke the previous commitment transaction (allowing us to send a new
3119         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3120         let chanmon_cfgs = create_chanmon_cfgs(3);
3121         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3122         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3123         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3124
3125         // Create some initial channels
3126         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3127         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3128
3129         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 });
3130         // Get the will-be-revoked local txn from nodes[2]
3131         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3132         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3133         // Revoke the old state
3134         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3135
3136         let value = if use_dust {
3137                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3138                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3139                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3140         } else { 3000000 };
3141
3142         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3143         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3144         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3145
3146         assert!(nodes[2].node.fail_htlc_backwards(&first_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         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3157         // Drop the last RAA from 3 -> 2
3158
3159         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3160         expect_pending_htlcs_forwardable!(nodes[2]);
3161         check_added_monitors!(nodes[2], 1);
3162         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3163         assert!(updates.update_add_htlcs.is_empty());
3164         assert!(updates.update_fulfill_htlcs.is_empty());
3165         assert!(updates.update_fail_malformed_htlcs.is_empty());
3166         assert_eq!(updates.update_fail_htlcs.len(), 1);
3167         assert!(updates.update_fee.is_none());
3168         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3169         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3170         check_added_monitors!(nodes[1], 1);
3171         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3172         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3173         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3174         check_added_monitors!(nodes[2], 1);
3175
3176         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3177         expect_pending_htlcs_forwardable!(nodes[2]);
3178         check_added_monitors!(nodes[2], 1);
3179         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3180         assert!(updates.update_add_htlcs.is_empty());
3181         assert!(updates.update_fulfill_htlcs.is_empty());
3182         assert!(updates.update_fail_malformed_htlcs.is_empty());
3183         assert_eq!(updates.update_fail_htlcs.len(), 1);
3184         assert!(updates.update_fee.is_none());
3185         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3186         // At this point first_payment_hash has dropped out of the latest two commitment
3187         // transactions that nodes[1] is tracking...
3188         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3189         check_added_monitors!(nodes[1], 1);
3190         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3191         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3192         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3193         check_added_monitors!(nodes[2], 1);
3194
3195         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3196         // on nodes[2]'s RAA.
3197         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3198         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3199         let logger = test_utils::TestLogger::new();
3200         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();
3201         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3202         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3203         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3204         check_added_monitors!(nodes[1], 0);
3205
3206         if deliver_bs_raa {
3207                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3208                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3209                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3210                 check_added_monitors!(nodes[1], 1);
3211                 let events = nodes[1].node.get_and_clear_pending_events();
3212                 assert_eq!(events.len(), 1);
3213                 match events[0] {
3214                         Event::PendingHTLCsForwardable { .. } => { },
3215                         _ => panic!("Unexpected event"),
3216                 };
3217                 // Deliberately don't process the pending fail-back so they all fail back at once after
3218                 // block connection just like the !deliver_bs_raa case
3219         }
3220
3221         let mut failed_htlcs = HashSet::new();
3222         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3223
3224         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3225         check_added_monitors!(nodes[1], 1);
3226         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3227
3228         let events = nodes[1].node.get_and_clear_pending_events();
3229         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3230         match events[0] {
3231                 Event::PaymentFailed { ref payment_hash, .. } => {
3232                         assert_eq!(*payment_hash, fourth_payment_hash);
3233                 },
3234                 _ => panic!("Unexpected event"),
3235         }
3236         if !deliver_bs_raa {
3237                 match events[1] {
3238                         Event::PendingHTLCsForwardable { .. } => { },
3239                         _ => panic!("Unexpected event"),
3240                 };
3241         }
3242         nodes[1].node.process_pending_htlc_forwards();
3243         check_added_monitors!(nodes[1], 1);
3244
3245         let events = nodes[1].node.get_and_clear_pending_msg_events();
3246         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3247         match events[if deliver_bs_raa { 1 } else { 0 }] {
3248                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3249                 _ => panic!("Unexpected event"),
3250         }
3251         match events[if deliver_bs_raa { 2 } else { 1 }] {
3252                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3253                         assert_eq!(channel_id, chan_2.2);
3254                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3255                 },
3256                 _ => panic!("Unexpected event"),
3257         }
3258         if deliver_bs_raa {
3259                 match events[0] {
3260                         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, .. } } => {
3261                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3262                                 assert_eq!(update_add_htlcs.len(), 1);
3263                                 assert!(update_fulfill_htlcs.is_empty());
3264                                 assert!(update_fail_htlcs.is_empty());
3265                                 assert!(update_fail_malformed_htlcs.is_empty());
3266                         },
3267                         _ => panic!("Unexpected event"),
3268                 }
3269         }
3270         match events[if deliver_bs_raa { 3 } else { 2 }] {
3271                 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, .. } } => {
3272                         assert!(update_add_htlcs.is_empty());
3273                         assert_eq!(update_fail_htlcs.len(), 3);
3274                         assert!(update_fulfill_htlcs.is_empty());
3275                         assert!(update_fail_malformed_htlcs.is_empty());
3276                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3277
3278                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3279                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3280                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3281
3282                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3283
3284                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3285                         // If we delivered B's RAA we got an unknown preimage error, not something
3286                         // that we should update our routing table for.
3287                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3288                         for event in events {
3289                                 match event {
3290                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3291                                         _ => panic!("Unexpected event"),
3292                                 }
3293                         }
3294                         let events = nodes[0].node.get_and_clear_pending_events();
3295                         assert_eq!(events.len(), 3);
3296                         match events[0] {
3297                                 Event::PaymentFailed { ref payment_hash, .. } => {
3298                                         assert!(failed_htlcs.insert(payment_hash.0));
3299                                 },
3300                                 _ => panic!("Unexpected event"),
3301                         }
3302                         match events[1] {
3303                                 Event::PaymentFailed { ref payment_hash, .. } => {
3304                                         assert!(failed_htlcs.insert(payment_hash.0));
3305                                 },
3306                                 _ => panic!("Unexpected event"),
3307                         }
3308                         match events[2] {
3309                                 Event::PaymentFailed { ref payment_hash, .. } => {
3310                                         assert!(failed_htlcs.insert(payment_hash.0));
3311                                 },
3312                                 _ => panic!("Unexpected event"),
3313                         }
3314                 },
3315                 _ => panic!("Unexpected event"),
3316         }
3317
3318         assert!(failed_htlcs.contains(&first_payment_hash.0));
3319         assert!(failed_htlcs.contains(&second_payment_hash.0));
3320         assert!(failed_htlcs.contains(&third_payment_hash.0));
3321 }
3322
3323 #[test]
3324 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3325         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3326         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3327         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3328         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3329 }
3330
3331 #[test]
3332 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3333         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3334         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3335         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3336         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3337 }
3338
3339 #[test]
3340 fn fail_backward_pending_htlc_upon_channel_failure() {
3341         let chanmon_cfgs = create_chanmon_cfgs(2);
3342         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3343         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3344         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3345         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3346         let logger = test_utils::TestLogger::new();
3347
3348         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3349         {
3350                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3351                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3352                 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();
3353                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3354                 check_added_monitors!(nodes[0], 1);
3355
3356                 let payment_event = {
3357                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3358                         assert_eq!(events.len(), 1);
3359                         SendEvent::from_event(events.remove(0))
3360                 };
3361                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3362                 assert_eq!(payment_event.msgs.len(), 1);
3363         }
3364
3365         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3366         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3367         {
3368                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3369                 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();
3370                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3371                 check_added_monitors!(nodes[0], 0);
3372
3373                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3374         }
3375
3376         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3377         {
3378                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3379
3380                 let secp_ctx = Secp256k1::new();
3381                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3382                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3383                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3384                 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();
3385                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3386                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3387                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3388
3389                 // Send a 0-msat update_add_htlc to fail the channel.
3390                 let update_add_htlc = msgs::UpdateAddHTLC {
3391                         channel_id: chan.2,
3392                         htlc_id: 0,
3393                         amount_msat: 0,
3394                         payment_hash,
3395                         cltv_expiry,
3396                         onion_routing_packet,
3397                 };
3398                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3399         }
3400
3401         // Check that Alice fails backward the pending HTLC from the second payment.
3402         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3403         check_closed_broadcast!(nodes[0], true);
3404         check_added_monitors!(nodes[0], 1);
3405 }
3406
3407 #[test]
3408 fn test_htlc_ignore_latest_remote_commitment() {
3409         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3410         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3411         let chanmon_cfgs = create_chanmon_cfgs(2);
3412         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3413         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3414         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3415         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3416
3417         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3418         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3419         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3420         check_closed_broadcast!(nodes[0], true);
3421         check_added_monitors!(nodes[0], 1);
3422
3423         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3424         assert_eq!(node_txn.len(), 3);
3425         assert_eq!(node_txn[0], node_txn[1]);
3426
3427         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3428         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3429         check_closed_broadcast!(nodes[1], true);
3430         check_added_monitors!(nodes[1], 1);
3431
3432         // Duplicate the connect_block call since this may happen due to other listeners
3433         // registering new transactions
3434         header.prev_blockhash = header.block_hash();
3435         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3436 }
3437
3438 #[test]
3439 fn test_force_close_fail_back() {
3440         // Check which HTLCs are failed-backwards on channel force-closure
3441         let chanmon_cfgs = create_chanmon_cfgs(3);
3442         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3443         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3444         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3445         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3446         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3447         let logger = test_utils::TestLogger::new();
3448
3449         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3450
3451         let mut payment_event = {
3452                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3453                 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();
3454                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3455                 check_added_monitors!(nodes[0], 1);
3456
3457                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3458                 assert_eq!(events.len(), 1);
3459                 SendEvent::from_event(events.remove(0))
3460         };
3461
3462         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3463         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3464
3465         expect_pending_htlcs_forwardable!(nodes[1]);
3466
3467         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3468         assert_eq!(events_2.len(), 1);
3469         payment_event = SendEvent::from_event(events_2.remove(0));
3470         assert_eq!(payment_event.msgs.len(), 1);
3471
3472         check_added_monitors!(nodes[1], 1);
3473         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3474         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3475         check_added_monitors!(nodes[2], 1);
3476         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3477
3478         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3479         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3480         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3481
3482         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3483         check_closed_broadcast!(nodes[2], true);
3484         check_added_monitors!(nodes[2], 1);
3485         let tx = {
3486                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3487                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3488                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3489                 // back to nodes[1] upon timeout otherwise.
3490                 assert_eq!(node_txn.len(), 1);
3491                 node_txn.remove(0)
3492         };
3493
3494         mine_transaction(&nodes[1], &tx);
3495
3496         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3497         check_closed_broadcast!(nodes[1], true);
3498         check_added_monitors!(nodes[1], 1);
3499
3500         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3501         {
3502                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3503                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3504                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3505         }
3506         mine_transaction(&nodes[2], &tx);
3507         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3508         assert_eq!(node_txn.len(), 1);
3509         assert_eq!(node_txn[0].input.len(), 1);
3510         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3511         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3512         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3513
3514         check_spends!(node_txn[0], tx);
3515 }
3516
3517 #[test]
3518 fn test_dup_events_on_peer_disconnect() {
3519         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3520         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3521         // as we used to generate the event immediately upon receipt of the payment preimage in the
3522         // update_fulfill_htlc message.
3523
3524         let chanmon_cfgs = create_chanmon_cfgs(2);
3525         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3526         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3527         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3528         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3529
3530         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3531
3532         assert!(nodes[1].node.claim_funds(payment_preimage));
3533         check_added_monitors!(nodes[1], 1);
3534         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3535         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3536         expect_payment_sent!(nodes[0], payment_preimage);
3537
3538         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3539         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3540
3541         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3542         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3543 }
3544
3545 #[test]
3546 fn test_simple_peer_disconnect() {
3547         // Test that we can reconnect when there are no lost messages
3548         let chanmon_cfgs = create_chanmon_cfgs(3);
3549         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3550         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3551         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3552         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3553         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3554
3555         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3556         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3558
3559         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3560         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3561         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3562         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3563
3564         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3565         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3566         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3567
3568         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3569         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3570         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3571         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3572
3573         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3574         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3575
3576         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3577         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3578
3579         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3580         {
3581                 let events = nodes[0].node.get_and_clear_pending_events();
3582                 assert_eq!(events.len(), 2);
3583                 match events[0] {
3584                         Event::PaymentSent { payment_preimage } => {
3585                                 assert_eq!(payment_preimage, payment_preimage_3);
3586                         },
3587                         _ => panic!("Unexpected event"),
3588                 }
3589                 match events[1] {
3590                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3591                                 assert_eq!(payment_hash, payment_hash_5);
3592                                 assert!(rejected_by_dest);
3593                         },
3594                         _ => panic!("Unexpected event"),
3595                 }
3596         }
3597
3598         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3599         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3600 }
3601
3602 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3603         // Test that we can reconnect when in-flight HTLC updates get dropped
3604         let chanmon_cfgs = create_chanmon_cfgs(2);
3605         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3606         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3607         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3608
3609         let mut as_funding_locked = None;
3610         if messages_delivered == 0 {
3611                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3612                 as_funding_locked = Some(funding_locked);
3613                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3614                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3615                 // it before the channel_reestablish message.
3616         } else {
3617                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3618         }
3619
3620         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3621
3622         let logger = test_utils::TestLogger::new();
3623         let payment_event = {
3624                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3625                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3626                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3627                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3628                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3629                 check_added_monitors!(nodes[0], 1);
3630
3631                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3632                 assert_eq!(events.len(), 1);
3633                 SendEvent::from_event(events.remove(0))
3634         };
3635         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3636
3637         if messages_delivered < 2 {
3638                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3639         } else {
3640                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3641                 if messages_delivered >= 3 {
3642                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3643                         check_added_monitors!(nodes[1], 1);
3644                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3645
3646                         if messages_delivered >= 4 {
3647                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3648                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3649                                 check_added_monitors!(nodes[0], 1);
3650
3651                                 if messages_delivered >= 5 {
3652                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3653                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3654                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3655                                         check_added_monitors!(nodes[0], 1);
3656
3657                                         if messages_delivered >= 6 {
3658                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3659                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3660                                                 check_added_monitors!(nodes[1], 1);
3661                                         }
3662                                 }
3663                         }
3664                 }
3665         }
3666
3667         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3668         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3669         if messages_delivered < 3 {
3670                 if simulate_broken_lnd {
3671                         // lnd has a long-standing bug where they send a funding_locked prior to a
3672                         // channel_reestablish if you reconnect prior to funding_locked time.
3673                         //
3674                         // Here we simulate that behavior, delivering a funding_locked immediately on
3675                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3676                         // in `reconnect_nodes` but we currently don't fail based on that.
3677                         //
3678                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3679                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3680                 }
3681                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3682                 // received on either side, both sides will need to resend them.
3683                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3684         } else if messages_delivered == 3 {
3685                 // nodes[0] still wants its RAA + commitment_signed
3686                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3687         } else if messages_delivered == 4 {
3688                 // nodes[0] still wants its commitment_signed
3689                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3690         } else if messages_delivered == 5 {
3691                 // nodes[1] still wants its final RAA
3692                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3693         } else if messages_delivered == 6 {
3694                 // Everything was delivered...
3695                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3696         }
3697
3698         let events_1 = nodes[1].node.get_and_clear_pending_events();
3699         assert_eq!(events_1.len(), 1);
3700         match events_1[0] {
3701                 Event::PendingHTLCsForwardable { .. } => { },
3702                 _ => panic!("Unexpected event"),
3703         };
3704
3705         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3706         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3707         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3708
3709         nodes[1].node.process_pending_htlc_forwards();
3710
3711         let events_2 = nodes[1].node.get_and_clear_pending_events();
3712         assert_eq!(events_2.len(), 1);
3713         match events_2[0] {
3714                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3715                         assert_eq!(payment_hash_1, *payment_hash);
3716                         assert!(payment_preimage.is_none());
3717                         assert_eq!(payment_secret_1, *payment_secret);
3718                         assert_eq!(amt, 1000000);
3719                 },
3720                 _ => panic!("Unexpected event"),
3721         }
3722
3723         nodes[1].node.claim_funds(payment_preimage_1);
3724         check_added_monitors!(nodes[1], 1);
3725
3726         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3727         assert_eq!(events_3.len(), 1);
3728         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3729                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3730                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3731                         assert!(updates.update_add_htlcs.is_empty());
3732                         assert!(updates.update_fail_htlcs.is_empty());
3733                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3734                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3735                         assert!(updates.update_fee.is_none());
3736                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3737                 },
3738                 _ => panic!("Unexpected event"),
3739         };
3740
3741         if messages_delivered >= 1 {
3742                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3743
3744                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3745                 assert_eq!(events_4.len(), 1);
3746                 match events_4[0] {
3747                         Event::PaymentSent { ref payment_preimage } => {
3748                                 assert_eq!(payment_preimage_1, *payment_preimage);
3749                         },
3750                         _ => panic!("Unexpected event"),
3751                 }
3752
3753                 if messages_delivered >= 2 {
3754                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3755                         check_added_monitors!(nodes[0], 1);
3756                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3757
3758                         if messages_delivered >= 3 {
3759                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3760                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3761                                 check_added_monitors!(nodes[1], 1);
3762
3763                                 if messages_delivered >= 4 {
3764                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3765                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3766                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3767                                         check_added_monitors!(nodes[1], 1);
3768
3769                                         if messages_delivered >= 5 {
3770                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3771                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3772                                                 check_added_monitors!(nodes[0], 1);
3773                                         }
3774                                 }
3775                         }
3776                 }
3777         }
3778
3779         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3780         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3781         if messages_delivered < 2 {
3782                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3783                 if messages_delivered < 1 {
3784                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3785                         assert_eq!(events_4.len(), 1);
3786                         match events_4[0] {
3787                                 Event::PaymentSent { ref payment_preimage } => {
3788                                         assert_eq!(payment_preimage_1, *payment_preimage);
3789                                 },
3790                                 _ => panic!("Unexpected event"),
3791                         }
3792                 } else {
3793                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3794                 }
3795         } else if messages_delivered == 2 {
3796                 // nodes[0] still wants its RAA + commitment_signed
3797                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3798         } else if messages_delivered == 3 {
3799                 // nodes[0] still wants its commitment_signed
3800                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3801         } else if messages_delivered == 4 {
3802                 // nodes[1] still wants its final RAA
3803                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3804         } else if messages_delivered == 5 {
3805                 // Everything was delivered...
3806                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3807         }
3808
3809         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3810         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3811         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3812
3813         // Channel should still work fine...
3814         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3815         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3816                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3817                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3818         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3819         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3820 }
3821
3822 #[test]
3823 fn test_drop_messages_peer_disconnect_a() {
3824         do_test_drop_messages_peer_disconnect(0, true);
3825         do_test_drop_messages_peer_disconnect(0, false);
3826         do_test_drop_messages_peer_disconnect(1, false);
3827         do_test_drop_messages_peer_disconnect(2, false);
3828 }
3829
3830 #[test]
3831 fn test_drop_messages_peer_disconnect_b() {
3832         do_test_drop_messages_peer_disconnect(3, false);
3833         do_test_drop_messages_peer_disconnect(4, false);
3834         do_test_drop_messages_peer_disconnect(5, false);
3835         do_test_drop_messages_peer_disconnect(6, false);
3836 }
3837
3838 #[test]
3839 fn test_funding_peer_disconnect() {
3840         // Test that we can lock in our funding tx while disconnected
3841         let chanmon_cfgs = create_chanmon_cfgs(2);
3842         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3843         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3844         let persister: test_utils::TestPersister;
3845         let new_chain_monitor: test_utils::TestChainMonitor;
3846         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3847         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3848         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3849
3850         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3851         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3852
3853         confirm_transaction(&nodes[0], &tx);
3854         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3855         assert_eq!(events_1.len(), 1);
3856         match events_1[0] {
3857                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3858                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3859                 },
3860                 _ => panic!("Unexpected event"),
3861         }
3862
3863         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3864
3865         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3866         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3867
3868         confirm_transaction(&nodes[1], &tx);
3869         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3870         assert_eq!(events_2.len(), 2);
3871         let funding_locked = match events_2[0] {
3872                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3873                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3874                         msg.clone()
3875                 },
3876                 _ => panic!("Unexpected event"),
3877         };
3878         let bs_announcement_sigs = match events_2[1] {
3879                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3880                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3881                         msg.clone()
3882                 },
3883                 _ => panic!("Unexpected event"),
3884         };
3885
3886         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3887
3888         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3889         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3890         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3891         assert_eq!(events_3.len(), 2);
3892         let as_announcement_sigs = match events_3[0] {
3893                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3894                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3895                         msg.clone()
3896                 },
3897                 _ => panic!("Unexpected event"),
3898         };
3899         let (as_announcement, as_update) = match events_3[1] {
3900                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3901                         (msg.clone(), update_msg.clone())
3902                 },
3903                 _ => panic!("Unexpected event"),
3904         };
3905
3906         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3907         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3908         assert_eq!(events_4.len(), 1);
3909         let (_, bs_update) = match events_4[0] {
3910                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3911                         (msg.clone(), update_msg.clone())
3912                 },
3913                 _ => panic!("Unexpected event"),
3914         };
3915
3916         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3917         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3918         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3919
3920         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3921         let logger = test_utils::TestLogger::new();
3922         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();
3923         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3924         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3925
3926         // Check that after deserialization and reconnection we can still generate an identical
3927         // channel_announcement from the cached signatures.
3928         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3929
3930         let nodes_0_serialized = nodes[0].node.encode();
3931         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3932         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3933
3934         persister = test_utils::TestPersister::new();
3935         let keys_manager = &chanmon_cfgs[0].keys_manager;
3936         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);
3937         nodes[0].chain_monitor = &new_chain_monitor;
3938         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3939         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3940                 &mut chan_0_monitor_read, keys_manager).unwrap();
3941         assert!(chan_0_monitor_read.is_empty());
3942
3943         let mut nodes_0_read = &nodes_0_serialized[..];
3944         let (_, nodes_0_deserialized_tmp) = {
3945                 let mut channel_monitors = HashMap::new();
3946                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3947                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3948                         default_config: UserConfig::default(),
3949                         keys_manager,
3950                         fee_estimator: node_cfgs[0].fee_estimator,
3951                         chain_monitor: nodes[0].chain_monitor,
3952                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3953                         logger: nodes[0].logger,
3954                         channel_monitors,
3955                 }).unwrap()
3956         };
3957         nodes_0_deserialized = nodes_0_deserialized_tmp;
3958         assert!(nodes_0_read.is_empty());
3959
3960         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3961         nodes[0].node = &nodes_0_deserialized;
3962         check_added_monitors!(nodes[0], 1);
3963
3964         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3965
3966         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3967         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3968         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3969         let mut found_announcement = false;
3970         for event in msgs.iter() {
3971                 match event {
3972                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3973                                 if *msg == as_announcement { found_announcement = true; }
3974                         },
3975                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3976                         _ => panic!("Unexpected event"),
3977                 }
3978         }
3979         assert!(found_announcement);
3980 }
3981
3982 #[test]
3983 fn test_drop_messages_peer_disconnect_dual_htlc() {
3984         // Test that we can handle reconnecting when both sides of a channel have pending
3985         // commitment_updates when we disconnect.
3986         let chanmon_cfgs = create_chanmon_cfgs(2);
3987         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3988         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3989         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3990         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3991         let logger = test_utils::TestLogger::new();
3992
3993         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3994
3995         // Now try to send a second payment which will fail to send
3996         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3997         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3998         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();
3999         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4000         check_added_monitors!(nodes[0], 1);
4001
4002         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4003         assert_eq!(events_1.len(), 1);
4004         match events_1[0] {
4005                 MessageSendEvent::UpdateHTLCs { .. } => {},
4006                 _ => panic!("Unexpected event"),
4007         }
4008
4009         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4010         check_added_monitors!(nodes[1], 1);
4011
4012         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4013         assert_eq!(events_2.len(), 1);
4014         match events_2[0] {
4015                 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 } } => {
4016                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4017                         assert!(update_add_htlcs.is_empty());
4018                         assert_eq!(update_fulfill_htlcs.len(), 1);
4019                         assert!(update_fail_htlcs.is_empty());
4020                         assert!(update_fail_malformed_htlcs.is_empty());
4021                         assert!(update_fee.is_none());
4022
4023                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4024                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4025                         assert_eq!(events_3.len(), 1);
4026                         match events_3[0] {
4027                                 Event::PaymentSent { ref payment_preimage } => {
4028                                         assert_eq!(*payment_preimage, payment_preimage_1);
4029                                 },
4030                                 _ => panic!("Unexpected event"),
4031                         }
4032
4033                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4034                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4035                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4036                         check_added_monitors!(nodes[0], 1);
4037                 },
4038                 _ => panic!("Unexpected event"),
4039         }
4040
4041         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4042         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4043
4044         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4045         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4046         assert_eq!(reestablish_1.len(), 1);
4047         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4048         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4049         assert_eq!(reestablish_2.len(), 1);
4050
4051         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4052         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4053         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4054         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4055
4056         assert!(as_resp.0.is_none());
4057         assert!(bs_resp.0.is_none());
4058
4059         assert!(bs_resp.1.is_none());
4060         assert!(bs_resp.2.is_none());
4061
4062         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4063
4064         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4065         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4066         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4067         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4068         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4069         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4070         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4071         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4072         // No commitment_signed so get_event_msg's assert(len == 1) passes
4073         check_added_monitors!(nodes[1], 1);
4074
4075         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4076         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4077         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4078         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4079         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4080         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4081         assert!(bs_second_commitment_signed.update_fee.is_none());
4082         check_added_monitors!(nodes[1], 1);
4083
4084         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4085         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4086         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4087         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4088         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4089         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4090         assert!(as_commitment_signed.update_fee.is_none());
4091         check_added_monitors!(nodes[0], 1);
4092
4093         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4094         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4095         // No commitment_signed so get_event_msg's assert(len == 1) passes
4096         check_added_monitors!(nodes[0], 1);
4097
4098         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4099         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4100         // No commitment_signed so get_event_msg's assert(len == 1) passes
4101         check_added_monitors!(nodes[1], 1);
4102
4103         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4104         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4105         check_added_monitors!(nodes[1], 1);
4106
4107         expect_pending_htlcs_forwardable!(nodes[1]);
4108
4109         let events_5 = nodes[1].node.get_and_clear_pending_events();
4110         assert_eq!(events_5.len(), 1);
4111         match events_5[0] {
4112                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4113                         assert_eq!(payment_hash_2, *payment_hash);
4114                         assert!(payment_preimage.is_none());
4115                         assert_eq!(payment_secret_2, *payment_secret);
4116                 },
4117                 _ => panic!("Unexpected event"),
4118         }
4119
4120         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4121         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4122         check_added_monitors!(nodes[0], 1);
4123
4124         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4125 }
4126
4127 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4128         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4129         // to avoid our counterparty failing the channel.
4130         let chanmon_cfgs = create_chanmon_cfgs(2);
4131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4133         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4134
4135         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4136         let logger = test_utils::TestLogger::new();
4137
4138         let our_payment_hash = if send_partial_mpp {
4139                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4140                 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();
4141                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4142                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4143                 // indicates there are more HTLCs coming.
4144                 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.
4145                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4146                 check_added_monitors!(nodes[0], 1);
4147                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4148                 assert_eq!(events.len(), 1);
4149                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4150                 // hop should *not* yet generate any PaymentReceived event(s).
4151                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4152                 our_payment_hash
4153         } else {
4154                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4155         };
4156
4157         let mut block = Block {
4158                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4159                 txdata: vec![],
4160         };
4161         connect_block(&nodes[0], &block);
4162         connect_block(&nodes[1], &block);
4163         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4164         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4165                 block.header.prev_blockhash = block.block_hash();
4166                 connect_block(&nodes[0], &block);
4167                 connect_block(&nodes[1], &block);
4168         }
4169
4170         expect_pending_htlcs_forwardable!(nodes[1]);
4171
4172         check_added_monitors!(nodes[1], 1);
4173         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4174         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4175         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4176         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4177         assert!(htlc_timeout_updates.update_fee.is_none());
4178
4179         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4180         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4181         // 100_000 msat as u64, followed by the height at which we failed back above
4182         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4183         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4184         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4185 }
4186
4187 #[test]
4188 fn test_htlc_timeout() {
4189         do_test_htlc_timeout(true);
4190         do_test_htlc_timeout(false);
4191 }
4192
4193 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4194         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4195         let chanmon_cfgs = create_chanmon_cfgs(3);
4196         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4197         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4198         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4199         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4200         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4201
4202         // Make sure all nodes are at the same starting height
4203         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4204         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4205         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4206
4207         let logger = test_utils::TestLogger::new();
4208
4209         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4210         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4211         {
4212                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4213                 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();
4214                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4215         }
4216         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4217         check_added_monitors!(nodes[1], 1);
4218
4219         // Now attempt to route a second payment, which should be placed in the holding cell
4220         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4221         if forwarded_htlc {
4222                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4223                 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();
4224                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4225                 check_added_monitors!(nodes[0], 1);
4226                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4227                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4228                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4229                 expect_pending_htlcs_forwardable!(nodes[1]);
4230                 check_added_monitors!(nodes[1], 0);
4231         } else {
4232                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4233                 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();
4234                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4235                 check_added_monitors!(nodes[1], 0);
4236         }
4237
4238         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4239         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4240         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4241         connect_blocks(&nodes[1], 1);
4242
4243         if forwarded_htlc {
4244                 expect_pending_htlcs_forwardable!(nodes[1]);
4245                 check_added_monitors!(nodes[1], 1);
4246                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4247                 assert_eq!(fail_commit.len(), 1);
4248                 match fail_commit[0] {
4249                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4250                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4251                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4252                         },
4253                         _ => unreachable!(),
4254                 }
4255                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4256                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4257         } else {
4258                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4259         }
4260 }
4261
4262 #[test]
4263 fn test_holding_cell_htlc_add_timeouts() {
4264         do_test_holding_cell_htlc_add_timeouts(false);
4265         do_test_holding_cell_htlc_add_timeouts(true);
4266 }
4267
4268 #[test]
4269 fn test_invalid_channel_announcement() {
4270         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4271         let secp_ctx = Secp256k1::new();
4272         let chanmon_cfgs = create_chanmon_cfgs(2);
4273         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4274         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4275         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4276
4277         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4278
4279         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4280         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4281         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4282         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4283
4284         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 } );
4285
4286         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4287         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4288
4289         let as_network_key = nodes[0].node.get_our_node_id();
4290         let bs_network_key = nodes[1].node.get_our_node_id();
4291
4292         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4293
4294         let mut chan_announcement;
4295
4296         macro_rules! dummy_unsigned_msg {
4297                 () => {
4298                         msgs::UnsignedChannelAnnouncement {
4299                                 features: ChannelFeatures::known(),
4300                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4301                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4302                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4303                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4304                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4305                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4306                                 excess_data: Vec::new(),
4307                         };
4308                 }
4309         }
4310
4311         macro_rules! sign_msg {
4312                 ($unsigned_msg: expr) => {
4313                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4314                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4315                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4316                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4317                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4318                         chan_announcement = msgs::ChannelAnnouncement {
4319                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4320                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4321                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4322                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4323                                 contents: $unsigned_msg
4324                         }
4325                 }
4326         }
4327
4328         let unsigned_msg = dummy_unsigned_msg!();
4329         sign_msg!(unsigned_msg);
4330         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4331         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 } );
4332
4333         // Configured with Network::Testnet
4334         let mut unsigned_msg = dummy_unsigned_msg!();
4335         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4336         sign_msg!(unsigned_msg);
4337         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4338
4339         let mut unsigned_msg = dummy_unsigned_msg!();
4340         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4341         sign_msg!(unsigned_msg);
4342         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4343 }
4344
4345 #[test]
4346 fn test_no_txn_manager_serialize_deserialize() {
4347         let chanmon_cfgs = create_chanmon_cfgs(2);
4348         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4349         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4350         let logger: test_utils::TestLogger;
4351         let fee_estimator: test_utils::TestFeeEstimator;
4352         let persister: test_utils::TestPersister;
4353         let new_chain_monitor: test_utils::TestChainMonitor;
4354         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4355         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4356
4357         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4358
4359         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4360
4361         let nodes_0_serialized = nodes[0].node.encode();
4362         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4363         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4364
4365         logger = test_utils::TestLogger::new();
4366         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4367         persister = test_utils::TestPersister::new();
4368         let keys_manager = &chanmon_cfgs[0].keys_manager;
4369         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4370         nodes[0].chain_monitor = &new_chain_monitor;
4371         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4372         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4373                 &mut chan_0_monitor_read, keys_manager).unwrap();
4374         assert!(chan_0_monitor_read.is_empty());
4375
4376         let mut nodes_0_read = &nodes_0_serialized[..];
4377         let config = UserConfig::default();
4378         let (_, nodes_0_deserialized_tmp) = {
4379                 let mut channel_monitors = HashMap::new();
4380                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4381                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4382                         default_config: config,
4383                         keys_manager,
4384                         fee_estimator: &fee_estimator,
4385                         chain_monitor: nodes[0].chain_monitor,
4386                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4387                         logger: &logger,
4388                         channel_monitors,
4389                 }).unwrap()
4390         };
4391         nodes_0_deserialized = nodes_0_deserialized_tmp;
4392         assert!(nodes_0_read.is_empty());
4393
4394         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4395         nodes[0].node = &nodes_0_deserialized;
4396         assert_eq!(nodes[0].node.list_channels().len(), 1);
4397         check_added_monitors!(nodes[0], 1);
4398
4399         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4400         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4401         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4402         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4403
4404         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4405         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4406         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4407         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4408
4409         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4410         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4411         for node in nodes.iter() {
4412                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4413                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4414                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4415         }
4416
4417         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4418 }
4419
4420 #[test]
4421 fn test_dup_htlc_onchain_fails_on_reload() {
4422         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4423         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4424         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4425         // the ChannelMonitor tells it to.
4426         //
4427         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4428         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4429         // PaymentFailed event appearing). However, because we may not serialize the relevant
4430         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4431         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4432         // and de-duplicates ChannelMonitor events.
4433         //
4434         // This tests that explicit tracking behavior.
4435         let chanmon_cfgs = create_chanmon_cfgs(2);
4436         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4437         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4438         let persister: test_utils::TestPersister;
4439         let new_chain_monitor: test_utils::TestChainMonitor;
4440         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4441         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4442
4443         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4444
4445         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4446         // nodes[0].
4447         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4448         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4449         check_closed_broadcast!(nodes[0], true);
4450         check_added_monitors!(nodes[0], 1);
4451
4452         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4453         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4454
4455         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4456         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4457         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4458         assert_eq!(node_txn.len(), 3);
4459         assert_eq!(node_txn[0], node_txn[1]);
4460
4461         assert!(nodes[1].node.claim_funds(payment_preimage));
4462         check_added_monitors!(nodes[1], 1);
4463
4464         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4465         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4466         check_closed_broadcast!(nodes[1], true);
4467         check_added_monitors!(nodes[1], 1);
4468         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4469
4470         header.prev_blockhash = nodes[0].best_block_hash();
4471         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4472
4473         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4474         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4475         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4476         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4477         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4478
4479         header.prev_blockhash = nodes[0].best_block_hash();
4480         let claim_block = Block { header, txdata: claim_txn};
4481         connect_block(&nodes[0], &claim_block);
4482         expect_payment_sent!(nodes[0], payment_preimage);
4483
4484         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4485         // connected a highly-relevant block, it likely gets serialized out now.
4486         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4487         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4488
4489         // Now reload nodes[0]...
4490         persister = test_utils::TestPersister::new();
4491         let keys_manager = &chanmon_cfgs[0].keys_manager;
4492         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);
4493         nodes[0].chain_monitor = &new_chain_monitor;
4494         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4495         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4496                 &mut chan_0_monitor_read, keys_manager).unwrap();
4497         assert!(chan_0_monitor_read.is_empty());
4498
4499         let (_, nodes_0_deserialized_tmp) = {
4500                 let mut channel_monitors = HashMap::new();
4501                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4502                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4503                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4504                                 default_config: Default::default(),
4505                                 keys_manager,
4506                                 fee_estimator: node_cfgs[0].fee_estimator,
4507                                 chain_monitor: nodes[0].chain_monitor,
4508                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4509                                 logger: nodes[0].logger,
4510                                 channel_monitors,
4511                         }).unwrap()
4512         };
4513         nodes_0_deserialized = nodes_0_deserialized_tmp;
4514
4515         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4516         check_added_monitors!(nodes[0], 1);
4517         nodes[0].node = &nodes_0_deserialized;
4518
4519         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4520         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4521         // payment events should kick in, leaving us with no pending events here.
4522         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4523         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4524         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4525 }
4526
4527 #[test]
4528 fn test_manager_serialize_deserialize_events() {
4529         // This test makes sure the events field in ChannelManager survives de/serialization
4530         let chanmon_cfgs = create_chanmon_cfgs(2);
4531         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4533         let fee_estimator: test_utils::TestFeeEstimator;
4534         let persister: test_utils::TestPersister;
4535         let logger: test_utils::TestLogger;
4536         let new_chain_monitor: test_utils::TestChainMonitor;
4537         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4538         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4539
4540         // Start creating a channel, but stop right before broadcasting the funding transaction
4541         let channel_value = 100000;
4542         let push_msat = 10001;
4543         let a_flags = InitFeatures::known();
4544         let b_flags = InitFeatures::known();
4545         let node_a = nodes.remove(0);
4546         let node_b = nodes.remove(0);
4547         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4548         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()));
4549         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()));
4550
4551         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4552
4553         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4554         check_added_monitors!(node_a, 0);
4555
4556         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()));
4557         {
4558                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4559                 assert_eq!(added_monitors.len(), 1);
4560                 assert_eq!(added_monitors[0].0, funding_output);
4561                 added_monitors.clear();
4562         }
4563
4564         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()));
4565         {
4566                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4567                 assert_eq!(added_monitors.len(), 1);
4568                 assert_eq!(added_monitors[0].0, funding_output);
4569                 added_monitors.clear();
4570         }
4571         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4572
4573         nodes.push(node_a);
4574         nodes.push(node_b);
4575
4576         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4577         let nodes_0_serialized = nodes[0].node.encode();
4578         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4579         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4580
4581         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4582         logger = test_utils::TestLogger::new();
4583         persister = test_utils::TestPersister::new();
4584         let keys_manager = &chanmon_cfgs[0].keys_manager;
4585         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4586         nodes[0].chain_monitor = &new_chain_monitor;
4587         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4588         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4589                 &mut chan_0_monitor_read, keys_manager).unwrap();
4590         assert!(chan_0_monitor_read.is_empty());
4591
4592         let mut nodes_0_read = &nodes_0_serialized[..];
4593         let config = UserConfig::default();
4594         let (_, nodes_0_deserialized_tmp) = {
4595                 let mut channel_monitors = HashMap::new();
4596                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4597                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4598                         default_config: config,
4599                         keys_manager,
4600                         fee_estimator: &fee_estimator,
4601                         chain_monitor: nodes[0].chain_monitor,
4602                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4603                         logger: &logger,
4604                         channel_monitors,
4605                 }).unwrap()
4606         };
4607         nodes_0_deserialized = nodes_0_deserialized_tmp;
4608         assert!(nodes_0_read.is_empty());
4609
4610         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4611
4612         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4613         nodes[0].node = &nodes_0_deserialized;
4614
4615         // After deserializing, make sure the funding_transaction is still held by the channel manager
4616         let events_4 = nodes[0].node.get_and_clear_pending_events();
4617         assert_eq!(events_4.len(), 0);
4618         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4619         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4620
4621         // Make sure the channel is functioning as though the de/serialization never happened
4622         assert_eq!(nodes[0].node.list_channels().len(), 1);
4623         check_added_monitors!(nodes[0], 1);
4624
4625         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4626         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4627         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4628         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4629
4630         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4631         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4632         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4633         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4634
4635         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4636         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4637         for node in nodes.iter() {
4638                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4639                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4640                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4641         }
4642
4643         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4644 }
4645
4646 #[test]
4647 fn test_simple_manager_serialize_deserialize() {
4648         let chanmon_cfgs = create_chanmon_cfgs(2);
4649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4651         let logger: test_utils::TestLogger;
4652         let fee_estimator: test_utils::TestFeeEstimator;
4653         let persister: test_utils::TestPersister;
4654         let new_chain_monitor: test_utils::TestChainMonitor;
4655         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4656         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4657         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4658
4659         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4660         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4661
4662         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4663
4664         let nodes_0_serialized = nodes[0].node.encode();
4665         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4666         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4667
4668         logger = test_utils::TestLogger::new();
4669         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4670         persister = test_utils::TestPersister::new();
4671         let keys_manager = &chanmon_cfgs[0].keys_manager;
4672         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4673         nodes[0].chain_monitor = &new_chain_monitor;
4674         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4675         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4676                 &mut chan_0_monitor_read, keys_manager).unwrap();
4677         assert!(chan_0_monitor_read.is_empty());
4678
4679         let mut nodes_0_read = &nodes_0_serialized[..];
4680         let (_, nodes_0_deserialized_tmp) = {
4681                 let mut channel_monitors = HashMap::new();
4682                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4683                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4684                         default_config: UserConfig::default(),
4685                         keys_manager,
4686                         fee_estimator: &fee_estimator,
4687                         chain_monitor: nodes[0].chain_monitor,
4688                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4689                         logger: &logger,
4690                         channel_monitors,
4691                 }).unwrap()
4692         };
4693         nodes_0_deserialized = nodes_0_deserialized_tmp;
4694         assert!(nodes_0_read.is_empty());
4695
4696         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4697         nodes[0].node = &nodes_0_deserialized;
4698         check_added_monitors!(nodes[0], 1);
4699
4700         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4701
4702         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4703         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4704 }
4705
4706 #[test]
4707 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4708         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4709         let chanmon_cfgs = create_chanmon_cfgs(4);
4710         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4711         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4712         let logger: test_utils::TestLogger;
4713         let fee_estimator: test_utils::TestFeeEstimator;
4714         let persister: test_utils::TestPersister;
4715         let new_chain_monitor: test_utils::TestChainMonitor;
4716         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4717         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4718         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4719         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4720         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4721
4722         let mut node_0_stale_monitors_serialized = Vec::new();
4723         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4724                 let mut writer = test_utils::TestVecWriter(Vec::new());
4725                 monitor.1.write(&mut writer).unwrap();
4726                 node_0_stale_monitors_serialized.push(writer.0);
4727         }
4728
4729         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4730
4731         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4732         let nodes_0_serialized = nodes[0].node.encode();
4733
4734         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4735         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4736         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4737         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4738
4739         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4740         // nodes[3])
4741         let mut node_0_monitors_serialized = Vec::new();
4742         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4743                 let mut writer = test_utils::TestVecWriter(Vec::new());
4744                 monitor.1.write(&mut writer).unwrap();
4745                 node_0_monitors_serialized.push(writer.0);
4746         }
4747
4748         logger = test_utils::TestLogger::new();
4749         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4750         persister = test_utils::TestPersister::new();
4751         let keys_manager = &chanmon_cfgs[0].keys_manager;
4752         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4753         nodes[0].chain_monitor = &new_chain_monitor;
4754
4755
4756         let mut node_0_stale_monitors = Vec::new();
4757         for serialized in node_0_stale_monitors_serialized.iter() {
4758                 let mut read = &serialized[..];
4759                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4760                 assert!(read.is_empty());
4761                 node_0_stale_monitors.push(monitor);
4762         }
4763
4764         let mut node_0_monitors = Vec::new();
4765         for serialized in node_0_monitors_serialized.iter() {
4766                 let mut read = &serialized[..];
4767                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4768                 assert!(read.is_empty());
4769                 node_0_monitors.push(monitor);
4770         }
4771
4772         let mut nodes_0_read = &nodes_0_serialized[..];
4773         if let Err(msgs::DecodeError::InvalidValue) =
4774                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4775                 default_config: UserConfig::default(),
4776                 keys_manager,
4777                 fee_estimator: &fee_estimator,
4778                 chain_monitor: nodes[0].chain_monitor,
4779                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4780                 logger: &logger,
4781                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4782         }) { } else {
4783                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4784         };
4785
4786         let mut nodes_0_read = &nodes_0_serialized[..];
4787         let (_, nodes_0_deserialized_tmp) =
4788                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4789                 default_config: UserConfig::default(),
4790                 keys_manager,
4791                 fee_estimator: &fee_estimator,
4792                 chain_monitor: nodes[0].chain_monitor,
4793                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4794                 logger: &logger,
4795                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4796         }).unwrap();
4797         nodes_0_deserialized = nodes_0_deserialized_tmp;
4798         assert!(nodes_0_read.is_empty());
4799
4800         { // Channel close should result in a commitment tx
4801                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4802                 assert_eq!(txn.len(), 1);
4803                 check_spends!(txn[0], funding_tx);
4804                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4805         }
4806
4807         for monitor in node_0_monitors.drain(..) {
4808                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4809                 check_added_monitors!(nodes[0], 1);
4810         }
4811         nodes[0].node = &nodes_0_deserialized;
4812
4813         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4814         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4815         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4816         //... and we can even still claim the payment!
4817         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4818
4819         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4820         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4821         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4822         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4823         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4824         assert_eq!(msg_events.len(), 1);
4825         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4826                 match action {
4827                         &ErrorAction::SendErrorMessage { ref msg } => {
4828                                 assert_eq!(msg.channel_id, channel_id);
4829                         },
4830                         _ => panic!("Unexpected event!"),
4831                 }
4832         }
4833 }
4834
4835 macro_rules! check_spendable_outputs {
4836         ($node: expr, $keysinterface: expr) => {
4837                 {
4838                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4839                         let mut txn = Vec::new();
4840                         let mut all_outputs = Vec::new();
4841                         let secp_ctx = Secp256k1::new();
4842                         for event in events.drain(..) {
4843                                 match event {
4844                                         Event::SpendableOutputs { mut outputs } => {
4845                                                 for outp in outputs.drain(..) {
4846                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4847                                                         all_outputs.push(outp);
4848                                                 }
4849                                         },
4850                                         _ => panic!("Unexpected event"),
4851                                 };
4852                         }
4853                         if all_outputs.len() > 1 {
4854                                 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) {
4855                                         txn.push(tx);
4856                                 }
4857                         }
4858                         txn
4859                 }
4860         }
4861 }
4862
4863 #[test]
4864 fn test_claim_sizeable_push_msat() {
4865         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4866         let chanmon_cfgs = create_chanmon_cfgs(2);
4867         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4868         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4869         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4870
4871         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4872         nodes[1].node.force_close_channel(&chan.2).unwrap();
4873         check_closed_broadcast!(nodes[1], true);
4874         check_added_monitors!(nodes[1], 1);
4875         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4876         assert_eq!(node_txn.len(), 1);
4877         check_spends!(node_txn[0], chan.3);
4878         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
4879
4880         mine_transaction(&nodes[1], &node_txn[0]);
4881         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4882
4883         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4884         assert_eq!(spend_txn.len(), 1);
4885         assert_eq!(spend_txn[0].input.len(), 1);
4886         check_spends!(spend_txn[0], node_txn[0]);
4887         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4888 }
4889
4890 #[test]
4891 fn test_claim_on_remote_sizeable_push_msat() {
4892         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4893         // to_remote output is encumbered by a P2WPKH
4894         let chanmon_cfgs = create_chanmon_cfgs(2);
4895         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4896         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4897         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4898
4899         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4900         nodes[0].node.force_close_channel(&chan.2).unwrap();
4901         check_closed_broadcast!(nodes[0], true);
4902         check_added_monitors!(nodes[0], 1);
4903
4904         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4905         assert_eq!(node_txn.len(), 1);
4906         check_spends!(node_txn[0], chan.3);
4907         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
4908
4909         mine_transaction(&nodes[1], &node_txn[0]);
4910         check_closed_broadcast!(nodes[1], true);
4911         check_added_monitors!(nodes[1], 1);
4912         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4913
4914         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4915         assert_eq!(spend_txn.len(), 1);
4916         check_spends!(spend_txn[0], node_txn[0]);
4917 }
4918
4919 #[test]
4920 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4921         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4922         // to_remote output is encumbered by a P2WPKH
4923
4924         let chanmon_cfgs = create_chanmon_cfgs(2);
4925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4927         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4928
4929         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4930         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4931         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4932         assert_eq!(revoked_local_txn[0].input.len(), 1);
4933         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4934
4935         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4936         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4937         check_closed_broadcast!(nodes[1], true);
4938         check_added_monitors!(nodes[1], 1);
4939
4940         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4941         mine_transaction(&nodes[1], &node_txn[0]);
4942         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4943
4944         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4945         assert_eq!(spend_txn.len(), 3);
4946         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4947         check_spends!(spend_txn[1], node_txn[0]);
4948         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4949 }
4950
4951 #[test]
4952 fn test_static_spendable_outputs_preimage_tx() {
4953         let chanmon_cfgs = create_chanmon_cfgs(2);
4954         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4955         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4956         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4957
4958         // Create some initial channels
4959         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4960
4961         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4962
4963         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4964         assert_eq!(commitment_tx[0].input.len(), 1);
4965         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4966
4967         // Settle A's commitment tx on B's chain
4968         assert!(nodes[1].node.claim_funds(payment_preimage));
4969         check_added_monitors!(nodes[1], 1);
4970         mine_transaction(&nodes[1], &commitment_tx[0]);
4971         check_added_monitors!(nodes[1], 1);
4972         let events = nodes[1].node.get_and_clear_pending_msg_events();
4973         match events[0] {
4974                 MessageSendEvent::UpdateHTLCs { .. } => {},
4975                 _ => panic!("Unexpected event"),
4976         }
4977         match events[1] {
4978                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4979                 _ => panic!("Unexepected event"),
4980         }
4981
4982         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4983         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4984         assert_eq!(node_txn.len(), 3);
4985         check_spends!(node_txn[0], commitment_tx[0]);
4986         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4987         check_spends!(node_txn[1], chan_1.3);
4988         check_spends!(node_txn[2], node_txn[1]);
4989
4990         mine_transaction(&nodes[1], &node_txn[0]);
4991         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4992
4993         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4994         assert_eq!(spend_txn.len(), 1);
4995         check_spends!(spend_txn[0], node_txn[0]);
4996 }
4997
4998 #[test]
4999 fn test_static_spendable_outputs_timeout_tx() {
5000         let chanmon_cfgs = create_chanmon_cfgs(2);
5001         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5002         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5003         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5004
5005         // Create some initial channels
5006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5007
5008         // Rebalance the network a bit by relaying one payment through all the channels ...
5009         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5010
5011         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5012
5013         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5014         assert_eq!(commitment_tx[0].input.len(), 1);
5015         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5016
5017         // Settle A's commitment tx on B' chain
5018         mine_transaction(&nodes[1], &commitment_tx[0]);
5019         check_added_monitors!(nodes[1], 1);
5020         let events = nodes[1].node.get_and_clear_pending_msg_events();
5021         match events[0] {
5022                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5023                 _ => panic!("Unexpected event"),
5024         }
5025         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5026
5027         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5028         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5029         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5030         check_spends!(node_txn[0], chan_1.3.clone());
5031         check_spends!(node_txn[1],  commitment_tx[0].clone());
5032         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5033
5034         mine_transaction(&nodes[1], &node_txn[1]);
5035         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5036         expect_payment_failed!(nodes[1], our_payment_hash, true);
5037
5038         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5039         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5040         check_spends!(spend_txn[0], commitment_tx[0]);
5041         check_spends!(spend_txn[1], node_txn[1]);
5042         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5043 }
5044
5045 #[test]
5046 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5047         let chanmon_cfgs = create_chanmon_cfgs(2);
5048         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5051
5052         // Create some initial channels
5053         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5054
5055         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5056         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5057         assert_eq!(revoked_local_txn[0].input.len(), 1);
5058         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5059
5060         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5061
5062         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5063         check_closed_broadcast!(nodes[1], true);
5064         check_added_monitors!(nodes[1], 1);
5065
5066         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5067         assert_eq!(node_txn.len(), 2);
5068         assert_eq!(node_txn[0].input.len(), 2);
5069         check_spends!(node_txn[0], revoked_local_txn[0]);
5070
5071         mine_transaction(&nodes[1], &node_txn[0]);
5072         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5073
5074         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5075         assert_eq!(spend_txn.len(), 1);
5076         check_spends!(spend_txn[0], node_txn[0]);
5077 }
5078
5079 #[test]
5080 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5081         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5082         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5083         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5084         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5085         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5086
5087         // Create some initial channels
5088         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5089
5090         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5091         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5092         assert_eq!(revoked_local_txn[0].input.len(), 1);
5093         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5094
5095         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5096
5097         // A will generate HTLC-Timeout from revoked commitment tx
5098         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5099         check_closed_broadcast!(nodes[0], true);
5100         check_added_monitors!(nodes[0], 1);
5101         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5102
5103         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5104         assert_eq!(revoked_htlc_txn.len(), 2);
5105         check_spends!(revoked_htlc_txn[0], chan_1.3);
5106         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5107         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5108         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5109         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5110
5111         // B will generate justice tx from A's revoked commitment/HTLC tx
5112         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5113         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5114         check_closed_broadcast!(nodes[1], true);
5115         check_added_monitors!(nodes[1], 1);
5116
5117         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5118         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5119         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5120         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5121         // transactions next...
5122         assert_eq!(node_txn[0].input.len(), 3);
5123         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5124
5125         assert_eq!(node_txn[1].input.len(), 2);
5126         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5127         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5128                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5129         } else {
5130                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5131                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5132         }
5133
5134         assert_eq!(node_txn[2].input.len(), 1);
5135         check_spends!(node_txn[2], chan_1.3);
5136
5137         mine_transaction(&nodes[1], &node_txn[1]);
5138         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5139
5140         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5141         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5142         assert_eq!(spend_txn.len(), 1);
5143         assert_eq!(spend_txn[0].input.len(), 1);
5144         check_spends!(spend_txn[0], node_txn[1]);
5145 }
5146
5147 #[test]
5148 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5149         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5150         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5151         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5152         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5153         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5154
5155         // Create some initial channels
5156         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5157
5158         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5159         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5160         assert_eq!(revoked_local_txn[0].input.len(), 1);
5161         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5162
5163         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5164         assert_eq!(revoked_local_txn[0].output.len(), 2);
5165
5166         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5167
5168         // B will generate HTLC-Success from revoked commitment tx
5169         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5170         check_closed_broadcast!(nodes[1], true);
5171         check_added_monitors!(nodes[1], 1);
5172         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5173
5174         assert_eq!(revoked_htlc_txn.len(), 2);
5175         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5176         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5177         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5178
5179         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5180         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5181         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5182
5183         // A will generate justice tx from B's revoked commitment/HTLC tx
5184         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5185         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5186         check_closed_broadcast!(nodes[0], true);
5187         check_added_monitors!(nodes[0], 1);
5188
5189         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5190         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5191
5192         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5193         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5194         // transactions next...
5195         assert_eq!(node_txn[0].input.len(), 2);
5196         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5197         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5198                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5199         } else {
5200                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5201                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5202         }
5203
5204         assert_eq!(node_txn[1].input.len(), 1);
5205         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5206
5207         check_spends!(node_txn[2], chan_1.3);
5208
5209         mine_transaction(&nodes[0], &node_txn[1]);
5210         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5211
5212         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5213         // didn't try to generate any new transactions.
5214
5215         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5216         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5217         assert_eq!(spend_txn.len(), 3);
5218         assert_eq!(spend_txn[0].input.len(), 1);
5219         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5220         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5221         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5222         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5223 }
5224
5225 #[test]
5226 fn test_onchain_to_onchain_claim() {
5227         // Test that in case of channel closure, we detect the state of output and claim HTLC
5228         // on downstream peer's remote commitment tx.
5229         // First, have C claim an HTLC against its own latest commitment transaction.
5230         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5231         // channel.
5232         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5233         // gets broadcast.
5234
5235         let chanmon_cfgs = create_chanmon_cfgs(3);
5236         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5237         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5238         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5239
5240         // Create some initial channels
5241         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5242         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5243
5244         // Ensure all nodes are at the same height
5245         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5246         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5247         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5248         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5249
5250         // Rebalance the network a bit by relaying one payment through all the channels ...
5251         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5252         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5253
5254         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5255         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5256         check_spends!(commitment_tx[0], chan_2.3);
5257         nodes[2].node.claim_funds(payment_preimage);
5258         check_added_monitors!(nodes[2], 1);
5259         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5260         assert!(updates.update_add_htlcs.is_empty());
5261         assert!(updates.update_fail_htlcs.is_empty());
5262         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5263         assert!(updates.update_fail_malformed_htlcs.is_empty());
5264
5265         mine_transaction(&nodes[2], &commitment_tx[0]);
5266         check_closed_broadcast!(nodes[2], true);
5267         check_added_monitors!(nodes[2], 1);
5268
5269         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5270         assert_eq!(c_txn.len(), 3);
5271         assert_eq!(c_txn[0], c_txn[2]);
5272         assert_eq!(commitment_tx[0], c_txn[1]);
5273         check_spends!(c_txn[1], chan_2.3);
5274         check_spends!(c_txn[2], c_txn[1]);
5275         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5276         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5277         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5278         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5279
5280         // 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
5281         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5282         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5283         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5284         {
5285                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5286                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5287                 assert_eq!(b_txn.len(), 2);
5288                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5289                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5290                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5291                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5292                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5293                 b_txn.clear();
5294         }
5295         check_added_monitors!(nodes[1], 1);
5296         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5297         assert_eq!(msg_events.len(), 3);
5298         check_added_monitors!(nodes[1], 1);
5299         match msg_events[0] {
5300                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5301                 _ => panic!("Unexpected event"),
5302         }
5303         match msg_events[1] {
5304                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5305                 _ => panic!("Unexpected event"),
5306         }
5307         match msg_events[2] {
5308                 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, .. } } => {
5309                         assert!(update_add_htlcs.is_empty());
5310                         assert!(update_fail_htlcs.is_empty());
5311                         assert_eq!(update_fulfill_htlcs.len(), 1);
5312                         assert!(update_fail_malformed_htlcs.is_empty());
5313                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5314                 },
5315                 _ => panic!("Unexpected event"),
5316         };
5317         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5318         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5319         mine_transaction(&nodes[1], &commitment_tx[0]);
5320         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5321         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5322         assert_eq!(b_txn.len(), 4);
5323         check_spends!(b_txn[2], chan_1.3);
5324         check_spends!(b_txn[3], b_txn[2]);
5325         let (htlc_success_claim, htlc_timeout_bumped) =
5326                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5327                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5328         check_spends!(htlc_success_claim, commitment_tx[0]);
5329         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5330         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5331         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5332         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5333         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5334
5335         check_closed_broadcast!(nodes[1], true);
5336         check_added_monitors!(nodes[1], 1);
5337 }
5338
5339 #[test]
5340 fn test_duplicate_payment_hash_one_failure_one_success() {
5341         // Topology : A --> B --> C --> D
5342         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5343         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5344         // we forward one of the payments onwards to D.
5345         let chanmon_cfgs = create_chanmon_cfgs(4);
5346         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5347         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5348         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5349
5350         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5351         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5352         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5353
5354         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5355         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5356         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5357         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5358         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5359
5360         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5361
5362         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5363         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5364         // script push size limit so that the below script length checks match
5365         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5366         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5367                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5368         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5369
5370         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5371         assert_eq!(commitment_txn[0].input.len(), 1);
5372         check_spends!(commitment_txn[0], chan_2.3);
5373
5374         mine_transaction(&nodes[1], &commitment_txn[0]);
5375         check_closed_broadcast!(nodes[1], true);
5376         check_added_monitors!(nodes[1], 1);
5377         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5378
5379         let htlc_timeout_tx;
5380         { // Extract one of the two HTLC-Timeout transaction
5381                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5382                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5383                 assert_eq!(node_txn.len(), 4);
5384                 check_spends!(node_txn[0], chan_2.3);
5385
5386                 check_spends!(node_txn[1], commitment_txn[0]);
5387                 assert_eq!(node_txn[1].input.len(), 1);
5388                 check_spends!(node_txn[2], commitment_txn[0]);
5389                 assert_eq!(node_txn[2].input.len(), 1);
5390                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5391                 check_spends!(node_txn[3], commitment_txn[0]);
5392                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5393
5394                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5395                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5396                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5397                 htlc_timeout_tx = node_txn[1].clone();
5398         }
5399
5400         nodes[2].node.claim_funds(our_payment_preimage);
5401         mine_transaction(&nodes[2], &commitment_txn[0]);
5402         check_added_monitors!(nodes[2], 2);
5403         let events = nodes[2].node.get_and_clear_pending_msg_events();
5404         match events[0] {
5405                 MessageSendEvent::UpdateHTLCs { .. } => {},
5406                 _ => panic!("Unexpected event"),
5407         }
5408         match events[1] {
5409                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5410                 _ => panic!("Unexepected event"),
5411         }
5412         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5413         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)
5414         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5415         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5416         assert_eq!(htlc_success_txn[0].input.len(), 1);
5417         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5418         assert_eq!(htlc_success_txn[1].input.len(), 1);
5419         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5420         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5421         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5422         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5423         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5424         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5425
5426         mine_transaction(&nodes[1], &htlc_timeout_tx);
5427         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5428         expect_pending_htlcs_forwardable!(nodes[1]);
5429         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5430         assert!(htlc_updates.update_add_htlcs.is_empty());
5431         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5432         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5433         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5434         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5435         check_added_monitors!(nodes[1], 1);
5436
5437         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5438         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5439         {
5440                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5441                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5442         }
5443         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5444
5445         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5446         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5447         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5448         assert!(updates.update_add_htlcs.is_empty());
5449         assert!(updates.update_fail_htlcs.is_empty());
5450         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5451         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5452         assert!(updates.update_fail_malformed_htlcs.is_empty());
5453         check_added_monitors!(nodes[1], 1);
5454
5455         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5456         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5457
5458         let events = nodes[0].node.get_and_clear_pending_events();
5459         match events[0] {
5460                 Event::PaymentSent { ref payment_preimage } => {
5461                         assert_eq!(*payment_preimage, our_payment_preimage);
5462                 }
5463                 _ => panic!("Unexpected event"),
5464         }
5465 }
5466
5467 #[test]
5468 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5469         let chanmon_cfgs = create_chanmon_cfgs(2);
5470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5472         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5473
5474         // Create some initial channels
5475         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5476
5477         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5478         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5479         assert_eq!(local_txn.len(), 1);
5480         assert_eq!(local_txn[0].input.len(), 1);
5481         check_spends!(local_txn[0], chan_1.3);
5482
5483         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5484         nodes[1].node.claim_funds(payment_preimage);
5485         check_added_monitors!(nodes[1], 1);
5486         mine_transaction(&nodes[1], &local_txn[0]);
5487         check_added_monitors!(nodes[1], 1);
5488         let events = nodes[1].node.get_and_clear_pending_msg_events();
5489         match events[0] {
5490                 MessageSendEvent::UpdateHTLCs { .. } => {},
5491                 _ => panic!("Unexpected event"),
5492         }
5493         match events[1] {
5494                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5495                 _ => panic!("Unexepected event"),
5496         }
5497         let node_tx = {
5498                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5499                 assert_eq!(node_txn.len(), 3);
5500                 assert_eq!(node_txn[0], node_txn[2]);
5501                 assert_eq!(node_txn[1], local_txn[0]);
5502                 assert_eq!(node_txn[0].input.len(), 1);
5503                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5504                 check_spends!(node_txn[0], local_txn[0]);
5505                 node_txn[0].clone()
5506         };
5507
5508         mine_transaction(&nodes[1], &node_tx);
5509         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5510
5511         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5512         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5513         assert_eq!(spend_txn.len(), 1);
5514         assert_eq!(spend_txn[0].input.len(), 1);
5515         check_spends!(spend_txn[0], node_tx);
5516         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5517 }
5518
5519 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5520         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5521         // unrevoked commitment transaction.
5522         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5523         // a remote RAA before they could be failed backwards (and combinations thereof).
5524         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5525         // use the same payment hashes.
5526         // Thus, we use a six-node network:
5527         //
5528         // A \         / E
5529         //    - C - D -
5530         // B /         \ F
5531         // And test where C fails back to A/B when D announces its latest commitment transaction
5532         let chanmon_cfgs = create_chanmon_cfgs(6);
5533         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5534         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5535         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5536         let logger = test_utils::TestLogger::new();
5537
5538         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5539         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5540         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5541         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5542         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5543
5544         // Rebalance and check output sanity...
5545         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5546         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5547         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5548
5549         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5550         // 0th HTLC:
5551         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
5552         // 1st HTLC:
5553         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
5554         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5555         let our_node_id = &nodes[1].node.get_our_node_id();
5556         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();
5557         // 2nd HTLC:
5558         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
5559         // 3rd HTLC:
5560         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
5561         // 4th HTLC:
5562         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5563         // 5th HTLC:
5564         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5565         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();
5566         // 6th HTLC:
5567         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());
5568         // 7th HTLC:
5569         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());
5570
5571         // 8th HTLC:
5572         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5573         // 9th HTLC:
5574         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();
5575         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
5576
5577         // 10th HTLC:
5578         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
5579         // 11th HTLC:
5580         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();
5581         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());
5582
5583         // Double-check that six of the new HTLC were added
5584         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5585         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5586         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5587         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5588
5589         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5590         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5591         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5592         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5593         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5594         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5595         check_added_monitors!(nodes[4], 0);
5596         expect_pending_htlcs_forwardable!(nodes[4]);
5597         check_added_monitors!(nodes[4], 1);
5598
5599         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5600         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5601         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5602         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5603         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5604         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5605
5606         // Fail 3rd below-dust and 7th above-dust HTLCs
5607         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5608         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5609         check_added_monitors!(nodes[5], 0);
5610         expect_pending_htlcs_forwardable!(nodes[5]);
5611         check_added_monitors!(nodes[5], 1);
5612
5613         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5614         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5615         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5616         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5617
5618         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5619
5620         expect_pending_htlcs_forwardable!(nodes[3]);
5621         check_added_monitors!(nodes[3], 1);
5622         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5623         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5624         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5625         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5626         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5627         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5628         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5629         if deliver_last_raa {
5630                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5631         } else {
5632                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5633         }
5634
5635         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5636         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5637         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5638         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5639         //
5640         // We now broadcast the latest commitment transaction, which *should* result in failures for
5641         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5642         // the non-broadcast above-dust HTLCs.
5643         //
5644         // Alternatively, we may broadcast the previous commitment transaction, which should only
5645         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5646         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5647
5648         if announce_latest {
5649                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5650         } else {
5651                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5652         }
5653         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5654         check_closed_broadcast!(nodes[2], true);
5655         expect_pending_htlcs_forwardable!(nodes[2]);
5656         check_added_monitors!(nodes[2], 3);
5657
5658         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5659         assert_eq!(cs_msgs.len(), 2);
5660         let mut a_done = false;
5661         for msg in cs_msgs {
5662                 match msg {
5663                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5664                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5665                                 // should be failed-backwards here.
5666                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5667                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5668                                         for htlc in &updates.update_fail_htlcs {
5669                                                 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 });
5670                                         }
5671                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5672                                         assert!(!a_done);
5673                                         a_done = true;
5674                                         &nodes[0]
5675                                 } else {
5676                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5677                                         for htlc in &updates.update_fail_htlcs {
5678                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5679                                         }
5680                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5681                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5682                                         &nodes[1]
5683                                 };
5684                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5685                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5686                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5687                                 if announce_latest {
5688                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5689                                         if *node_id == nodes[0].node.get_our_node_id() {
5690                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5691                                         }
5692                                 }
5693                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5694                         },
5695                         _ => panic!("Unexpected event"),
5696                 }
5697         }
5698
5699         let as_events = nodes[0].node.get_and_clear_pending_events();
5700         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5701         let mut as_failds = HashSet::new();
5702         for event in as_events.iter() {
5703                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5704                         assert!(as_failds.insert(*payment_hash));
5705                         if *payment_hash != payment_hash_2 {
5706                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5707                         } else {
5708                                 assert!(!rejected_by_dest);
5709                         }
5710                 } else { panic!("Unexpected event"); }
5711         }
5712         assert!(as_failds.contains(&payment_hash_1));
5713         assert!(as_failds.contains(&payment_hash_2));
5714         if announce_latest {
5715                 assert!(as_failds.contains(&payment_hash_3));
5716                 assert!(as_failds.contains(&payment_hash_5));
5717         }
5718         assert!(as_failds.contains(&payment_hash_6));
5719
5720         let bs_events = nodes[1].node.get_and_clear_pending_events();
5721         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5722         let mut bs_failds = HashSet::new();
5723         for event in bs_events.iter() {
5724                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5725                         assert!(bs_failds.insert(*payment_hash));
5726                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5727                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5728                         } else {
5729                                 assert!(!rejected_by_dest);
5730                         }
5731                 } else { panic!("Unexpected event"); }
5732         }
5733         assert!(bs_failds.contains(&payment_hash_1));
5734         assert!(bs_failds.contains(&payment_hash_2));
5735         if announce_latest {
5736                 assert!(bs_failds.contains(&payment_hash_4));
5737         }
5738         assert!(bs_failds.contains(&payment_hash_5));
5739
5740         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5741         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5742         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5743         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5744         // PaymentFailureNetworkUpdates.
5745         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5746         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5747         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5748         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5749         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5750                 match event {
5751                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5752                         _ => panic!("Unexpected event"),
5753                 }
5754         }
5755 }
5756
5757 #[test]
5758 fn test_fail_backwards_latest_remote_announce_a() {
5759         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5760 }
5761
5762 #[test]
5763 fn test_fail_backwards_latest_remote_announce_b() {
5764         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5765 }
5766
5767 #[test]
5768 fn test_fail_backwards_previous_remote_announce() {
5769         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5770         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5771         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5772 }
5773
5774 #[test]
5775 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5776         let chanmon_cfgs = create_chanmon_cfgs(2);
5777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5779         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5780
5781         // Create some initial channels
5782         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5783
5784         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5785         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5786         assert_eq!(local_txn[0].input.len(), 1);
5787         check_spends!(local_txn[0], chan_1.3);
5788
5789         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5790         mine_transaction(&nodes[0], &local_txn[0]);
5791         check_closed_broadcast!(nodes[0], true);
5792         check_added_monitors!(nodes[0], 1);
5793         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5794
5795         let htlc_timeout = {
5796                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5797                 assert_eq!(node_txn.len(), 2);
5798                 check_spends!(node_txn[0], chan_1.3);
5799                 assert_eq!(node_txn[1].input.len(), 1);
5800                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5801                 check_spends!(node_txn[1], local_txn[0]);
5802                 node_txn[1].clone()
5803         };
5804
5805         mine_transaction(&nodes[0], &htlc_timeout);
5806         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5807         expect_payment_failed!(nodes[0], our_payment_hash, true);
5808
5809         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5810         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5811         assert_eq!(spend_txn.len(), 3);
5812         check_spends!(spend_txn[0], local_txn[0]);
5813         assert_eq!(spend_txn[1].input.len(), 1);
5814         check_spends!(spend_txn[1], htlc_timeout);
5815         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5816         assert_eq!(spend_txn[2].input.len(), 2);
5817         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5818         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5819                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5820 }
5821
5822 #[test]
5823 fn test_key_derivation_params() {
5824         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5825         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5826         // let us re-derive the channel key set to then derive a delayed_payment_key.
5827
5828         let chanmon_cfgs = create_chanmon_cfgs(3);
5829
5830         // We manually create the node configuration to backup the seed.
5831         let seed = [42; 32];
5832         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5833         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);
5834         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 };
5835         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5836         node_cfgs.remove(0);
5837         node_cfgs.insert(0, node);
5838
5839         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5840         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5841
5842         // Create some initial channels
5843         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5844         // for node 0
5845         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5846         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5847         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5848
5849         // Ensure all nodes are at the same height
5850         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5851         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5852         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5853         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5854
5855         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5856         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5857         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5858         assert_eq!(local_txn_1[0].input.len(), 1);
5859         check_spends!(local_txn_1[0], chan_1.3);
5860
5861         // We check funding pubkey are unique
5862         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]));
5863         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]));
5864         if from_0_funding_key_0 == from_1_funding_key_0
5865             || from_0_funding_key_0 == from_1_funding_key_1
5866             || from_0_funding_key_1 == from_1_funding_key_0
5867             || from_0_funding_key_1 == from_1_funding_key_1 {
5868                 panic!("Funding pubkeys aren't unique");
5869         }
5870
5871         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5872         mine_transaction(&nodes[0], &local_txn_1[0]);
5873         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5874         check_closed_broadcast!(nodes[0], true);
5875         check_added_monitors!(nodes[0], 1);
5876
5877         let htlc_timeout = {
5878                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5879                 assert_eq!(node_txn[1].input.len(), 1);
5880                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5881                 check_spends!(node_txn[1], local_txn_1[0]);
5882                 node_txn[1].clone()
5883         };
5884
5885         mine_transaction(&nodes[0], &htlc_timeout);
5886         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5887         expect_payment_failed!(nodes[0], our_payment_hash, true);
5888
5889         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5890         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5891         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5892         assert_eq!(spend_txn.len(), 3);
5893         check_spends!(spend_txn[0], local_txn_1[0]);
5894         assert_eq!(spend_txn[1].input.len(), 1);
5895         check_spends!(spend_txn[1], htlc_timeout);
5896         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5897         assert_eq!(spend_txn[2].input.len(), 2);
5898         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5899         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5900                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5901 }
5902
5903 #[test]
5904 fn test_static_output_closing_tx() {
5905         let chanmon_cfgs = create_chanmon_cfgs(2);
5906         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5907         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5908         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5909
5910         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5911
5912         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5913         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5914
5915         mine_transaction(&nodes[0], &closing_tx);
5916         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5917
5918         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5919         assert_eq!(spend_txn.len(), 1);
5920         check_spends!(spend_txn[0], closing_tx);
5921
5922         mine_transaction(&nodes[1], &closing_tx);
5923         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5924
5925         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5926         assert_eq!(spend_txn.len(), 1);
5927         check_spends!(spend_txn[0], closing_tx);
5928 }
5929
5930 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5931         let chanmon_cfgs = create_chanmon_cfgs(2);
5932         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5933         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5934         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5935         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5936
5937         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5938
5939         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5940         // present in B's local commitment transaction, but none of A's commitment transactions.
5941         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5942         check_added_monitors!(nodes[1], 1);
5943
5944         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5945         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5946         let events = nodes[0].node.get_and_clear_pending_events();
5947         assert_eq!(events.len(), 1);
5948         match events[0] {
5949                 Event::PaymentSent { payment_preimage } => {
5950                         assert_eq!(payment_preimage, our_payment_preimage);
5951                 },
5952                 _ => panic!("Unexpected event"),
5953         }
5954
5955         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5956         check_added_monitors!(nodes[0], 1);
5957         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5958         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5959         check_added_monitors!(nodes[1], 1);
5960
5961         let starting_block = nodes[1].best_block_info();
5962         let mut block = Block {
5963                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5964                 txdata: vec![],
5965         };
5966         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5967                 connect_block(&nodes[1], &block);
5968                 block.header.prev_blockhash = block.block_hash();
5969         }
5970         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5971         check_closed_broadcast!(nodes[1], true);
5972         check_added_monitors!(nodes[1], 1);
5973 }
5974
5975 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5976         let chanmon_cfgs = create_chanmon_cfgs(2);
5977         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5978         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5979         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5980         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5981         let logger = test_utils::TestLogger::new();
5982
5983         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5984         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5985         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();
5986         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5987         check_added_monitors!(nodes[0], 1);
5988
5989         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5990
5991         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5992         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5993         // to "time out" the HTLC.
5994
5995         let starting_block = nodes[1].best_block_info();
5996         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5997
5998         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5999                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6000                 header.prev_blockhash = header.block_hash();
6001         }
6002         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6003         check_closed_broadcast!(nodes[0], true);
6004         check_added_monitors!(nodes[0], 1);
6005 }
6006
6007 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6008         let chanmon_cfgs = create_chanmon_cfgs(3);
6009         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6010         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6011         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6012         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6013
6014         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6015         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6016         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6017         // actually revoked.
6018         let htlc_value = if use_dust { 50000 } else { 3000000 };
6019         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6020         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6021         expect_pending_htlcs_forwardable!(nodes[1]);
6022         check_added_monitors!(nodes[1], 1);
6023
6024         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6025         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6026         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6027         check_added_monitors!(nodes[0], 1);
6028         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6029         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6030         check_added_monitors!(nodes[1], 1);
6031         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6032         check_added_monitors!(nodes[1], 1);
6033         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6034
6035         if check_revoke_no_close {
6036                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6037                 check_added_monitors!(nodes[0], 1);
6038         }
6039
6040         let starting_block = nodes[1].best_block_info();
6041         let mut block = Block {
6042                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6043                 txdata: vec![],
6044         };
6045         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6046                 connect_block(&nodes[0], &block);
6047                 block.header.prev_blockhash = block.block_hash();
6048         }
6049         if !check_revoke_no_close {
6050                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6051                 check_closed_broadcast!(nodes[0], true);
6052                 check_added_monitors!(nodes[0], 1);
6053         } else {
6054                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6055         }
6056 }
6057
6058 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6059 // There are only a few cases to test here:
6060 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6061 //    broadcastable commitment transactions result in channel closure,
6062 //  * its included in an unrevoked-but-previous remote commitment transaction,
6063 //  * its included in the latest remote or local commitment transactions.
6064 // We test each of the three possible commitment transactions individually and use both dust and
6065 // non-dust HTLCs.
6066 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6067 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6068 // tested for at least one of the cases in other tests.
6069 #[test]
6070 fn htlc_claim_single_commitment_only_a() {
6071         do_htlc_claim_local_commitment_only(true);
6072         do_htlc_claim_local_commitment_only(false);
6073
6074         do_htlc_claim_current_remote_commitment_only(true);
6075         do_htlc_claim_current_remote_commitment_only(false);
6076 }
6077
6078 #[test]
6079 fn htlc_claim_single_commitment_only_b() {
6080         do_htlc_claim_previous_remote_commitment_only(true, false);
6081         do_htlc_claim_previous_remote_commitment_only(false, false);
6082         do_htlc_claim_previous_remote_commitment_only(true, true);
6083         do_htlc_claim_previous_remote_commitment_only(false, true);
6084 }
6085
6086 #[test]
6087 #[should_panic]
6088 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6089         let chanmon_cfgs = create_chanmon_cfgs(2);
6090         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6091         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6092         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6093         //Force duplicate channel ids
6094         for node in nodes.iter() {
6095                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6096         }
6097
6098         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6099         let channel_value_satoshis=10000;
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 node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6103         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6104
6105         //Create a second channel with a channel_id collision
6106         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6107 }
6108
6109 #[test]
6110 fn bolt2_open_channel_sending_node_checks_part2() {
6111         let chanmon_cfgs = create_chanmon_cfgs(2);
6112         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6113         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6114         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6115
6116         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6117         let channel_value_satoshis=2^24;
6118         let push_msat=10001;
6119         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6120
6121         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6122         let channel_value_satoshis=10000;
6123         // Test when push_msat is equal to 1000 * funding_satoshis.
6124         let push_msat=1000*channel_value_satoshis+1;
6125         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6126
6127         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6128         let channel_value_satoshis=10000;
6129         let push_msat=10001;
6130         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
6131         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6132         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6133
6134         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6135         // 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
6136         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6137
6138         // 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.
6139         assert!(BREAKDOWN_TIMEOUT>0);
6140         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6141
6142         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6143         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6144         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6145
6146         // 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.
6147         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6148         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6149         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6150         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6151         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6152 }
6153
6154 #[test]
6155 fn bolt2_open_channel_sane_dust_limit() {
6156         let chanmon_cfgs = create_chanmon_cfgs(2);
6157         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6159         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6160
6161         let channel_value_satoshis=1000000;
6162         let push_msat=10001;
6163         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6164         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6165         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6166         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6167
6168         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6169         let events = nodes[1].node.get_and_clear_pending_msg_events();
6170         let err_msg = match events[0] {
6171                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6172                         msg.clone()
6173                 },
6174                 _ => panic!("Unexpected event"),
6175         };
6176         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6177 }
6178
6179 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6180 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6181 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6182 // is no longer affordable once it's freed.
6183 #[test]
6184 fn test_fail_holding_cell_htlc_upon_free() {
6185         let chanmon_cfgs = create_chanmon_cfgs(2);
6186         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6187         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6188         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6189         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6190         let logger = test_utils::TestLogger::new();
6191
6192         // First nodes[0] generates an update_fee, setting the channel's
6193         // pending_update_fee.
6194         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6195         check_added_monitors!(nodes[0], 1);
6196
6197         let events = nodes[0].node.get_and_clear_pending_msg_events();
6198         assert_eq!(events.len(), 1);
6199         let (update_msg, commitment_signed) = match events[0] {
6200                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6201                         (update_fee.as_ref(), commitment_signed)
6202                 },
6203                 _ => panic!("Unexpected event"),
6204         };
6205
6206         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6207
6208         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6209         let channel_reserve = chan_stat.channel_reserve_msat;
6210         let feerate = get_feerate!(nodes[0], chan.2);
6211
6212         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6213         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6214         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6215         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6216         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();
6217
6218         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6219         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6220         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6221         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6222
6223         // Flush the pending fee update.
6224         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6225         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6226         check_added_monitors!(nodes[1], 1);
6227         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6228         check_added_monitors!(nodes[0], 1);
6229
6230         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6231         // HTLC, but now that the fee has been raised the payment will now fail, causing
6232         // us to surface its failure to the user.
6233         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6234         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6235         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6236         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 ({}) in channel {}",
6237                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6238         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6239
6240         // Check that the payment failed to be sent out.
6241         let events = nodes[0].node.get_and_clear_pending_events();
6242         assert_eq!(events.len(), 1);
6243         match &events[0] {
6244                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6245                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6246                         assert_eq!(*rejected_by_dest, false);
6247                         assert_eq!(*error_code, None);
6248                         assert_eq!(*error_data, None);
6249                 },
6250                 _ => panic!("Unexpected event"),
6251         }
6252 }
6253
6254 // Test that if multiple HTLCs are released from the holding cell and one is
6255 // valid but the other is no longer valid upon release, the valid HTLC can be
6256 // successfully completed while the other one fails as expected.
6257 #[test]
6258 fn test_free_and_fail_holding_cell_htlcs() {
6259         let chanmon_cfgs = create_chanmon_cfgs(2);
6260         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6261         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6262         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6263         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6264         let logger = test_utils::TestLogger::new();
6265
6266         // First nodes[0] generates an update_fee, setting the channel's
6267         // pending_update_fee.
6268         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6269         check_added_monitors!(nodes[0], 1);
6270
6271         let events = nodes[0].node.get_and_clear_pending_msg_events();
6272         assert_eq!(events.len(), 1);
6273         let (update_msg, commitment_signed) = match events[0] {
6274                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6275                         (update_fee.as_ref(), commitment_signed)
6276                 },
6277                 _ => panic!("Unexpected event"),
6278         };
6279
6280         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6281
6282         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6283         let channel_reserve = chan_stat.channel_reserve_msat;
6284         let feerate = get_feerate!(nodes[0], chan.2);
6285
6286         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6287         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6288         let amt_1 = 20000;
6289         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6290         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6291         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6292         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();
6293         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();
6294
6295         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6296         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6297         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6298         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6299         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6300         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6301         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6302
6303         // Flush the pending fee update.
6304         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6305         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6306         check_added_monitors!(nodes[1], 1);
6307         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6308         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6309         check_added_monitors!(nodes[0], 2);
6310
6311         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6312         // but now that the fee has been raised the second payment will now fail, causing us
6313         // to surface its failure to the user. The first payment should succeed.
6314         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6315         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6316         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6317         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 ({}) in channel {}",
6318                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6319         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6320
6321         // Check that the second payment failed to be sent out.
6322         let events = nodes[0].node.get_and_clear_pending_events();
6323         assert_eq!(events.len(), 1);
6324         match &events[0] {
6325                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6326                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6327                         assert_eq!(*rejected_by_dest, false);
6328                         assert_eq!(*error_code, None);
6329                         assert_eq!(*error_data, None);
6330                 },
6331                 _ => panic!("Unexpected event"),
6332         }
6333
6334         // Complete the first payment and the RAA from the fee update.
6335         let (payment_event, send_raa_event) = {
6336                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6337                 assert_eq!(msgs.len(), 2);
6338                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6339         };
6340         let raa = match send_raa_event {
6341                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6342                 _ => panic!("Unexpected event"),
6343         };
6344         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6345         check_added_monitors!(nodes[1], 1);
6346         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6347         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6348         let events = nodes[1].node.get_and_clear_pending_events();
6349         assert_eq!(events.len(), 1);
6350         match events[0] {
6351                 Event::PendingHTLCsForwardable { .. } => {},
6352                 _ => panic!("Unexpected event"),
6353         }
6354         nodes[1].node.process_pending_htlc_forwards();
6355         let events = nodes[1].node.get_and_clear_pending_events();
6356         assert_eq!(events.len(), 1);
6357         match events[0] {
6358                 Event::PaymentReceived { .. } => {},
6359                 _ => panic!("Unexpected event"),
6360         }
6361         nodes[1].node.claim_funds(payment_preimage_1);
6362         check_added_monitors!(nodes[1], 1);
6363         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6364         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6365         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6366         let events = nodes[0].node.get_and_clear_pending_events();
6367         assert_eq!(events.len(), 1);
6368         match events[0] {
6369                 Event::PaymentSent { ref payment_preimage } => {
6370                         assert_eq!(*payment_preimage, payment_preimage_1);
6371                 }
6372                 _ => panic!("Unexpected event"),
6373         }
6374 }
6375
6376 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6377 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6378 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6379 // once it's freed.
6380 #[test]
6381 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6382         let chanmon_cfgs = create_chanmon_cfgs(3);
6383         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6384         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6385         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6386         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6387         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6388         let logger = test_utils::TestLogger::new();
6389
6390         // First nodes[1] generates an update_fee, setting the channel's
6391         // pending_update_fee.
6392         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6393         check_added_monitors!(nodes[1], 1);
6394
6395         let events = nodes[1].node.get_and_clear_pending_msg_events();
6396         assert_eq!(events.len(), 1);
6397         let (update_msg, commitment_signed) = match events[0] {
6398                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6399                         (update_fee.as_ref(), commitment_signed)
6400                 },
6401                 _ => panic!("Unexpected event"),
6402         };
6403
6404         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6405
6406         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6407         let channel_reserve = chan_stat.channel_reserve_msat;
6408         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6409
6410         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6411         let feemsat = 239;
6412         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6413         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6414         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6415         let payment_event = {
6416                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6417                 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();
6418                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6419                 check_added_monitors!(nodes[0], 1);
6420
6421                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6422                 assert_eq!(events.len(), 1);
6423
6424                 SendEvent::from_event(events.remove(0))
6425         };
6426         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6427         check_added_monitors!(nodes[1], 0);
6428         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6429         expect_pending_htlcs_forwardable!(nodes[1]);
6430
6431         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6432         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6433
6434         // Flush the pending fee update.
6435         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6436         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6437         check_added_monitors!(nodes[2], 1);
6438         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6439         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6440         check_added_monitors!(nodes[1], 2);
6441
6442         // A final RAA message is generated to finalize the fee update.
6443         let events = nodes[1].node.get_and_clear_pending_msg_events();
6444         assert_eq!(events.len(), 1);
6445
6446         let raa_msg = match &events[0] {
6447                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6448                         msg.clone()
6449                 },
6450                 _ => panic!("Unexpected event"),
6451         };
6452
6453         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6454         check_added_monitors!(nodes[2], 1);
6455         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6456
6457         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6458         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6459         assert_eq!(process_htlc_forwards_event.len(), 1);
6460         match &process_htlc_forwards_event[0] {
6461                 &Event::PendingHTLCsForwardable { .. } => {},
6462                 _ => panic!("Unexpected event"),
6463         }
6464
6465         // In response, we call ChannelManager's process_pending_htlc_forwards
6466         nodes[1].node.process_pending_htlc_forwards();
6467         check_added_monitors!(nodes[1], 1);
6468
6469         // This causes the HTLC to be failed backwards.
6470         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6471         assert_eq!(fail_event.len(), 1);
6472         let (fail_msg, commitment_signed) = match &fail_event[0] {
6473                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6474                         assert_eq!(updates.update_add_htlcs.len(), 0);
6475                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6476                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6477                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6478                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6479                 },
6480                 _ => panic!("Unexpected event"),
6481         };
6482
6483         // Pass the failure messages back to nodes[0].
6484         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6485         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6486
6487         // Complete the HTLC failure+removal process.
6488         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6489         check_added_monitors!(nodes[0], 1);
6490         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6491         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6492         check_added_monitors!(nodes[1], 2);
6493         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6494         assert_eq!(final_raa_event.len(), 1);
6495         let raa = match &final_raa_event[0] {
6496                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6497                 _ => panic!("Unexpected event"),
6498         };
6499         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6500         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6501         expect_payment_failed!(nodes[0], our_payment_hash, false);
6502         check_added_monitors!(nodes[0], 1);
6503 }
6504
6505 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6506 // 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.
6507 //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.
6508
6509 #[test]
6510 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6511         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6512         let chanmon_cfgs = create_chanmon_cfgs(2);
6513         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6514         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6515         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6516         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6517
6518         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6519         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6520         let logger = test_utils::TestLogger::new();
6521         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();
6522         route.paths[0][0].fee_msat = 100;
6523
6524         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6525                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6526         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6527         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6528 }
6529
6530 #[test]
6531 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6532         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6533         let chanmon_cfgs = create_chanmon_cfgs(2);
6534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6537         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6538         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6539
6540         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6541         let logger = test_utils::TestLogger::new();
6542         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();
6543         route.paths[0][0].fee_msat = 0;
6544         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6545                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6546
6547         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6548         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6549 }
6550
6551 #[test]
6552 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6553         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6554         let chanmon_cfgs = create_chanmon_cfgs(2);
6555         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6557         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6558         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6559
6560         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6561         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6562         let logger = test_utils::TestLogger::new();
6563         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();
6564         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6565         check_added_monitors!(nodes[0], 1);
6566         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6567         updates.update_add_htlcs[0].amount_msat = 0;
6568
6569         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6570         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6571         check_closed_broadcast!(nodes[1], true).unwrap();
6572         check_added_monitors!(nodes[1], 1);
6573 }
6574
6575 #[test]
6576 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6577         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6578         //It is enforced when constructing a route.
6579         let chanmon_cfgs = create_chanmon_cfgs(2);
6580         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6581         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6582         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6583         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6584         let logger = test_utils::TestLogger::new();
6585
6586         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6587
6588         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6589         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();
6590         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6591                 assert_eq!(err, &"Channel CLTV overflowed?"));
6592 }
6593
6594 #[test]
6595 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6596         //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.
6597         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6598         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6599         let chanmon_cfgs = create_chanmon_cfgs(2);
6600         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6601         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6602         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6603         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6604         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6605
6606         let logger = test_utils::TestLogger::new();
6607         for i in 0..max_accepted_htlcs {
6608                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6609                 let payment_event = {
6610                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6611                         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();
6612                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6613                         check_added_monitors!(nodes[0], 1);
6614
6615                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6616                         assert_eq!(events.len(), 1);
6617                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6618                                 assert_eq!(htlcs[0].htlc_id, i);
6619                         } else {
6620                                 assert!(false);
6621                         }
6622                         SendEvent::from_event(events.remove(0))
6623                 };
6624                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6625                 check_added_monitors!(nodes[1], 0);
6626                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6627
6628                 expect_pending_htlcs_forwardable!(nodes[1]);
6629                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6630         }
6631         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6632         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6633         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();
6634         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6635                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6636
6637         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6638         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6639 }
6640
6641 #[test]
6642 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6643         //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.
6644         let chanmon_cfgs = create_chanmon_cfgs(2);
6645         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6646         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6647         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6648         let channel_value = 100000;
6649         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6650         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6651
6652         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6653
6654         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6655         // Manually create a route over our max in flight (which our router normally automatically
6656         // limits us to.
6657         let route = Route { paths: vec![vec![RouteHop {
6658            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6659            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6660            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6661         }]] };
6662         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6663                 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)));
6664
6665         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6666         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);
6667
6668         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6669 }
6670
6671 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6672 #[test]
6673 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6674         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6675         let chanmon_cfgs = create_chanmon_cfgs(2);
6676         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6677         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6678         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6679         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6680         let htlc_minimum_msat: u64;
6681         {
6682                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6683                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6684                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6685         }
6686
6687         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6688         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6689         let logger = test_utils::TestLogger::new();
6690         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();
6691         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6692         check_added_monitors!(nodes[0], 1);
6693         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6694         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6695         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6696         assert!(nodes[1].node.list_channels().is_empty());
6697         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6698         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()));
6699         check_added_monitors!(nodes[1], 1);
6700 }
6701
6702 #[test]
6703 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6704         //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
6705         let chanmon_cfgs = create_chanmon_cfgs(2);
6706         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6707         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6708         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6709         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6710         let logger = test_utils::TestLogger::new();
6711
6712         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6713         let channel_reserve = chan_stat.channel_reserve_msat;
6714         let feerate = get_feerate!(nodes[0], chan.2);
6715         // The 2* and +1 are for the fee spike reserve.
6716         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6717
6718         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6719         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6720         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6721         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();
6722         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6723         check_added_monitors!(nodes[0], 1);
6724         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6725
6726         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6727         // at this time channel-initiatee receivers are not required to enforce that senders
6728         // respect the fee_spike_reserve.
6729         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6730         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6731
6732         assert!(nodes[1].node.list_channels().is_empty());
6733         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6734         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6735         check_added_monitors!(nodes[1], 1);
6736 }
6737
6738 #[test]
6739 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6740         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6741         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6742         let chanmon_cfgs = create_chanmon_cfgs(2);
6743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6745         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6746         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6747         let logger = test_utils::TestLogger::new();
6748
6749         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6750         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6751
6752         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6753         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();
6754
6755         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6756         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6757         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6758         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6759
6760         let mut msg = msgs::UpdateAddHTLC {
6761                 channel_id: chan.2,
6762                 htlc_id: 0,
6763                 amount_msat: 1000,
6764                 payment_hash: our_payment_hash,
6765                 cltv_expiry: htlc_cltv,
6766                 onion_routing_packet: onion_packet.clone(),
6767         };
6768
6769         for i in 0..super::channel::OUR_MAX_HTLCS {
6770                 msg.htlc_id = i as u64;
6771                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6772         }
6773         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6774         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6775
6776         assert!(nodes[1].node.list_channels().is_empty());
6777         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6778         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6779         check_added_monitors!(nodes[1], 1);
6780 }
6781
6782 #[test]
6783 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6784         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
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 chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6790         let logger = test_utils::TestLogger::new();
6791
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 mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6798         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6799         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6800
6801         assert!(nodes[1].node.list_channels().is_empty());
6802         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6803         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6804         check_added_monitors!(nodes[1], 1);
6805 }
6806
6807 #[test]
6808 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6809         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6810         let chanmon_cfgs = create_chanmon_cfgs(2);
6811         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6812         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6813         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6814         let logger = test_utils::TestLogger::new();
6815
6816         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6817         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6818         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6819         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();
6820         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6821         check_added_monitors!(nodes[0], 1);
6822         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6823         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6824         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6825
6826         assert!(nodes[1].node.list_channels().is_empty());
6827         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6828         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6829         check_added_monitors!(nodes[1], 1);
6830 }
6831
6832 #[test]
6833 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6834         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6835         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6836         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6837         let chanmon_cfgs = create_chanmon_cfgs(2);
6838         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6840         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6841         let logger = test_utils::TestLogger::new();
6842
6843         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6844         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6845         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6846         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();
6847         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6848         check_added_monitors!(nodes[0], 1);
6849         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6850         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6851
6852         //Disconnect and Reconnect
6853         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6854         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6855         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6856         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6857         assert_eq!(reestablish_1.len(), 1);
6858         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6859         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6860         assert_eq!(reestablish_2.len(), 1);
6861         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6862         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6863         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6864         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6865
6866         //Resend HTLC
6867         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6868         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6869         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6870         check_added_monitors!(nodes[1], 1);
6871         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6872
6873         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6874
6875         assert!(nodes[1].node.list_channels().is_empty());
6876         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6877         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6878         check_added_monitors!(nodes[1], 1);
6879 }
6880
6881 #[test]
6882 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6883         //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.
6884
6885         let chanmon_cfgs = create_chanmon_cfgs(2);
6886         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6887         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6888         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6889         let logger = test_utils::TestLogger::new();
6890         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6891         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6892         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6893         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();
6894         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6895
6896         check_added_monitors!(nodes[0], 1);
6897         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6898         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6899
6900         let update_msg = msgs::UpdateFulfillHTLC{
6901                 channel_id: chan.2,
6902                 htlc_id: 0,
6903                 payment_preimage: our_payment_preimage,
6904         };
6905
6906         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6907
6908         assert!(nodes[0].node.list_channels().is_empty());
6909         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6910         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()));
6911         check_added_monitors!(nodes[0], 1);
6912 }
6913
6914 #[test]
6915 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6916         //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.
6917
6918         let chanmon_cfgs = create_chanmon_cfgs(2);
6919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6921         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6922         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6923         let logger = test_utils::TestLogger::new();
6924
6925         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6926         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6927         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();
6928         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6929         check_added_monitors!(nodes[0], 1);
6930         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6931         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6932
6933         let update_msg = msgs::UpdateFailHTLC{
6934                 channel_id: chan.2,
6935                 htlc_id: 0,
6936                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6937         };
6938
6939         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6940
6941         assert!(nodes[0].node.list_channels().is_empty());
6942         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6943         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()));
6944         check_added_monitors!(nodes[0], 1);
6945 }
6946
6947 #[test]
6948 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6949         //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.
6950
6951         let chanmon_cfgs = create_chanmon_cfgs(2);
6952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6954         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6955         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6956         let logger = test_utils::TestLogger::new();
6957
6958         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6959         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6960         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();
6961         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6962         check_added_monitors!(nodes[0], 1);
6963         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6964         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6965         let update_msg = msgs::UpdateFailMalformedHTLC{
6966                 channel_id: chan.2,
6967                 htlc_id: 0,
6968                 sha256_of_onion: [1; 32],
6969                 failure_code: 0x8000,
6970         };
6971
6972         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6973
6974         assert!(nodes[0].node.list_channels().is_empty());
6975         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6976         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()));
6977         check_added_monitors!(nodes[0], 1);
6978 }
6979
6980 #[test]
6981 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6982         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6983
6984         let chanmon_cfgs = create_chanmon_cfgs(2);
6985         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6986         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6987         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6988         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6989
6990         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6991
6992         nodes[1].node.claim_funds(our_payment_preimage);
6993         check_added_monitors!(nodes[1], 1);
6994
6995         let events = nodes[1].node.get_and_clear_pending_msg_events();
6996         assert_eq!(events.len(), 1);
6997         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6998                 match events[0] {
6999                         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, .. } } => {
7000                                 assert!(update_add_htlcs.is_empty());
7001                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7002                                 assert!(update_fail_htlcs.is_empty());
7003                                 assert!(update_fail_malformed_htlcs.is_empty());
7004                                 assert!(update_fee.is_none());
7005                                 update_fulfill_htlcs[0].clone()
7006                         },
7007                         _ => panic!("Unexpected event"),
7008                 }
7009         };
7010
7011         update_fulfill_msg.htlc_id = 1;
7012
7013         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7014
7015         assert!(nodes[0].node.list_channels().is_empty());
7016         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7017         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7018         check_added_monitors!(nodes[0], 1);
7019 }
7020
7021 #[test]
7022 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7023         //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.
7024
7025         let chanmon_cfgs = create_chanmon_cfgs(2);
7026         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7027         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7028         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7029         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7030
7031         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7032
7033         nodes[1].node.claim_funds(our_payment_preimage);
7034         check_added_monitors!(nodes[1], 1);
7035
7036         let events = nodes[1].node.get_and_clear_pending_msg_events();
7037         assert_eq!(events.len(), 1);
7038         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7039                 match events[0] {
7040                         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, .. } } => {
7041                                 assert!(update_add_htlcs.is_empty());
7042                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7043                                 assert!(update_fail_htlcs.is_empty());
7044                                 assert!(update_fail_malformed_htlcs.is_empty());
7045                                 assert!(update_fee.is_none());
7046                                 update_fulfill_htlcs[0].clone()
7047                         },
7048                         _ => panic!("Unexpected event"),
7049                 }
7050         };
7051
7052         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7053
7054         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7055
7056         assert!(nodes[0].node.list_channels().is_empty());
7057         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7058         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7059         check_added_monitors!(nodes[0], 1);
7060 }
7061
7062 #[test]
7063 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7064         //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.
7065
7066         let chanmon_cfgs = create_chanmon_cfgs(2);
7067         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7068         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7069         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7070         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7071         let logger = test_utils::TestLogger::new();
7072
7073         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7074         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7075         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();
7076         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7077         check_added_monitors!(nodes[0], 1);
7078
7079         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7080         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7081
7082         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7083         check_added_monitors!(nodes[1], 0);
7084         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7085
7086         let events = nodes[1].node.get_and_clear_pending_msg_events();
7087
7088         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7089                 match events[0] {
7090                         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, .. } } => {
7091                                 assert!(update_add_htlcs.is_empty());
7092                                 assert!(update_fulfill_htlcs.is_empty());
7093                                 assert!(update_fail_htlcs.is_empty());
7094                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7095                                 assert!(update_fee.is_none());
7096                                 update_fail_malformed_htlcs[0].clone()
7097                         },
7098                         _ => panic!("Unexpected event"),
7099                 }
7100         };
7101         update_msg.failure_code &= !0x8000;
7102         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7103
7104         assert!(nodes[0].node.list_channels().is_empty());
7105         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7106         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7107         check_added_monitors!(nodes[0], 1);
7108 }
7109
7110 #[test]
7111 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7112         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7113         //    * 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.
7114
7115         let chanmon_cfgs = create_chanmon_cfgs(3);
7116         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7117         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7118         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7119         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7120         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7121         let logger = test_utils::TestLogger::new();
7122
7123         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7124
7125         //First hop
7126         let mut payment_event = {
7127                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7128                 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();
7129                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7130                 check_added_monitors!(nodes[0], 1);
7131                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7132                 assert_eq!(events.len(), 1);
7133                 SendEvent::from_event(events.remove(0))
7134         };
7135         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7136         check_added_monitors!(nodes[1], 0);
7137         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7138         expect_pending_htlcs_forwardable!(nodes[1]);
7139         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7140         assert_eq!(events_2.len(), 1);
7141         check_added_monitors!(nodes[1], 1);
7142         payment_event = SendEvent::from_event(events_2.remove(0));
7143         assert_eq!(payment_event.msgs.len(), 1);
7144
7145         //Second Hop
7146         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7147         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7148         check_added_monitors!(nodes[2], 0);
7149         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7150
7151         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7152         assert_eq!(events_3.len(), 1);
7153         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7154                 match events_3[0] {
7155                         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 } } => {
7156                                 assert!(update_add_htlcs.is_empty());
7157                                 assert!(update_fulfill_htlcs.is_empty());
7158                                 assert!(update_fail_htlcs.is_empty());
7159                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7160                                 assert!(update_fee.is_none());
7161                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7162                         },
7163                         _ => panic!("Unexpected event"),
7164                 }
7165         };
7166
7167         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7168
7169         check_added_monitors!(nodes[1], 0);
7170         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7171         expect_pending_htlcs_forwardable!(nodes[1]);
7172         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7173         assert_eq!(events_4.len(), 1);
7174
7175         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7176         match events_4[0] {
7177                 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, .. } } => {
7178                         assert!(update_add_htlcs.is_empty());
7179                         assert!(update_fulfill_htlcs.is_empty());
7180                         assert_eq!(update_fail_htlcs.len(), 1);
7181                         assert!(update_fail_malformed_htlcs.is_empty());
7182                         assert!(update_fee.is_none());
7183                 },
7184                 _ => panic!("Unexpected event"),
7185         };
7186
7187         check_added_monitors!(nodes[1], 1);
7188 }
7189
7190 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7191         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7192         // 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
7193         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7194
7195         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7196         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7200         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7201
7202         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7203
7204         // We route 2 dust-HTLCs between A and B
7205         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7206         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7207         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7208
7209         // Cache one local commitment tx as previous
7210         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7211
7212         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7213         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7214         check_added_monitors!(nodes[1], 0);
7215         expect_pending_htlcs_forwardable!(nodes[1]);
7216         check_added_monitors!(nodes[1], 1);
7217
7218         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7219         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7220         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7221         check_added_monitors!(nodes[0], 1);
7222
7223         // Cache one local commitment tx as lastest
7224         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7225
7226         let events = nodes[0].node.get_and_clear_pending_msg_events();
7227         match events[0] {
7228                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7229                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7230                 },
7231                 _ => panic!("Unexpected event"),
7232         }
7233         match events[1] {
7234                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7235                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7236                 },
7237                 _ => panic!("Unexpected event"),
7238         }
7239
7240         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7241         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7242         if announce_latest {
7243                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7244         } else {
7245                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7246         }
7247
7248         check_closed_broadcast!(nodes[0], true);
7249         check_added_monitors!(nodes[0], 1);
7250
7251         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7252         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7253         let events = nodes[0].node.get_and_clear_pending_events();
7254         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7255         assert_eq!(events.len(), 2);
7256         let mut first_failed = false;
7257         for event in events {
7258                 match event {
7259                         Event::PaymentFailed { payment_hash, .. } => {
7260                                 if payment_hash == payment_hash_1 {
7261                                         assert!(!first_failed);
7262                                         first_failed = true;
7263                                 } else {
7264                                         assert_eq!(payment_hash, payment_hash_2);
7265                                 }
7266                         }
7267                         _ => panic!("Unexpected event"),
7268                 }
7269         }
7270 }
7271
7272 #[test]
7273 fn test_failure_delay_dust_htlc_local_commitment() {
7274         do_test_failure_delay_dust_htlc_local_commitment(true);
7275         do_test_failure_delay_dust_htlc_local_commitment(false);
7276 }
7277
7278 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7279         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7280         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7281         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7282         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7283         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7284         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7285
7286         let chanmon_cfgs = create_chanmon_cfgs(3);
7287         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7288         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7289         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7290         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7291
7292         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7293
7294         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7295         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7296
7297         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7298         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7299
7300         // We revoked bs_commitment_tx
7301         if revoked {
7302                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7303                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7304         }
7305
7306         let mut timeout_tx = Vec::new();
7307         if local {
7308                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7309                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7310                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7311                 expect_payment_failed!(nodes[0], dust_hash, true);
7312
7313                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7314                 check_closed_broadcast!(nodes[0], true);
7315                 check_added_monitors!(nodes[0], 1);
7316                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7317                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7318                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7319                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7320                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7321                 mine_transaction(&nodes[0], &timeout_tx[0]);
7322                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7323                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7324         } else {
7325                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7326                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7327                 check_closed_broadcast!(nodes[0], true);
7328                 check_added_monitors!(nodes[0], 1);
7329                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7330                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7331                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7332                 if !revoked {
7333                         expect_payment_failed!(nodes[0], dust_hash, true);
7334                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7335                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7336                         mine_transaction(&nodes[0], &timeout_tx[0]);
7337                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7338                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7339                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7340                 } else {
7341                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7342                         // commitment tx
7343                         let events = nodes[0].node.get_and_clear_pending_events();
7344                         assert_eq!(events.len(), 2);
7345                         let first;
7346                         match events[0] {
7347                                 Event::PaymentFailed { payment_hash, .. } => {
7348                                         if payment_hash == dust_hash { first = true; }
7349                                         else { first = false; }
7350                                 },
7351                                 _ => panic!("Unexpected event"),
7352                         }
7353                         match events[1] {
7354                                 Event::PaymentFailed { payment_hash, .. } => {
7355                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7356                                         else { assert_eq!(payment_hash, dust_hash); }
7357                                 },
7358                                 _ => panic!("Unexpected event"),
7359                         }
7360                 }
7361         }
7362 }
7363
7364 #[test]
7365 fn test_sweep_outbound_htlc_failure_update() {
7366         do_test_sweep_outbound_htlc_failure_update(false, true);
7367         do_test_sweep_outbound_htlc_failure_update(false, false);
7368         do_test_sweep_outbound_htlc_failure_update(true, false);
7369 }
7370
7371 #[test]
7372 fn test_upfront_shutdown_script() {
7373         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7374         // enforce it at shutdown message
7375
7376         let mut config = UserConfig::default();
7377         config.channel_options.announced_channel = true;
7378         config.peer_channel_config_limits.force_announced_channel_preference = false;
7379         config.channel_options.commit_upfront_shutdown_pubkey = false;
7380         let user_cfgs = [None, Some(config), None];
7381         let chanmon_cfgs = create_chanmon_cfgs(3);
7382         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7383         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7384         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7385
7386         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7387         let flags = InitFeatures::known();
7388         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7389         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7390         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7391         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7392         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7393         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7394     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()));
7395         check_added_monitors!(nodes[2], 1);
7396
7397         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7398         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7399         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7400         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7401         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7402         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7403         let events = nodes[2].node.get_and_clear_pending_msg_events();
7404         assert_eq!(events.len(), 1);
7405         match events[0] {
7406                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7407                 _ => panic!("Unexpected event"),
7408         }
7409
7410         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7411         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7412         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7413         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7414         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7415         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7416         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7417         let events = nodes[1].node.get_and_clear_pending_msg_events();
7418         assert_eq!(events.len(), 1);
7419         match events[0] {
7420                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7421                 _ => panic!("Unexpected event"),
7422         }
7423
7424         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7425         // channel smoothly, opt-out is from channel initiator here
7426         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7427         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7428         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7429         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7430         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7431         let events = nodes[0].node.get_and_clear_pending_msg_events();
7432         assert_eq!(events.len(), 1);
7433         match events[0] {
7434                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7435                 _ => panic!("Unexpected event"),
7436         }
7437
7438         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7439         //// channel smoothly
7440         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7441         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7442         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7443         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7444         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7445         let events = nodes[0].node.get_and_clear_pending_msg_events();
7446         assert_eq!(events.len(), 2);
7447         match events[0] {
7448                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7449                 _ => panic!("Unexpected event"),
7450         }
7451         match events[1] {
7452                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7453                 _ => panic!("Unexpected event"),
7454         }
7455 }
7456
7457 #[test]
7458 fn test_upfront_shutdown_script_unsupport_segwit() {
7459         // We test that channel is closed early
7460         // if a segwit program is passed as upfront shutdown script,
7461         // but the peer does not support segwit.
7462         let chanmon_cfgs = create_chanmon_cfgs(2);
7463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7466
7467         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7468
7469         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7470         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7471                 .push_slice(&[0, 0])
7472                 .into_script());
7473
7474         let features = InitFeatures::known().clear_shutdown_anysegwit();
7475         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7476
7477         let events = nodes[0].node.get_and_clear_pending_msg_events();
7478         assert_eq!(events.len(), 1);
7479         match events[0] {
7480                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7481                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7482                         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));
7483                 },
7484                 _ => panic!("Unexpected event"),
7485         }
7486 }
7487
7488 #[test]
7489 fn test_shutdown_script_any_segwit_allowed() {
7490         let mut config = UserConfig::default();
7491         config.channel_options.announced_channel = true;
7492         config.peer_channel_config_limits.force_announced_channel_preference = false;
7493         config.channel_options.commit_upfront_shutdown_pubkey = false;
7494         let user_cfgs = [None, Some(config), None];
7495         let chanmon_cfgs = create_chanmon_cfgs(3);
7496         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7497         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7498         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7499
7500         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7501         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7502         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7503         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7504         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7505                 .push_slice(&[0, 0])
7506                 .into_script();
7507         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7508         let events = nodes[0].node.get_and_clear_pending_msg_events();
7509         assert_eq!(events.len(), 2);
7510         match events[0] {
7511                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7512                 _ => panic!("Unexpected event"),
7513         }
7514         match events[1] {
7515                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7516                 _ => panic!("Unexpected event"),
7517         }
7518 }
7519
7520 #[test]
7521 fn test_shutdown_script_any_segwit_not_allowed() {
7522         let mut config = UserConfig::default();
7523         config.channel_options.announced_channel = true;
7524         config.peer_channel_config_limits.force_announced_channel_preference = false;
7525         config.channel_options.commit_upfront_shutdown_pubkey = false;
7526         let user_cfgs = [None, Some(config), None];
7527         let chanmon_cfgs = create_chanmon_cfgs(3);
7528         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7529         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7530         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7531
7532         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7533         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7534         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7535         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7536         // Make an any segwit version script
7537         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7538                 .push_slice(&[0, 0])
7539                 .into_script();
7540         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7541         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7542         let events = nodes[0].node.get_and_clear_pending_msg_events();
7543         assert_eq!(events.len(), 2);
7544         match events[1] {
7545                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7546                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7547                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7548                 },
7549                 _ => panic!("Unexpected event"),
7550         }
7551         check_added_monitors!(nodes[0], 1);
7552 }
7553
7554 #[test]
7555 fn test_shutdown_script_segwit_but_not_anysegwit() {
7556         let mut config = UserConfig::default();
7557         config.channel_options.announced_channel = true;
7558         config.peer_channel_config_limits.force_announced_channel_preference = false;
7559         config.channel_options.commit_upfront_shutdown_pubkey = false;
7560         let user_cfgs = [None, Some(config), None];
7561         let chanmon_cfgs = create_chanmon_cfgs(3);
7562         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7563         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7564         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7565
7566         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7567         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7568         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7569         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7570         // Make a segwit script that is not a valid as any segwit
7571         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7572                 .push_slice(&[0, 0])
7573                 .into_script();
7574         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7575         let events = nodes[0].node.get_and_clear_pending_msg_events();
7576         assert_eq!(events.len(), 2);
7577         match events[1] {
7578                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7579                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7580                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7581                 },
7582                 _ => panic!("Unexpected event"),
7583         }
7584         check_added_monitors!(nodes[0], 1);
7585 }
7586
7587 #[test]
7588 fn test_user_configurable_csv_delay() {
7589         // We test our channel constructors yield errors when we pass them absurd csv delay
7590
7591         let mut low_our_to_self_config = UserConfig::default();
7592         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7593         let mut high_their_to_self_config = UserConfig::default();
7594         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7595         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7596         let chanmon_cfgs = create_chanmon_cfgs(2);
7597         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7598         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7599         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7600
7601         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7602         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) {
7603                 match error {
7604                         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())); },
7605                         _ => panic!("Unexpected event"),
7606                 }
7607         } else { assert!(false) }
7608
7609         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7610         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7611         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7612         open_channel.to_self_delay = 200;
7613         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) {
7614                 match error {
7615                         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()));  },
7616                         _ => panic!("Unexpected event"),
7617                 }
7618         } else { assert!(false); }
7619
7620         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7621         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7622         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()));
7623         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7624         accept_channel.to_self_delay = 200;
7625         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7626         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7627                 match action {
7628                         &ErrorAction::SendErrorMessage { ref msg } => {
7629                                 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()));
7630                         },
7631                         _ => { assert!(false); }
7632                 }
7633         } else { assert!(false); }
7634
7635         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7636         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7637         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7638         open_channel.to_self_delay = 200;
7639         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) {
7640                 match error {
7641                         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())); },
7642                         _ => panic!("Unexpected event"),
7643                 }
7644         } else { assert!(false); }
7645 }
7646
7647 #[test]
7648 fn test_data_loss_protect() {
7649         // We want to be sure that :
7650         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7651         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7652         // * we close channel in case of detecting other being fallen behind
7653         // * we are able to claim our own outputs thanks to to_remote being static
7654         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7655         let persister;
7656         let logger;
7657         let fee_estimator;
7658         let tx_broadcaster;
7659         let chain_source;
7660         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7661         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7662         // during signing due to revoked tx
7663         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7664         let keys_manager = &chanmon_cfgs[0].keys_manager;
7665         let monitor;
7666         let node_state_0;
7667         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7668         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7669         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7670
7671         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7672
7673         // Cache node A state before any channel update
7674         let previous_node_state = nodes[0].node.encode();
7675         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7676         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7677
7678         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7679         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7680
7681         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7682         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7683
7684         // Restore node A from previous state
7685         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7686         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7687         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7688         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7689         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7690         persister = test_utils::TestPersister::new();
7691         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7692         node_state_0 = {
7693                 let mut channel_monitors = HashMap::new();
7694                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7695                 <(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 {
7696                         keys_manager: keys_manager,
7697                         fee_estimator: &fee_estimator,
7698                         chain_monitor: &monitor,
7699                         logger: &logger,
7700                         tx_broadcaster: &tx_broadcaster,
7701                         default_config: UserConfig::default(),
7702                         channel_monitors,
7703                 }).unwrap().1
7704         };
7705         nodes[0].node = &node_state_0;
7706         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7707         nodes[0].chain_monitor = &monitor;
7708         nodes[0].chain_source = &chain_source;
7709
7710         check_added_monitors!(nodes[0], 1);
7711
7712         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7713         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7714
7715         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7716
7717         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7718         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7719         check_added_monitors!(nodes[0], 1);
7720
7721         {
7722                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7723                 assert_eq!(node_txn.len(), 0);
7724         }
7725
7726         let mut reestablish_1 = Vec::with_capacity(1);
7727         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7728                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7729                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7730                         reestablish_1.push(msg.clone());
7731                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7732                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7733                         match action {
7734                                 &ErrorAction::SendErrorMessage { ref msg } => {
7735                                         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");
7736                                 },
7737                                 _ => panic!("Unexpected event!"),
7738                         }
7739                 } else {
7740                         panic!("Unexpected event")
7741                 }
7742         }
7743
7744         // Check we close channel detecting A is fallen-behind
7745         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7746         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7747         check_added_monitors!(nodes[1], 1);
7748
7749
7750         // Check A is able to claim to_remote output
7751         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7752         assert_eq!(node_txn.len(), 1);
7753         check_spends!(node_txn[0], chan.3);
7754         assert_eq!(node_txn[0].output.len(), 2);
7755         mine_transaction(&nodes[0], &node_txn[0]);
7756         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7757         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7758         assert_eq!(spend_txn.len(), 1);
7759         check_spends!(spend_txn[0], node_txn[0]);
7760 }
7761
7762 #[test]
7763 fn test_check_htlc_underpaying() {
7764         // Send payment through A -> B but A is maliciously
7765         // sending a probe payment (i.e less than expected value0
7766         // to B, B should refuse payment.
7767
7768         let chanmon_cfgs = create_chanmon_cfgs(2);
7769         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7770         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7771         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7772
7773         // Create some initial channels
7774         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7775
7776         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();
7777         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7778         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7779         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7780         check_added_monitors!(nodes[0], 1);
7781
7782         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7783         assert_eq!(events.len(), 1);
7784         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7785         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7786         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7787
7788         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7789         // and then will wait a second random delay before failing the HTLC back:
7790         expect_pending_htlcs_forwardable!(nodes[1]);
7791         expect_pending_htlcs_forwardable!(nodes[1]);
7792
7793         // Node 3 is expecting payment of 100_000 but received 10_000,
7794         // it should fail htlc like we didn't know the preimage.
7795         nodes[1].node.process_pending_htlc_forwards();
7796
7797         let events = nodes[1].node.get_and_clear_pending_msg_events();
7798         assert_eq!(events.len(), 1);
7799         let (update_fail_htlc, commitment_signed) = match events[0] {
7800                 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 } } => {
7801                         assert!(update_add_htlcs.is_empty());
7802                         assert!(update_fulfill_htlcs.is_empty());
7803                         assert_eq!(update_fail_htlcs.len(), 1);
7804                         assert!(update_fail_malformed_htlcs.is_empty());
7805                         assert!(update_fee.is_none());
7806                         (update_fail_htlcs[0].clone(), commitment_signed)
7807                 },
7808                 _ => panic!("Unexpected event"),
7809         };
7810         check_added_monitors!(nodes[1], 1);
7811
7812         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7813         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7814
7815         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7816         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7817         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7818         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7819 }
7820
7821 #[test]
7822 fn test_announce_disable_channels() {
7823         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7824         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7825
7826         let chanmon_cfgs = create_chanmon_cfgs(2);
7827         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7828         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7829         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7830
7831         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7832         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7833         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7834
7835         // Disconnect peers
7836         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7837         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7838
7839         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7840         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7841         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7842         assert_eq!(msg_events.len(), 3);
7843         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7844         for e in msg_events {
7845                 match e {
7846                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7847                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7848                                 // Check that each channel gets updated exactly once
7849                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7850                                         panic!("Generated ChannelUpdate for wrong chan!");
7851                                 }
7852                         },
7853                         _ => panic!("Unexpected event"),
7854                 }
7855         }
7856         // Reconnect peers
7857         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7858         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7859         assert_eq!(reestablish_1.len(), 3);
7860         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7861         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7862         assert_eq!(reestablish_2.len(), 3);
7863
7864         // Reestablish chan_1
7865         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7866         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7867         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7868         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7869         // Reestablish chan_2
7870         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7871         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7872         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7873         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7874         // Reestablish chan_3
7875         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7876         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7877         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7878         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7879
7880         nodes[0].node.timer_tick_occurred();
7881         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7882         nodes[0].node.timer_tick_occurred();
7883         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7884         assert_eq!(msg_events.len(), 3);
7885         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7886         for e in msg_events {
7887                 match e {
7888                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7889                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7890                                 // Check that each channel gets updated exactly once
7891                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7892                                         panic!("Generated ChannelUpdate for wrong chan!");
7893                                 }
7894                         },
7895                         _ => panic!("Unexpected event"),
7896                 }
7897         }
7898 }
7899
7900 #[test]
7901 fn test_bump_penalty_txn_on_revoked_commitment() {
7902         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7903         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7904
7905         let chanmon_cfgs = create_chanmon_cfgs(2);
7906         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7907         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7908         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7909
7910         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7911         let logger = test_utils::TestLogger::new();
7912
7913         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7914         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7915         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();
7916         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7917
7918         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7919         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7920         assert_eq!(revoked_txn[0].output.len(), 4);
7921         assert_eq!(revoked_txn[0].input.len(), 1);
7922         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7923         let revoked_txid = revoked_txn[0].txid();
7924
7925         let mut penalty_sum = 0;
7926         for outp in revoked_txn[0].output.iter() {
7927                 if outp.script_pubkey.is_v0_p2wsh() {
7928                         penalty_sum += outp.value;
7929                 }
7930         }
7931
7932         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7933         let header_114 = connect_blocks(&nodes[1], 14);
7934
7935         // Actually revoke tx by claiming a HTLC
7936         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7937         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7938         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7939         check_added_monitors!(nodes[1], 1);
7940
7941         // One or more justice tx should have been broadcast, check it
7942         let penalty_1;
7943         let feerate_1;
7944         {
7945                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7946                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7947                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7948                 assert_eq!(node_txn[0].output.len(), 1);
7949                 check_spends!(node_txn[0], revoked_txn[0]);
7950                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7951                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7952                 penalty_1 = node_txn[0].txid();
7953                 node_txn.clear();
7954         };
7955
7956         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7957         connect_blocks(&nodes[1], 15);
7958         let mut penalty_2 = penalty_1;
7959         let mut feerate_2 = 0;
7960         {
7961                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7962                 assert_eq!(node_txn.len(), 1);
7963                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7964                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7965                         assert_eq!(node_txn[0].output.len(), 1);
7966                         check_spends!(node_txn[0], revoked_txn[0]);
7967                         penalty_2 = node_txn[0].txid();
7968                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7969                         assert_ne!(penalty_2, penalty_1);
7970                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7971                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7972                         // Verify 25% bump heuristic
7973                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7974                         node_txn.clear();
7975                 }
7976         }
7977         assert_ne!(feerate_2, 0);
7978
7979         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7980         connect_blocks(&nodes[1], 1);
7981         let penalty_3;
7982         let mut feerate_3 = 0;
7983         {
7984                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7985                 assert_eq!(node_txn.len(), 1);
7986                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7987                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7988                         assert_eq!(node_txn[0].output.len(), 1);
7989                         check_spends!(node_txn[0], revoked_txn[0]);
7990                         penalty_3 = node_txn[0].txid();
7991                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7992                         assert_ne!(penalty_3, penalty_2);
7993                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7994                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7995                         // Verify 25% bump heuristic
7996                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7997                         node_txn.clear();
7998                 }
7999         }
8000         assert_ne!(feerate_3, 0);
8001
8002         nodes[1].node.get_and_clear_pending_events();
8003         nodes[1].node.get_and_clear_pending_msg_events();
8004 }
8005
8006 #[test]
8007 fn test_bump_penalty_txn_on_revoked_htlcs() {
8008         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8009         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8010
8011         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8012         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8013         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8014         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8015         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8016
8017         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8018         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8019         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8020                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8021         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8022         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8023                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8024         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8025
8026         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8027         assert_eq!(revoked_local_txn[0].input.len(), 1);
8028         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8029
8030         // Revoke local commitment tx
8031         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8032
8033         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8034         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8035         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8036         check_closed_broadcast!(nodes[1], true);
8037         check_added_monitors!(nodes[1], 1);
8038         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8039
8040         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8041         assert_eq!(revoked_htlc_txn.len(), 3);
8042         check_spends!(revoked_htlc_txn[1], chan.3);
8043
8044         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8045         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8046         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8047
8048         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8049         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8050         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8051         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8052
8053         // Broadcast set of revoked txn on A
8054         let hash_128 = connect_blocks(&nodes[0], 40);
8055         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8056         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8057         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8058         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8059         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8060         let first;
8061         let feerate_1;
8062         let penalty_txn;
8063         {
8064                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8065                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8066                 // Verify claim tx are spending revoked HTLC txn
8067
8068                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8069                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8070                 // which are included in the same block (they are broadcasted because we scan the
8071                 // transactions linearly and generate claims as we go, they likely should be removed in the
8072                 // future).
8073                 assert_eq!(node_txn[0].input.len(), 1);
8074                 check_spends!(node_txn[0], revoked_local_txn[0]);
8075                 assert_eq!(node_txn[1].input.len(), 1);
8076                 check_spends!(node_txn[1], revoked_local_txn[0]);
8077                 assert_eq!(node_txn[2].input.len(), 1);
8078                 check_spends!(node_txn[2], revoked_local_txn[0]);
8079
8080                 // Each of the three justice transactions claim a separate (single) output of the three
8081                 // available, which we check here:
8082                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8083                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8084                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8085
8086                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8087                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8088
8089                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8090                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8091                 // a remote commitment tx has already been confirmed).
8092                 check_spends!(node_txn[3], chan.3);
8093
8094                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8095                 // output, checked above).
8096                 assert_eq!(node_txn[4].input.len(), 2);
8097                 assert_eq!(node_txn[4].output.len(), 1);
8098                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8099
8100                 first = node_txn[4].txid();
8101                 // Store both feerates for later comparison
8102                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8103                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8104                 penalty_txn = vec![node_txn[2].clone()];
8105                 node_txn.clear();
8106         }
8107
8108         // Connect one more block to see if bumped penalty are issued for HTLC txn
8109         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8110         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8111         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8112         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8113         {
8114                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8115                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8116
8117                 check_spends!(node_txn[0], revoked_local_txn[0]);
8118                 check_spends!(node_txn[1], revoked_local_txn[0]);
8119                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8120                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8121                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8122                 } else {
8123                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8124                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8125                 }
8126
8127                 node_txn.clear();
8128         };
8129
8130         // Few more blocks to confirm penalty txn
8131         connect_blocks(&nodes[0], 4);
8132         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8133         let header_144 = connect_blocks(&nodes[0], 9);
8134         let node_txn = {
8135                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8136                 assert_eq!(node_txn.len(), 1);
8137
8138                 assert_eq!(node_txn[0].input.len(), 2);
8139                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8140                 // Verify bumped tx is different and 25% bump heuristic
8141                 assert_ne!(first, node_txn[0].txid());
8142                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8143                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8144                 assert!(feerate_2 * 100 > feerate_1 * 125);
8145                 let txn = vec![node_txn[0].clone()];
8146                 node_txn.clear();
8147                 txn
8148         };
8149         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8150         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8151         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8152         connect_blocks(&nodes[0], 20);
8153         {
8154                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8155                 // We verify than no new transaction has been broadcast because previously
8156                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8157                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8158                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8159                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8160                 // up bumped justice generation.
8161                 assert_eq!(node_txn.len(), 0);
8162                 node_txn.clear();
8163         }
8164         check_closed_broadcast!(nodes[0], true);
8165         check_added_monitors!(nodes[0], 1);
8166 }
8167
8168 #[test]
8169 fn test_bump_penalty_txn_on_remote_commitment() {
8170         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8171         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8172
8173         // Create 2 HTLCs
8174         // Provide preimage for one
8175         // Check aggregation
8176
8177         let chanmon_cfgs = create_chanmon_cfgs(2);
8178         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8179         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8180         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8181
8182         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8183         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8184         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8185
8186         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8187         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8188         assert_eq!(remote_txn[0].output.len(), 4);
8189         assert_eq!(remote_txn[0].input.len(), 1);
8190         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8191
8192         // Claim a HTLC without revocation (provide B monitor with preimage)
8193         nodes[1].node.claim_funds(payment_preimage);
8194         mine_transaction(&nodes[1], &remote_txn[0]);
8195         check_added_monitors!(nodes[1], 2);
8196         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8197
8198         // One or more claim tx should have been broadcast, check it
8199         let timeout;
8200         let preimage;
8201         let preimage_bump;
8202         let feerate_timeout;
8203         let feerate_preimage;
8204         {
8205                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8206                 // 9 transactions including:
8207                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8208                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8209                 // 2 * HTLC-Success (one RBF bump we'll check later)
8210                 // 1 * HTLC-Timeout
8211                 assert_eq!(node_txn.len(), 8);
8212                 assert_eq!(node_txn[0].input.len(), 1);
8213                 assert_eq!(node_txn[6].input.len(), 1);
8214                 check_spends!(node_txn[0], remote_txn[0]);
8215                 check_spends!(node_txn[6], remote_txn[0]);
8216                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8217                 preimage_bump = node_txn[3].clone();
8218
8219                 check_spends!(node_txn[1], chan.3);
8220                 check_spends!(node_txn[2], node_txn[1]);
8221                 assert_eq!(node_txn[1], node_txn[4]);
8222                 assert_eq!(node_txn[2], node_txn[5]);
8223
8224                 timeout = node_txn[6].txid();
8225                 let index = node_txn[6].input[0].previous_output.vout;
8226                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8227                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8228
8229                 preimage = node_txn[0].txid();
8230                 let index = node_txn[0].input[0].previous_output.vout;
8231                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8232                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8233
8234                 node_txn.clear();
8235         };
8236         assert_ne!(feerate_timeout, 0);
8237         assert_ne!(feerate_preimage, 0);
8238
8239         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8240         connect_blocks(&nodes[1], 15);
8241         {
8242                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8243                 assert_eq!(node_txn.len(), 1);
8244                 assert_eq!(node_txn[0].input.len(), 1);
8245                 assert_eq!(preimage_bump.input.len(), 1);
8246                 check_spends!(node_txn[0], remote_txn[0]);
8247                 check_spends!(preimage_bump, remote_txn[0]);
8248
8249                 let index = preimage_bump.input[0].previous_output.vout;
8250                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8251                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8252                 assert!(new_feerate * 100 > feerate_timeout * 125);
8253                 assert_ne!(timeout, preimage_bump.txid());
8254
8255                 let index = node_txn[0].input[0].previous_output.vout;
8256                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8257                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8258                 assert!(new_feerate * 100 > feerate_preimage * 125);
8259                 assert_ne!(preimage, node_txn[0].txid());
8260
8261                 node_txn.clear();
8262         }
8263
8264         nodes[1].node.get_and_clear_pending_events();
8265         nodes[1].node.get_and_clear_pending_msg_events();
8266 }
8267
8268 #[test]
8269 fn test_counterparty_raa_skip_no_crash() {
8270         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8271         // commitment transaction, we would have happily carried on and provided them the next
8272         // commitment transaction based on one RAA forward. This would probably eventually have led to
8273         // channel closure, but it would not have resulted in funds loss. Still, our
8274         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8275         // check simply that the channel is closed in response to such an RAA, but don't check whether
8276         // we decide to punish our counterparty for revoking their funds (as we don't currently
8277         // implement that).
8278         let chanmon_cfgs = create_chanmon_cfgs(2);
8279         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8280         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8281         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8282         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8283
8284         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8285         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8286         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8287         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8288         // Must revoke without gaps
8289         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8290         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8291                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8292
8293         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8294                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8295         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8296         check_added_monitors!(nodes[1], 1);
8297 }
8298
8299 #[test]
8300 fn test_bump_txn_sanitize_tracking_maps() {
8301         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8302         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8303
8304         let chanmon_cfgs = create_chanmon_cfgs(2);
8305         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8306         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8307         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8308
8309         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8310         // Lock HTLC in both directions
8311         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8312         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8313
8314         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8315         assert_eq!(revoked_local_txn[0].input.len(), 1);
8316         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8317
8318         // Revoke local commitment tx
8319         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8320
8321         // Broadcast set of revoked txn on A
8322         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8323         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8324         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8325
8326         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8327         check_closed_broadcast!(nodes[0], true);
8328         check_added_monitors!(nodes[0], 1);
8329         let penalty_txn = {
8330                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8331                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8332                 check_spends!(node_txn[0], revoked_local_txn[0]);
8333                 check_spends!(node_txn[1], revoked_local_txn[0]);
8334                 check_spends!(node_txn[2], revoked_local_txn[0]);
8335                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8336                 node_txn.clear();
8337                 penalty_txn
8338         };
8339         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8340         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8341         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8342         {
8343                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8344                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8345                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8346                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8347                 }
8348         }
8349 }
8350
8351 #[test]
8352 fn test_override_channel_config() {
8353         let chanmon_cfgs = create_chanmon_cfgs(2);
8354         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8355         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8356         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8357
8358         // Node0 initiates a channel to node1 using the override config.
8359         let mut override_config = UserConfig::default();
8360         override_config.own_channel_config.our_to_self_delay = 200;
8361
8362         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8363
8364         // Assert the channel created by node0 is using the override config.
8365         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8366         assert_eq!(res.channel_flags, 0);
8367         assert_eq!(res.to_self_delay, 200);
8368 }
8369
8370 #[test]
8371 fn test_override_0msat_htlc_minimum() {
8372         let mut zero_config = UserConfig::default();
8373         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8374         let chanmon_cfgs = create_chanmon_cfgs(2);
8375         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8376         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8377         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8378
8379         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8380         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8381         assert_eq!(res.htlc_minimum_msat, 1);
8382
8383         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8384         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8385         assert_eq!(res.htlc_minimum_msat, 1);
8386 }
8387
8388 #[test]
8389 fn test_simple_mpp() {
8390         // Simple test of sending a multi-path payment.
8391         let chanmon_cfgs = create_chanmon_cfgs(4);
8392         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8393         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8394         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8395
8396         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8397         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8398         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8399         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8400         let logger = test_utils::TestLogger::new();
8401
8402         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8403         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8404         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();
8405         let path = route.paths[0].clone();
8406         route.paths.push(path);
8407         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8408         route.paths[0][0].short_channel_id = chan_1_id;
8409         route.paths[0][1].short_channel_id = chan_3_id;
8410         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8411         route.paths[1][0].short_channel_id = chan_2_id;
8412         route.paths[1][1].short_channel_id = chan_4_id;
8413         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8414         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8415 }
8416
8417 #[test]
8418 fn test_preimage_storage() {
8419         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8420         let chanmon_cfgs = create_chanmon_cfgs(2);
8421         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8423         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8424
8425         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8426
8427         {
8428                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8429
8430                 let logger = test_utils::TestLogger::new();
8431                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8432                 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();
8433                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8434                 check_added_monitors!(nodes[0], 1);
8435                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8436                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8437                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8438                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8439         }
8440         // Note that after leaving the above scope we have no knowledge of any arguments or return
8441         // values from previous calls.
8442         expect_pending_htlcs_forwardable!(nodes[1]);
8443         let events = nodes[1].node.get_and_clear_pending_events();
8444         assert_eq!(events.len(), 1);
8445         match events[0] {
8446                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8447                         assert_eq!(user_payment_id, 42);
8448                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8449                 },
8450                 _ => panic!("Unexpected event"),
8451         }
8452 }
8453
8454 #[test]
8455 fn test_secret_timeout() {
8456         // Simple test of payment secret storage time outs
8457         let chanmon_cfgs = create_chanmon_cfgs(2);
8458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8461
8462         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8463
8464         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8465
8466         // We should fail to register the same payment hash twice, at least until we've connected a
8467         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8468         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8469                 assert_eq!(err, "Duplicate payment hash");
8470         } else { panic!(); }
8471         let mut block = {
8472                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8473                 Block {
8474                         header: BlockHeader {
8475                                 version: 0x2000000,
8476                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8477                                 merkle_root: Default::default(),
8478                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8479                         txdata: vec![],
8480                 }
8481         };
8482         connect_block(&nodes[1], &block);
8483         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8484                 assert_eq!(err, "Duplicate payment hash");
8485         } else { panic!(); }
8486
8487         // If we then connect the second block, we should be able to register the same payment hash
8488         // again with a different user_payment_id (this time getting a new payment secret).
8489         block.header.prev_blockhash = block.header.block_hash();
8490         block.header.time += 1;
8491         connect_block(&nodes[1], &block);
8492         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8493         assert_ne!(payment_secret_1, our_payment_secret);
8494
8495         {
8496                 let logger = test_utils::TestLogger::new();
8497                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8498                 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();
8499                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8500                 check_added_monitors!(nodes[0], 1);
8501                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8502                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8503                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8504                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8505         }
8506         // Note that after leaving the above scope we have no knowledge of any arguments or return
8507         // values from previous calls.
8508         expect_pending_htlcs_forwardable!(nodes[1]);
8509         let events = nodes[1].node.get_and_clear_pending_events();
8510         assert_eq!(events.len(), 1);
8511         match events[0] {
8512                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8513                         assert!(payment_preimage.is_none());
8514                         assert_eq!(user_payment_id, 42);
8515                         assert_eq!(payment_secret, our_payment_secret);
8516                         // We don't actually have the payment preimage with which to claim this payment!
8517                 },
8518                 _ => panic!("Unexpected event"),
8519         }
8520 }
8521
8522 #[test]
8523 fn test_bad_secret_hash() {
8524         // Simple test of unregistered payment hash/invalid payment secret handling
8525         let chanmon_cfgs = create_chanmon_cfgs(2);
8526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8529
8530         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8531
8532         let random_payment_hash = PaymentHash([42; 32]);
8533         let random_payment_secret = PaymentSecret([43; 32]);
8534         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8535
8536         let logger = test_utils::TestLogger::new();
8537         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8538         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();
8539
8540         // All the below cases should end up being handled exactly identically, so we macro the
8541         // resulting events.
8542         macro_rules! handle_unknown_invalid_payment_data {
8543                 () => {
8544                         check_added_monitors!(nodes[0], 1);
8545                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8546                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8547                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8548                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8549
8550                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8551                         // again to process the pending backwards-failure of the HTLC
8552                         expect_pending_htlcs_forwardable!(nodes[1]);
8553                         expect_pending_htlcs_forwardable!(nodes[1]);
8554                         check_added_monitors!(nodes[1], 1);
8555
8556                         // We should fail the payment back
8557                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8558                         match events.pop().unwrap() {
8559                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8560                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8561                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8562                                 },
8563                                 _ => panic!("Unexpected event"),
8564                         }
8565                 }
8566         }
8567
8568         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8569         // Error data is the HTLC value (100,000) and current block height
8570         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8571
8572         // Send a payment with the right payment hash but the wrong payment secret
8573         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8574         handle_unknown_invalid_payment_data!();
8575         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8576
8577         // Send a payment with a random payment hash, but the right payment secret
8578         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8579         handle_unknown_invalid_payment_data!();
8580         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8581
8582         // Send a payment with a random payment hash and random payment secret
8583         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8584         handle_unknown_invalid_payment_data!();
8585         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8586 }
8587
8588 #[test]
8589 fn test_update_err_monitor_lockdown() {
8590         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8591         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8592         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8593         //
8594         // This scenario may happen in a watchtower setup, where watchtower process a block height
8595         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8596         // commitment at same time.
8597
8598         let chanmon_cfgs = create_chanmon_cfgs(2);
8599         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8600         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8601         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8602
8603         // Create some initial channel
8604         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8605         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8606
8607         // Rebalance the network to generate htlc in the two directions
8608         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8609
8610         // Route a HTLC from node 0 to node 1 (but don't settle)
8611         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8612
8613         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8614         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8615         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8616         let persister = test_utils::TestPersister::new();
8617         let watchtower = {
8618                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8619                 let monitor = monitors.get(&outpoint).unwrap();
8620                 let mut w = test_utils::TestVecWriter(Vec::new());
8621                 monitor.write(&mut w).unwrap();
8622                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8623                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8624                 assert!(new_monitor == *monitor);
8625                 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);
8626                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8627                 watchtower
8628         };
8629         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8630         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8631         // transaction lock time requirements here.
8632         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8633         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8634
8635         // Try to update ChannelMonitor
8636         assert!(nodes[1].node.claim_funds(preimage));
8637         check_added_monitors!(nodes[1], 1);
8638         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8639         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8640         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8641         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8642                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8643                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8644                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8645                 } else { assert!(false); }
8646         } else { assert!(false); };
8647         // Our local monitor is in-sync and hasn't processed yet timeout
8648         check_added_monitors!(nodes[0], 1);
8649         let events = nodes[0].node.get_and_clear_pending_events();
8650         assert_eq!(events.len(), 1);
8651 }
8652
8653 #[test]
8654 fn test_concurrent_monitor_claim() {
8655         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8656         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8657         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8658         // state N+1 confirms. Alice claims output from state N+1.
8659
8660         let chanmon_cfgs = create_chanmon_cfgs(2);
8661         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8662         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8663         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8664
8665         // Create some initial channel
8666         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8667         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8668
8669         // Rebalance the network to generate htlc in the two directions
8670         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8671
8672         // Route a HTLC from node 0 to node 1 (but don't settle)
8673         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8674
8675         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8676         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8677         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8678         let persister = test_utils::TestPersister::new();
8679         let watchtower_alice = {
8680                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8681                 let monitor = monitors.get(&outpoint).unwrap();
8682                 let mut w = test_utils::TestVecWriter(Vec::new());
8683                 monitor.write(&mut w).unwrap();
8684                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8685                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8686                 assert!(new_monitor == *monitor);
8687                 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);
8688                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8689                 watchtower
8690         };
8691         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8692         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8693         // transaction lock time requirements here.
8694         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8695         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8696
8697         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8698         {
8699                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8700                 assert_eq!(txn.len(), 2);
8701                 txn.clear();
8702         }
8703
8704         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8705         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8706         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8707         let persister = test_utils::TestPersister::new();
8708         let watchtower_bob = {
8709                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8710                 let monitor = monitors.get(&outpoint).unwrap();
8711                 let mut w = test_utils::TestVecWriter(Vec::new());
8712                 monitor.write(&mut w).unwrap();
8713                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8714                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8715                 assert!(new_monitor == *monitor);
8716                 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);
8717                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8718                 watchtower
8719         };
8720         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8721         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8722
8723         // Route another payment to generate another update with still previous HTLC pending
8724         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8725         {
8726                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8727                 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();
8728                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8729         }
8730         check_added_monitors!(nodes[1], 1);
8731
8732         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8733         assert_eq!(updates.update_add_htlcs.len(), 1);
8734         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8735         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8736                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8737                         // Watchtower Alice should already have seen the block and reject the update
8738                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8739                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8740                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8741                 } else { assert!(false); }
8742         } else { assert!(false); };
8743         // Our local monitor is in-sync and hasn't processed yet timeout
8744         check_added_monitors!(nodes[0], 1);
8745
8746         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8747         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8748         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8749
8750         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8751         let bob_state_y;
8752         {
8753                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8754                 assert_eq!(txn.len(), 2);
8755                 bob_state_y = txn[0].clone();
8756                 txn.clear();
8757         };
8758
8759         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8760         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8761         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);
8762         {
8763                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8764                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8765                 // the onchain detection of the HTLC output
8766                 assert_eq!(htlc_txn.len(), 2);
8767                 check_spends!(htlc_txn[0], bob_state_y);
8768                 check_spends!(htlc_txn[1], bob_state_y);
8769         }
8770 }
8771
8772 #[test]
8773 fn test_pre_lockin_no_chan_closed_update() {
8774         // Test that if a peer closes a channel in response to a funding_created message we don't
8775         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8776         // message).
8777         //
8778         // Doing so would imply a channel monitor update before the initial channel monitor
8779         // registration, violating our API guarantees.
8780         //
8781         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8782         // then opening a second channel with the same funding output as the first (which is not
8783         // rejected because the first channel does not exist in the ChannelManager) and closing it
8784         // before receiving funding_signed.
8785         let chanmon_cfgs = create_chanmon_cfgs(2);
8786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8788         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8789
8790         // Create an initial channel
8791         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8792         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8793         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8794         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8795         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8796
8797         // Move the first channel through the funding flow...
8798         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8799
8800         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8801         check_added_monitors!(nodes[0], 0);
8802
8803         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8804         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8805         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8806         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8807 }
8808
8809 #[test]
8810 fn test_htlc_no_detection() {
8811         // This test is a mutation to underscore the detection logic bug we had
8812         // before #653. HTLC value routed is above the remaining balance, thus
8813         // inverting HTLC and `to_remote` output. HTLC will come second and
8814         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8815         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8816         // outputs order detection for correct spending children filtring.
8817
8818         let chanmon_cfgs = create_chanmon_cfgs(2);
8819         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8820         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8821         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8822
8823         // Create some initial channels
8824         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8825
8826         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8827         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8828         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8829         assert_eq!(local_txn[0].input.len(), 1);
8830         assert_eq!(local_txn[0].output.len(), 3);
8831         check_spends!(local_txn[0], chan_1.3);
8832
8833         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8834         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8835         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8836         // We deliberately connect the local tx twice as this should provoke a failure calling
8837         // this test before #653 fix.
8838         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);
8839         check_closed_broadcast!(nodes[0], true);
8840         check_added_monitors!(nodes[0], 1);
8841         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8842
8843         let htlc_timeout = {
8844                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8845                 assert_eq!(node_txn[1].input.len(), 1);
8846                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8847                 check_spends!(node_txn[1], local_txn[0]);
8848                 node_txn[1].clone()
8849         };
8850
8851         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8852         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8853         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8854         expect_payment_failed!(nodes[0], our_payment_hash, true);
8855 }
8856
8857 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8858         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8859         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8860         // Carol, Alice would be the upstream node, and Carol the downstream.)
8861         //
8862         // Steps of the test:
8863         // 1) Alice sends a HTLC to Carol through Bob.
8864         // 2) Carol doesn't settle the HTLC.
8865         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8866         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8867         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8868         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8869         // 5) Carol release the preimage to Bob off-chain.
8870         // 6) Bob claims the offered output on the broadcasted commitment.
8871         let chanmon_cfgs = create_chanmon_cfgs(3);
8872         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8873         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8874         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8875
8876         // Create some initial channels
8877         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8878         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8879
8880         // Steps (1) and (2):
8881         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8882         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8883
8884         // Check that Alice's commitment transaction now contains an output for this HTLC.
8885         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8886         check_spends!(alice_txn[0], chan_ab.3);
8887         assert_eq!(alice_txn[0].output.len(), 2);
8888         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8889         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8890         assert_eq!(alice_txn.len(), 2);
8891
8892         // Steps (3) and (4):
8893         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8894         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8895         let mut force_closing_node = 0; // Alice force-closes
8896         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8897         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8898         check_closed_broadcast!(nodes[force_closing_node], true);
8899         check_added_monitors!(nodes[force_closing_node], 1);
8900         if go_onchain_before_fulfill {
8901                 let txn_to_broadcast = match broadcast_alice {
8902                         true => alice_txn.clone(),
8903                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8904                 };
8905                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8906                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8907                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8908                 if broadcast_alice {
8909                         check_closed_broadcast!(nodes[1], true);
8910                         check_added_monitors!(nodes[1], 1);
8911                 }
8912                 assert_eq!(bob_txn.len(), 1);
8913                 check_spends!(bob_txn[0], chan_ab.3);
8914         }
8915
8916         // Step (5):
8917         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8918         // process of removing the HTLC from their commitment transactions.
8919         assert!(nodes[2].node.claim_funds(payment_preimage));
8920         check_added_monitors!(nodes[2], 1);
8921         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8922         assert!(carol_updates.update_add_htlcs.is_empty());
8923         assert!(carol_updates.update_fail_htlcs.is_empty());
8924         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8925         assert!(carol_updates.update_fee.is_none());
8926         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8927
8928         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8929         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8930         if !go_onchain_before_fulfill && broadcast_alice {
8931                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8932                 assert_eq!(events.len(), 1);
8933                 match events[0] {
8934                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8935                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8936                         },
8937                         _ => panic!("Unexpected event"),
8938                 };
8939         }
8940         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8941         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8942         // Carol<->Bob's updated commitment transaction info.
8943         check_added_monitors!(nodes[1], 2);
8944
8945         let events = nodes[1].node.get_and_clear_pending_msg_events();
8946         assert_eq!(events.len(), 2);
8947         let bob_revocation = match events[0] {
8948                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8949                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8950                         (*msg).clone()
8951                 },
8952                 _ => panic!("Unexpected event"),
8953         };
8954         let bob_updates = match events[1] {
8955                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8956                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8957                         (*updates).clone()
8958                 },
8959                 _ => panic!("Unexpected event"),
8960         };
8961
8962         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8963         check_added_monitors!(nodes[2], 1);
8964         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8965         check_added_monitors!(nodes[2], 1);
8966
8967         let events = nodes[2].node.get_and_clear_pending_msg_events();
8968         assert_eq!(events.len(), 1);
8969         let carol_revocation = match events[0] {
8970                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8971                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8972                         (*msg).clone()
8973                 },
8974                 _ => panic!("Unexpected event"),
8975         };
8976         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8977         check_added_monitors!(nodes[1], 1);
8978
8979         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8980         // here's where we put said channel's commitment tx on-chain.
8981         let mut txn_to_broadcast = alice_txn.clone();
8982         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8983         if !go_onchain_before_fulfill {
8984                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8985                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8986                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8987                 if broadcast_alice {
8988                         check_closed_broadcast!(nodes[1], true);
8989                         check_added_monitors!(nodes[1], 1);
8990                 }
8991                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8992                 if broadcast_alice {
8993                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8994                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8995                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8996                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8997                         // broadcasted.
8998                         assert_eq!(bob_txn.len(), 3);
8999                         check_spends!(bob_txn[1], chan_ab.3);
9000                 } else {
9001                         assert_eq!(bob_txn.len(), 2);
9002                         check_spends!(bob_txn[0], chan_ab.3);
9003                 }
9004         }
9005
9006         // Step (6):
9007         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9008         // broadcasted commitment transaction.
9009         {
9010                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9011                 if go_onchain_before_fulfill {
9012                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9013                         assert_eq!(bob_txn.len(), 2);
9014                 }
9015                 let script_weight = match broadcast_alice {
9016                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9017                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9018                 };
9019                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9020                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9021                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9022                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9023                 if broadcast_alice && !go_onchain_before_fulfill {
9024                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9025                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9026                 } else {
9027                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9028                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9029                 }
9030         }
9031 }
9032
9033 #[test]
9034 fn test_onchain_htlc_settlement_after_close() {
9035         do_test_onchain_htlc_settlement_after_close(true, true);
9036         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9037         do_test_onchain_htlc_settlement_after_close(true, false);
9038         do_test_onchain_htlc_settlement_after_close(false, false);
9039 }
9040
9041 #[test]
9042 fn test_duplicate_chan_id() {
9043         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9044         // already open we reject it and keep the old channel.
9045         //
9046         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9047         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9048         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9049         // updating logic for the existing channel.
9050         let chanmon_cfgs = create_chanmon_cfgs(2);
9051         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9052         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9053         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9054
9055         // Create an initial channel
9056         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9057         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9058         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9059         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()));
9060
9061         // Try to create a second channel with the same temporary_channel_id as the first and check
9062         // that it is rejected.
9063         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9064         {
9065                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9066                 assert_eq!(events.len(), 1);
9067                 match events[0] {
9068                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9069                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9070                                 // first (valid) and second (invalid) channels are closed, given they both have
9071                                 // the same non-temporary channel_id. However, currently we do not, so we just
9072                                 // move forward with it.
9073                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9074                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9075                         },
9076                         _ => panic!("Unexpected event"),
9077                 }
9078         }
9079
9080         // Move the first channel through the funding flow...
9081         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9082
9083         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9084         check_added_monitors!(nodes[0], 0);
9085
9086         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9087         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9088         {
9089                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9090                 assert_eq!(added_monitors.len(), 1);
9091                 assert_eq!(added_monitors[0].0, funding_output);
9092                 added_monitors.clear();
9093         }
9094         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9095
9096         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9097         let channel_id = funding_outpoint.to_channel_id();
9098
9099         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9100         // temporary one).
9101
9102         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9103         // Technically this is allowed by the spec, but we don't support it and there's little reason
9104         // to. Still, it shouldn't cause any other issues.
9105         open_chan_msg.temporary_channel_id = channel_id;
9106         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9107         {
9108                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9109                 assert_eq!(events.len(), 1);
9110                 match events[0] {
9111                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9112                                 // Technically, at this point, nodes[1] would be justified in thinking both
9113                                 // channels are closed, but currently we do not, so we just move forward with it.
9114                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9115                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9116                         },
9117                         _ => panic!("Unexpected event"),
9118                 }
9119         }
9120
9121         // Now try to create a second channel which has a duplicate funding output.
9122         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9123         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9124         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9125         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()));
9126         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9127
9128         let funding_created = {
9129                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9130                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9131                 let logger = test_utils::TestLogger::new();
9132                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9133         };
9134         check_added_monitors!(nodes[0], 0);
9135         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9136         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9137         // still needs to be cleared here.
9138         check_added_monitors!(nodes[1], 1);
9139
9140         // ...still, nodes[1] will reject the duplicate channel.
9141         {
9142                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9143                 assert_eq!(events.len(), 1);
9144                 match events[0] {
9145                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9146                                 // Technically, at this point, nodes[1] would be justified in thinking both
9147                                 // channels are closed, but currently we do not, so we just move forward with it.
9148                                 assert_eq!(msg.channel_id, channel_id);
9149                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9150                         },
9151                         _ => panic!("Unexpected event"),
9152                 }
9153         }
9154
9155         // finally, finish creating the original channel and send a payment over it to make sure
9156         // everything is functional.
9157         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9158         {
9159                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9160                 assert_eq!(added_monitors.len(), 1);
9161                 assert_eq!(added_monitors[0].0, funding_output);
9162                 added_monitors.clear();
9163         }
9164
9165         let events_4 = nodes[0].node.get_and_clear_pending_events();
9166         assert_eq!(events_4.len(), 0);
9167         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9168         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9169
9170         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9171         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9172         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9173         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9174 }
9175
9176 #[test]
9177 fn test_error_chans_closed() {
9178         // Test that we properly handle error messages, closing appropriate channels.
9179         //
9180         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9181         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9182         // we can test various edge cases around it to ensure we don't regress.
9183         let chanmon_cfgs = create_chanmon_cfgs(3);
9184         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9185         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9186         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9187
9188         // Create some initial channels
9189         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9190         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9191         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9192
9193         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9194         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9195         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9196
9197         // Closing a channel from a different peer has no effect
9198         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9199         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9200
9201         // Closing one channel doesn't impact others
9202         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9203         check_added_monitors!(nodes[0], 1);
9204         check_closed_broadcast!(nodes[0], false);
9205         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9206         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9207         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);
9208         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);
9209
9210         // A null channel ID should close all channels
9211         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9212         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9213         check_added_monitors!(nodes[0], 2);
9214         let events = nodes[0].node.get_and_clear_pending_msg_events();
9215         assert_eq!(events.len(), 2);
9216         match events[0] {
9217                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9218                         assert_eq!(msg.contents.flags & 2, 2);
9219                 },
9220                 _ => panic!("Unexpected event"),
9221         }
9222         match events[1] {
9223                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9224                         assert_eq!(msg.contents.flags & 2, 2);
9225                 },
9226                 _ => panic!("Unexpected event"),
9227         }
9228         // Note that at this point users of a standard PeerHandler will end up calling
9229         // peer_disconnected with no_connection_possible set to false, duplicating the
9230         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9231         // users with their own peer handling logic. We duplicate the call here, however.
9232         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9233         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9234
9235         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9236         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9237         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9238 }
9239
9240 #[test]
9241 fn test_invalid_funding_tx() {
9242         // Test that we properly handle invalid funding transactions sent to us from a peer.
9243         //
9244         // Previously, all other major lightning implementations had failed to properly sanitize
9245         // funding transactions from their counterparties, leading to a multi-implementation critical
9246         // security vulnerability (though we always sanitized properly, we've previously had
9247         // un-released crashes in the sanitization process).
9248         let chanmon_cfgs = create_chanmon_cfgs(2);
9249         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9250         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9251         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9252
9253         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9254         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()));
9255         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()));
9256
9257         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9258         for output in tx.output.iter_mut() {
9259                 // Make the confirmed funding transaction have a bogus script_pubkey
9260                 output.script_pubkey = bitcoin::Script::new();
9261         }
9262
9263         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9264         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()));
9265         check_added_monitors!(nodes[1], 1);
9266
9267         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()));
9268         check_added_monitors!(nodes[0], 1);
9269
9270         let events_1 = nodes[0].node.get_and_clear_pending_events();
9271         assert_eq!(events_1.len(), 0);
9272
9273         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9274         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9275         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9276
9277         confirm_transaction_at(&nodes[1], &tx, 1);
9278         check_added_monitors!(nodes[1], 1);
9279         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9280         assert_eq!(events_2.len(), 1);
9281         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9282                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9283                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9284                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9285                 } else { panic!(); }
9286         } else { panic!(); }
9287         assert_eq!(nodes[1].node.list_channels().len(), 0);
9288 }
9289
9290 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9291         // In the first version of the chain::Confirm interface, after a refactor was made to not
9292         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9293         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9294         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9295         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9296         // spending transaction until height N+1 (or greater). This was due to the way
9297         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9298         // spending transaction at the height the input transaction was confirmed at, not whether we
9299         // should broadcast a spending transaction at the current height.
9300         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9301         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9302         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9303         // until we learned about an additional block.
9304         //
9305         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9306         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9307         let chanmon_cfgs = create_chanmon_cfgs(3);
9308         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9309         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9310         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9311         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9312
9313         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9314         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9315         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9316         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9317         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9318
9319         nodes[1].node.force_close_channel(&channel_id).unwrap();
9320         check_closed_broadcast!(nodes[1], true);
9321         check_added_monitors!(nodes[1], 1);
9322         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9323         assert_eq!(node_txn.len(), 1);
9324
9325         let conf_height = nodes[1].best_block_info().1;
9326         if !test_height_before_timelock {
9327                 connect_blocks(&nodes[1], 24 * 6);
9328         }
9329         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9330                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9331         if test_height_before_timelock {
9332                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9333                 // generate any events or broadcast any transactions
9334                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9335                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9336         } else {
9337                 // We should broadcast an HTLC transaction spending our funding transaction first
9338                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9339                 assert_eq!(spending_txn.len(), 2);
9340                 assert_eq!(spending_txn[0], node_txn[0]);
9341                 check_spends!(spending_txn[1], node_txn[0]);
9342                 // We should also generate a SpendableOutputs event with the to_self output (as its
9343                 // timelock is up).
9344                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9345                 assert_eq!(descriptor_spend_txn.len(), 1);
9346
9347                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9348                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9349                 // additional block built on top of the current chain.
9350                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9351                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9352                 expect_pending_htlcs_forwardable!(nodes[1]);
9353                 check_added_monitors!(nodes[1], 1);
9354
9355                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9356                 assert!(updates.update_add_htlcs.is_empty());
9357                 assert!(updates.update_fulfill_htlcs.is_empty());
9358                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9359                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9360                 assert!(updates.update_fee.is_none());
9361                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9362                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9363                 expect_payment_failed!(nodes[0], payment_hash, false);
9364                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9365         }
9366 }
9367 #[test]
9368 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9369         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9370         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9371 }