_ 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: Mutex::new(6000) };
1703         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(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: Mutex::new(6000) };
1725         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(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         // When this test was written, the default base fee floated based on the HTLC count.
1899         // It is now fixed, so we simply set the fee to the expected value here.
1900         let mut config = test_default_channel_config();
1901         config.channel_options.forwarding_fee_base_msat = 239;
1902         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1903         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1904         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1905         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1906
1907         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1908         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1909
1910         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1911         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1912
1913         macro_rules! expect_forward {
1914                 ($node: expr) => {{
1915                         let mut events = $node.node.get_and_clear_pending_msg_events();
1916                         assert_eq!(events.len(), 1);
1917                         check_added_monitors!($node, 1);
1918                         let payment_event = SendEvent::from_event(events.remove(0));
1919                         payment_event
1920                 }}
1921         }
1922
1923         let feemsat = 239; // set above
1924         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1925         let feerate = get_feerate!(nodes[0], chan_1.2);
1926
1927         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1928
1929         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1930         {
1931                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1932                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1933                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1934                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1935                         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)));
1936                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1937                 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);
1938         }
1939
1940         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1941         // nodes[0]'s wealth
1942         loop {
1943                 let amt_msat = recv_value_0 + total_fee_msat;
1944                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1945                 // Also, ensure that each payment has enough to be over the dust limit to
1946                 // ensure it'll be included in each commit tx fee calculation.
1947                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1948                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1949                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1950                         break;
1951                 }
1952                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1953
1954                 let (stat01_, stat11_, stat12_, stat22_) = (
1955                         get_channel_value_stat!(nodes[0], chan_1.2),
1956                         get_channel_value_stat!(nodes[1], chan_1.2),
1957                         get_channel_value_stat!(nodes[1], chan_2.2),
1958                         get_channel_value_stat!(nodes[2], chan_2.2),
1959                 );
1960
1961                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1962                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1963                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1964                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1965                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1966         }
1967
1968         // adding pending output.
1969         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1970         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1971         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1972         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1973         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1974         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1975         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1976         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1977         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1978         // policy.
1979         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1980         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1981         let amt_msat_1 = recv_value_1 + total_fee_msat;
1982
1983         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);
1984         let payment_event_1 = {
1985                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1986                 check_added_monitors!(nodes[0], 1);
1987
1988                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1989                 assert_eq!(events.len(), 1);
1990                 SendEvent::from_event(events.remove(0))
1991         };
1992         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1993
1994         // channel reserve test with htlc pending output > 0
1995         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1996         {
1997                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1998                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1999                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2000                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2001         }
2002
2003         // split the rest to test holding cell
2004         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2005         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2006         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2007         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2008         {
2009                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2010                 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);
2011         }
2012
2013         // now see if they go through on both sides
2014         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);
2015         // but this will stuck in the holding cell
2016         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2017         check_added_monitors!(nodes[0], 0);
2018         let events = nodes[0].node.get_and_clear_pending_events();
2019         assert_eq!(events.len(), 0);
2020
2021         // test with outbound holding cell amount > 0
2022         {
2023                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2024                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2025                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2026                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027                 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);
2028         }
2029
2030         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);
2031         // this will also stuck in the holding cell
2032         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2033         check_added_monitors!(nodes[0], 0);
2034         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2035         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2036
2037         // flush the pending htlc
2038         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2039         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2040         check_added_monitors!(nodes[1], 1);
2041
2042         // the pending htlc should be promoted to committed
2043         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2044         check_added_monitors!(nodes[0], 1);
2045         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2046
2047         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2048         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2049         // No commitment_signed so get_event_msg's assert(len == 1) passes
2050         check_added_monitors!(nodes[0], 1);
2051
2052         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2053         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2054         check_added_monitors!(nodes[1], 1);
2055
2056         expect_pending_htlcs_forwardable!(nodes[1]);
2057
2058         let ref payment_event_11 = expect_forward!(nodes[1]);
2059         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2060         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2061
2062         expect_pending_htlcs_forwardable!(nodes[2]);
2063         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2064
2065         // flush the htlcs in the holding cell
2066         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2068         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2069         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2070         expect_pending_htlcs_forwardable!(nodes[1]);
2071
2072         let ref payment_event_3 = expect_forward!(nodes[1]);
2073         assert_eq!(payment_event_3.msgs.len(), 2);
2074         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2075         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2076
2077         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2078         expect_pending_htlcs_forwardable!(nodes[2]);
2079
2080         let events = nodes[2].node.get_and_clear_pending_events();
2081         assert_eq!(events.len(), 2);
2082         match events[0] {
2083                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2084                         assert_eq!(our_payment_hash_21, *payment_hash);
2085                         assert!(payment_preimage.is_none());
2086                         assert_eq!(our_payment_secret_21, *payment_secret);
2087                         assert_eq!(recv_value_21, amt);
2088                 },
2089                 _ => panic!("Unexpected event"),
2090         }
2091         match events[1] {
2092                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2093                         assert_eq!(our_payment_hash_22, *payment_hash);
2094                         assert!(payment_preimage.is_none());
2095                         assert_eq!(our_payment_secret_22, *payment_secret);
2096                         assert_eq!(recv_value_22, amt);
2097                 },
2098                 _ => panic!("Unexpected event"),
2099         }
2100
2101         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2102         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2103         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2104
2105         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2106         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2107         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2108
2109         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2110         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);
2111         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2112         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2113         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2114
2115         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2116         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2117 }
2118
2119 #[test]
2120 fn channel_reserve_in_flight_removes() {
2121         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2122         // can send to its counterparty, but due to update ordering, the other side may not yet have
2123         // considered those HTLCs fully removed.
2124         // This tests that we don't count HTLCs which will not be included in the next remote
2125         // commitment transaction towards the reserve value (as it implies no commitment transaction
2126         // will be generated which violates the remote reserve value).
2127         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2128         // To test this we:
2129         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2130         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2131         //    you only consider the value of the first HTLC, it may not),
2132         //  * start routing a third HTLC from A to B,
2133         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2134         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2135         //  * deliver the first fulfill from B
2136         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2137         //    claim,
2138         //  * deliver A's response CS and RAA.
2139         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2140         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2141         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2142         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2143         let chanmon_cfgs = create_chanmon_cfgs(2);
2144         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2145         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2146         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2147         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2148         let logger = test_utils::TestLogger::new();
2149
2150         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2151         // Route the first two HTLCs.
2152         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2153         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2154
2155         // Start routing the third HTLC (this is just used to get everyone in the right state).
2156         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2157         let send_1 = {
2158                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2159                 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();
2160                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2161                 check_added_monitors!(nodes[0], 1);
2162                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2163                 assert_eq!(events.len(), 1);
2164                 SendEvent::from_event(events.remove(0))
2165         };
2166
2167         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2168         // initial fulfill/CS.
2169         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2170         check_added_monitors!(nodes[1], 1);
2171         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2172
2173         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2174         // remove the second HTLC when we send the HTLC back from B to A.
2175         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2176         check_added_monitors!(nodes[1], 1);
2177         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2178
2179         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2180         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2181         check_added_monitors!(nodes[0], 1);
2182         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2183         expect_payment_sent!(nodes[0], payment_preimage_1);
2184
2185         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2186         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2187         check_added_monitors!(nodes[1], 1);
2188         // B is already AwaitingRAA, so cant generate a CS here
2189         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2190
2191         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2192         check_added_monitors!(nodes[1], 1);
2193         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2194
2195         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2196         check_added_monitors!(nodes[0], 1);
2197         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2198
2199         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2200         check_added_monitors!(nodes[1], 1);
2201         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2202
2203         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2204         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2205         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2206         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2207         // on-chain as necessary).
2208         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2209         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2210         check_added_monitors!(nodes[0], 1);
2211         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2212         expect_payment_sent!(nodes[0], payment_preimage_2);
2213
2214         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2215         check_added_monitors!(nodes[1], 1);
2216         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2217
2218         expect_pending_htlcs_forwardable!(nodes[1]);
2219         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2220
2221         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2222         // resolve the second HTLC from A's point of view.
2223         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2224         check_added_monitors!(nodes[0], 1);
2225         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2226
2227         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2228         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2229         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2230         let send_2 = {
2231                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2232                 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();
2233                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2234                 check_added_monitors!(nodes[1], 1);
2235                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2236                 assert_eq!(events.len(), 1);
2237                 SendEvent::from_event(events.remove(0))
2238         };
2239
2240         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2241         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2242         check_added_monitors!(nodes[0], 1);
2243         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2244
2245         // Now just resolve all the outstanding messages/HTLCs for completeness...
2246
2247         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2248         check_added_monitors!(nodes[1], 1);
2249         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2250
2251         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2252         check_added_monitors!(nodes[1], 1);
2253
2254         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2255         check_added_monitors!(nodes[0], 1);
2256         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2257
2258         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2259         check_added_monitors!(nodes[1], 1);
2260         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2261
2262         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2263         check_added_monitors!(nodes[0], 1);
2264
2265         expect_pending_htlcs_forwardable!(nodes[0]);
2266         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2267
2268         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2269         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2270 }
2271
2272 #[test]
2273 fn channel_monitor_network_test() {
2274         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2275         // tests that ChannelMonitor is able to recover from various states.
2276         let chanmon_cfgs = create_chanmon_cfgs(5);
2277         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2278         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2279         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2280
2281         // Create some initial channels
2282         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2283         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2284         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2285         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2286
2287         // Make sure all nodes are at the same starting height
2288         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2289         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2290         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2291         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2292         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2293
2294         // Rebalance the network a bit by relaying one payment through all the channels...
2295         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2296         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2297         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2298         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2299
2300         // Simple case with no pending HTLCs:
2301         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2302         check_added_monitors!(nodes[1], 1);
2303         check_closed_broadcast!(nodes[1], false);
2304         {
2305                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2306                 assert_eq!(node_txn.len(), 1);
2307                 mine_transaction(&nodes[0], &node_txn[0]);
2308                 check_added_monitors!(nodes[0], 1);
2309                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2310         }
2311         check_closed_broadcast!(nodes[0], true);
2312         assert_eq!(nodes[0].node.list_channels().len(), 0);
2313         assert_eq!(nodes[1].node.list_channels().len(), 1);
2314
2315         // One pending HTLC is discarded by the force-close:
2316         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2317
2318         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2319         // broadcasted until we reach the timelock time).
2320         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2321         check_closed_broadcast!(nodes[1], false);
2322         check_added_monitors!(nodes[1], 1);
2323         {
2324                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2325                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2326                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2327                 mine_transaction(&nodes[2], &node_txn[0]);
2328                 check_added_monitors!(nodes[2], 1);
2329                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2330         }
2331         check_closed_broadcast!(nodes[2], true);
2332         assert_eq!(nodes[1].node.list_channels().len(), 0);
2333         assert_eq!(nodes[2].node.list_channels().len(), 1);
2334
2335         macro_rules! claim_funds {
2336                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2337                         {
2338                                 assert!($node.node.claim_funds($preimage));
2339                                 check_added_monitors!($node, 1);
2340
2341                                 let events = $node.node.get_and_clear_pending_msg_events();
2342                                 assert_eq!(events.len(), 1);
2343                                 match events[0] {
2344                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2345                                                 assert!(update_add_htlcs.is_empty());
2346                                                 assert!(update_fail_htlcs.is_empty());
2347                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2348                                         },
2349                                         _ => panic!("Unexpected event"),
2350                                 };
2351                         }
2352                 }
2353         }
2354
2355         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2356         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2357         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2358         check_added_monitors!(nodes[2], 1);
2359         check_closed_broadcast!(nodes[2], false);
2360         let node2_commitment_txid;
2361         {
2362                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2363                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2364                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2365                 node2_commitment_txid = node_txn[0].txid();
2366
2367                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2368                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2369                 mine_transaction(&nodes[3], &node_txn[0]);
2370                 check_added_monitors!(nodes[3], 1);
2371                 check_preimage_claim(&nodes[3], &node_txn);
2372         }
2373         check_closed_broadcast!(nodes[3], true);
2374         assert_eq!(nodes[2].node.list_channels().len(), 0);
2375         assert_eq!(nodes[3].node.list_channels().len(), 1);
2376
2377         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2378         // confusing us in the following tests.
2379         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2380
2381         // One pending HTLC to time out:
2382         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2383         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2384         // buffer space).
2385
2386         let (close_chan_update_1, close_chan_update_2) = {
2387                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2388                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2389                 assert_eq!(events.len(), 2);
2390                 let close_chan_update_1 = match events[0] {
2391                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2392                                 msg.clone()
2393                         },
2394                         _ => panic!("Unexpected event"),
2395                 };
2396                 match events[1] {
2397                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2398                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2399                         },
2400                         _ => panic!("Unexpected event"),
2401                 }
2402                 check_added_monitors!(nodes[3], 1);
2403
2404                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2405                 {
2406                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2407                         node_txn.retain(|tx| {
2408                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2409                                         false
2410                                 } else { true }
2411                         });
2412                 }
2413
2414                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2415
2416                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2417                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2418
2419                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2420                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2421                 assert_eq!(events.len(), 2);
2422                 let close_chan_update_2 = match events[0] {
2423                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2424                                 msg.clone()
2425                         },
2426                         _ => panic!("Unexpected event"),
2427                 };
2428                 match events[1] {
2429                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2430                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2431                         },
2432                         _ => panic!("Unexpected event"),
2433                 }
2434                 check_added_monitors!(nodes[4], 1);
2435                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2436
2437                 mine_transaction(&nodes[4], &node_txn[0]);
2438                 check_preimage_claim(&nodes[4], &node_txn);
2439                 (close_chan_update_1, close_chan_update_2)
2440         };
2441         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2442         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2443         assert_eq!(nodes[3].node.list_channels().len(), 0);
2444         assert_eq!(nodes[4].node.list_channels().len(), 0);
2445
2446         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2447 }
2448
2449 #[test]
2450 fn test_justice_tx() {
2451         // Test justice txn built on revoked HTLC-Success tx, against both sides
2452         let mut alice_config = UserConfig::default();
2453         alice_config.channel_options.announced_channel = true;
2454         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2455         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2456         let mut bob_config = UserConfig::default();
2457         bob_config.channel_options.announced_channel = true;
2458         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2459         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2460         let user_cfgs = [Some(alice_config), Some(bob_config)];
2461         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2462         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2463         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2464         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2466         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2467         // Create some new channels:
2468         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2469
2470         // A pending HTLC which will be revoked:
2471         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2472         // Get the will-be-revoked local txn from nodes[0]
2473         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2474         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2475         assert_eq!(revoked_local_txn[0].input.len(), 1);
2476         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2477         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2478         assert_eq!(revoked_local_txn[1].input.len(), 1);
2479         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2480         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2481         // Revoke the old state
2482         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2483
2484         {
2485                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2486                 {
2487                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2488                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2489                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2490
2491                         check_spends!(node_txn[0], revoked_local_txn[0]);
2492                         node_txn.swap_remove(0);
2493                         node_txn.truncate(1);
2494                 }
2495                 check_added_monitors!(nodes[1], 1);
2496                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2497
2498                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2499                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2500                 // Verify broadcast of revoked HTLC-timeout
2501                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2502                 check_added_monitors!(nodes[0], 1);
2503                 // Broadcast revoked HTLC-timeout on node 1
2504                 mine_transaction(&nodes[1], &node_txn[1]);
2505                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2506         }
2507         get_announce_close_broadcast_events(&nodes, 0, 1);
2508
2509         assert_eq!(nodes[0].node.list_channels().len(), 0);
2510         assert_eq!(nodes[1].node.list_channels().len(), 0);
2511
2512         // We test justice_tx build by A on B's revoked HTLC-Success tx
2513         // Create some new channels:
2514         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2515         {
2516                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2517                 node_txn.clear();
2518         }
2519
2520         // A pending HTLC which will be revoked:
2521         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2522         // Get the will-be-revoked local txn from B
2523         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2524         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2525         assert_eq!(revoked_local_txn[0].input.len(), 1);
2526         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2527         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2528         // Revoke the old state
2529         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2530         {
2531                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2532                 {
2533                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2534                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2535                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2536
2537                         check_spends!(node_txn[0], revoked_local_txn[0]);
2538                         node_txn.swap_remove(0);
2539                 }
2540                 check_added_monitors!(nodes[0], 1);
2541                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2542
2543                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2544                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2545                 check_added_monitors!(nodes[1], 1);
2546                 mine_transaction(&nodes[0], &node_txn[1]);
2547                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2548         }
2549         get_announce_close_broadcast_events(&nodes, 0, 1);
2550         assert_eq!(nodes[0].node.list_channels().len(), 0);
2551         assert_eq!(nodes[1].node.list_channels().len(), 0);
2552 }
2553
2554 #[test]
2555 fn revoked_output_claim() {
2556         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2557         // transaction is broadcast by its counterparty
2558         let chanmon_cfgs = create_chanmon_cfgs(2);
2559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2561         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2562         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2563         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2564         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2565         assert_eq!(revoked_local_txn.len(), 1);
2566         // Only output is the full channel value back to nodes[0]:
2567         assert_eq!(revoked_local_txn[0].output.len(), 1);
2568         // Send a payment through, updating everyone's latest commitment txn
2569         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2570
2571         // Inform nodes[1] that nodes[0] broadcast a stale tx
2572         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2573         check_added_monitors!(nodes[1], 1);
2574         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2575         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2576
2577         check_spends!(node_txn[0], revoked_local_txn[0]);
2578         check_spends!(node_txn[1], chan_1.3);
2579
2580         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2581         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2582         get_announce_close_broadcast_events(&nodes, 0, 1);
2583         check_added_monitors!(nodes[0], 1)
2584 }
2585
2586 #[test]
2587 fn claim_htlc_outputs_shared_tx() {
2588         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2589         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2590         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2591         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2592         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2593         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2594
2595         // Create some new channel:
2596         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2597
2598         // Rebalance the network to generate htlc in the two directions
2599         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2600         // 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
2601         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2602         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2603
2604         // Get the will-be-revoked local txn from node[0]
2605         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2606         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2607         assert_eq!(revoked_local_txn[0].input.len(), 1);
2608         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2609         assert_eq!(revoked_local_txn[1].input.len(), 1);
2610         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2611         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2612         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2613
2614         //Revoke the old state
2615         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2616
2617         {
2618                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2619                 check_added_monitors!(nodes[0], 1);
2620                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2621                 check_added_monitors!(nodes[1], 1);
2622                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2623                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2624
2625                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2626                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2627
2628                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2629                 check_spends!(node_txn[0], revoked_local_txn[0]);
2630
2631                 let mut witness_lens = BTreeSet::new();
2632                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2633                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2634                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2635                 assert_eq!(witness_lens.len(), 3);
2636                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2637                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2638                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2639
2640                 // Next nodes[1] broadcasts its current local tx state:
2641                 assert_eq!(node_txn[1].input.len(), 1);
2642                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2643         }
2644         get_announce_close_broadcast_events(&nodes, 0, 1);
2645         assert_eq!(nodes[0].node.list_channels().len(), 0);
2646         assert_eq!(nodes[1].node.list_channels().len(), 0);
2647 }
2648
2649 #[test]
2650 fn claim_htlc_outputs_single_tx() {
2651         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2652         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2653         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2654         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2655         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2656         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2657
2658         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2659
2660         // Rebalance the network to generate htlc in the two directions
2661         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2662         // 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
2663         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2664         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2665         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2666
2667         // Get the will-be-revoked local txn from node[0]
2668         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2669
2670         //Revoke the old state
2671         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2672
2673         {
2674                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2675                 check_added_monitors!(nodes[0], 1);
2676                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2677                 check_added_monitors!(nodes[1], 1);
2678                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2679
2680                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2681                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2682
2683                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2684                 assert_eq!(node_txn.len(), 9);
2685                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2686                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2687                 // 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)
2688                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2689
2690                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2691                 assert_eq!(node_txn[0].input.len(), 1);
2692                 check_spends!(node_txn[0], chan_1.3);
2693                 assert_eq!(node_txn[1].input.len(), 1);
2694                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2695                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2696                 check_spends!(node_txn[1], node_txn[0]);
2697
2698                 // Justice transactions are indices 1-2-4
2699                 assert_eq!(node_txn[2].input.len(), 1);
2700                 assert_eq!(node_txn[3].input.len(), 1);
2701                 assert_eq!(node_txn[4].input.len(), 1);
2702
2703                 check_spends!(node_txn[2], revoked_local_txn[0]);
2704                 check_spends!(node_txn[3], revoked_local_txn[0]);
2705                 check_spends!(node_txn[4], revoked_local_txn[0]);
2706
2707                 let mut witness_lens = BTreeSet::new();
2708                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2709                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2710                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2711                 assert_eq!(witness_lens.len(), 3);
2712                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2713                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2714                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2715         }
2716         get_announce_close_broadcast_events(&nodes, 0, 1);
2717         assert_eq!(nodes[0].node.list_channels().len(), 0);
2718         assert_eq!(nodes[1].node.list_channels().len(), 0);
2719 }
2720
2721 #[test]
2722 fn test_htlc_on_chain_success() {
2723         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2724         // the preimage backward accordingly. So here we test that ChannelManager is
2725         // broadcasting the right event to other nodes in payment path.
2726         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2727         // A --------------------> B ----------------------> C (preimage)
2728         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2729         // commitment transaction was broadcast.
2730         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2731         // towards B.
2732         // B should be able to claim via preimage if A then broadcasts its local tx.
2733         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2734         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2735         // PaymentSent event).
2736
2737         let chanmon_cfgs = create_chanmon_cfgs(3);
2738         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2739         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2740         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2741
2742         // Create some initial channels
2743         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2744         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2745
2746         // Ensure all nodes are at the same height
2747         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2748         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2749         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2750         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2751
2752         // Rebalance the network a bit by relaying one payment through all the channels...
2753         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2754         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2755
2756         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2757         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2758
2759         // Broadcast legit commitment tx from C on B's chain
2760         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2761         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2762         assert_eq!(commitment_tx.len(), 1);
2763         check_spends!(commitment_tx[0], chan_2.3);
2764         nodes[2].node.claim_funds(our_payment_preimage);
2765         nodes[2].node.claim_funds(our_payment_preimage_2);
2766         check_added_monitors!(nodes[2], 2);
2767         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2768         assert!(updates.update_add_htlcs.is_empty());
2769         assert!(updates.update_fail_htlcs.is_empty());
2770         assert!(updates.update_fail_malformed_htlcs.is_empty());
2771         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2772
2773         mine_transaction(&nodes[2], &commitment_tx[0]);
2774         check_closed_broadcast!(nodes[2], true);
2775         check_added_monitors!(nodes[2], 1);
2776         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)
2777         assert_eq!(node_txn.len(), 5);
2778         assert_eq!(node_txn[0], node_txn[3]);
2779         assert_eq!(node_txn[1], node_txn[4]);
2780         assert_eq!(node_txn[2], commitment_tx[0]);
2781         check_spends!(node_txn[0], commitment_tx[0]);
2782         check_spends!(node_txn[1], commitment_tx[0]);
2783         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2784         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2785         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2786         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2787         assert_eq!(node_txn[0].lock_time, 0);
2788         assert_eq!(node_txn[1].lock_time, 0);
2789
2790         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2791         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2792         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2793         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2794         {
2795                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2796                 assert_eq!(added_monitors.len(), 1);
2797                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2798                 added_monitors.clear();
2799         }
2800         let events = nodes[1].node.get_and_clear_pending_msg_events();
2801         {
2802                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2803                 assert_eq!(added_monitors.len(), 2);
2804                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2805                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2806                 added_monitors.clear();
2807         }
2808         assert_eq!(events.len(), 3);
2809         match events[0] {
2810                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2811                 _ => panic!("Unexpected event"),
2812         }
2813         match events[1] {
2814                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2815                 _ => panic!("Unexpected event"),
2816         }
2817
2818         match events[2] {
2819                 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, .. } } => {
2820                         assert!(update_add_htlcs.is_empty());
2821                         assert!(update_fail_htlcs.is_empty());
2822                         assert_eq!(update_fulfill_htlcs.len(), 1);
2823                         assert!(update_fail_malformed_htlcs.is_empty());
2824                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2825                 },
2826                 _ => panic!("Unexpected event"),
2827         };
2828         macro_rules! check_tx_local_broadcast {
2829                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2830                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2831                         assert_eq!(node_txn.len(), 3);
2832                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2833                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2834                         check_spends!(node_txn[1], $commitment_tx);
2835                         check_spends!(node_txn[2], $commitment_tx);
2836                         assert_ne!(node_txn[1].lock_time, 0);
2837                         assert_ne!(node_txn[2].lock_time, 0);
2838                         if $htlc_offered {
2839                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2840                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2841                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2842                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2843                         } else {
2844                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2845                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2846                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2847                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2848                         }
2849                         check_spends!(node_txn[0], $chan_tx);
2850                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2851                         node_txn.clear();
2852                 } }
2853         }
2854         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2855         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2856         // timeout-claim of the output that nodes[2] just claimed via success.
2857         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2858
2859         // Broadcast legit commitment tx from A on B's chain
2860         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2861         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2862         check_spends!(node_a_commitment_tx[0], chan_1.3);
2863         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2864         check_closed_broadcast!(nodes[1], true);
2865         check_added_monitors!(nodes[1], 1);
2866         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2867         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2868         let commitment_spend =
2869                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2870                         check_spends!(node_txn[1], commitment_tx[0]);
2871                         check_spends!(node_txn[2], commitment_tx[0]);
2872                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2873                         &node_txn[0]
2874                 } else {
2875                         check_spends!(node_txn[0], commitment_tx[0]);
2876                         check_spends!(node_txn[1], commitment_tx[0]);
2877                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2878                         &node_txn[2]
2879                 };
2880
2881         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2882         assert_eq!(commitment_spend.input.len(), 2);
2883         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2884         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2885         assert_eq!(commitment_spend.lock_time, 0);
2886         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2887         check_spends!(node_txn[3], chan_1.3);
2888         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2889         check_spends!(node_txn[4], node_txn[3]);
2890         check_spends!(node_txn[5], node_txn[3]);
2891         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2892         // we already checked the same situation with A.
2893
2894         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2895         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2896         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2897         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2898         check_closed_broadcast!(nodes[0], true);
2899         check_added_monitors!(nodes[0], 1);
2900         let events = nodes[0].node.get_and_clear_pending_events();
2901         assert_eq!(events.len(), 2);
2902         let mut first_claimed = false;
2903         for event in events {
2904                 match event {
2905                         Event::PaymentSent { payment_preimage } => {
2906                                 if payment_preimage == our_payment_preimage {
2907                                         assert!(!first_claimed);
2908                                         first_claimed = true;
2909                                 } else {
2910                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2911                                 }
2912                         },
2913                         _ => panic!("Unexpected event"),
2914                 }
2915         }
2916         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2917 }
2918
2919 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2920         // Test that in case of a unilateral close onchain, we detect the state of output and
2921         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2922         // broadcasting the right event to other nodes in payment path.
2923         // A ------------------> B ----------------------> C (timeout)
2924         //    B's commitment tx                 C's commitment tx
2925         //            \                                  \
2926         //         B's HTLC timeout tx               B's timeout tx
2927
2928         let chanmon_cfgs = create_chanmon_cfgs(3);
2929         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2930         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2931         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2932         *nodes[0].connect_style.borrow_mut() = connect_style;
2933         *nodes[1].connect_style.borrow_mut() = connect_style;
2934         *nodes[2].connect_style.borrow_mut() = connect_style;
2935
2936         // Create some intial channels
2937         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2938         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2939
2940         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2941         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2942         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2943
2944         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2945
2946         // Broadcast legit commitment tx from C on B's chain
2947         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2948         check_spends!(commitment_tx[0], chan_2.3);
2949         nodes[2].node.fail_htlc_backwards(&payment_hash);
2950         check_added_monitors!(nodes[2], 0);
2951         expect_pending_htlcs_forwardable!(nodes[2]);
2952         check_added_monitors!(nodes[2], 1);
2953
2954         let events = nodes[2].node.get_and_clear_pending_msg_events();
2955         assert_eq!(events.len(), 1);
2956         match events[0] {
2957                 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, .. } } => {
2958                         assert!(update_add_htlcs.is_empty());
2959                         assert!(!update_fail_htlcs.is_empty());
2960                         assert!(update_fulfill_htlcs.is_empty());
2961                         assert!(update_fail_malformed_htlcs.is_empty());
2962                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2963                 },
2964                 _ => panic!("Unexpected event"),
2965         };
2966         mine_transaction(&nodes[2], &commitment_tx[0]);
2967         check_closed_broadcast!(nodes[2], true);
2968         check_added_monitors!(nodes[2], 1);
2969         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2970         assert_eq!(node_txn.len(), 1);
2971         check_spends!(node_txn[0], chan_2.3);
2972         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2973
2974         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2975         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2976         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2977         mine_transaction(&nodes[1], &commitment_tx[0]);
2978         let timeout_tx;
2979         {
2980                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2981                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2982                 assert_eq!(node_txn[0], node_txn[3]);
2983                 assert_eq!(node_txn[1], node_txn[4]);
2984
2985                 check_spends!(node_txn[2], commitment_tx[0]);
2986                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2987
2988                 check_spends!(node_txn[0], chan_2.3);
2989                 check_spends!(node_txn[1], node_txn[0]);
2990                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2991                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2992
2993                 timeout_tx = node_txn[2].clone();
2994                 node_txn.clear();
2995         }
2996
2997         mine_transaction(&nodes[1], &timeout_tx);
2998         check_added_monitors!(nodes[1], 1);
2999         check_closed_broadcast!(nodes[1], true);
3000         {
3001                 // B will rebroadcast a fee-bumped timeout transaction here.
3002                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3003                 assert_eq!(node_txn.len(), 1);
3004                 check_spends!(node_txn[0], commitment_tx[0]);
3005         }
3006
3007         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3008         {
3009                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
3010                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
3011                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
3012                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
3013                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3014                 if node_txn.len() == 1 {
3015                         check_spends!(node_txn[0], chan_2.3);
3016                 } else {
3017                         assert_eq!(node_txn.len(), 0);
3018                 }
3019         }
3020
3021         expect_pending_htlcs_forwardable!(nodes[1]);
3022         check_added_monitors!(nodes[1], 1);
3023         let events = nodes[1].node.get_and_clear_pending_msg_events();
3024         assert_eq!(events.len(), 1);
3025         match events[0] {
3026                 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, .. } } => {
3027                         assert!(update_add_htlcs.is_empty());
3028                         assert!(!update_fail_htlcs.is_empty());
3029                         assert!(update_fulfill_htlcs.is_empty());
3030                         assert!(update_fail_malformed_htlcs.is_empty());
3031                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3032                 },
3033                 _ => panic!("Unexpected event"),
3034         };
3035
3036         // Broadcast legit commitment tx from B on A's chain
3037         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3038         check_spends!(commitment_tx[0], chan_1.3);
3039
3040         mine_transaction(&nodes[0], &commitment_tx[0]);
3041         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
3042
3043         check_closed_broadcast!(nodes[0], true);
3044         check_added_monitors!(nodes[0], 1);
3045         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
3046         assert_eq!(node_txn.len(), 2);
3047         check_spends!(node_txn[0], chan_1.3);
3048         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3049         check_spends!(node_txn[1], commitment_tx[0]);
3050         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3051 }
3052
3053 #[test]
3054 fn test_htlc_on_chain_timeout() {
3055         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3056         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3057         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3058 }
3059
3060 #[test]
3061 fn test_simple_commitment_revoked_fail_backward() {
3062         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3063         // and fail backward accordingly.
3064
3065         let chanmon_cfgs = create_chanmon_cfgs(3);
3066         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3067         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3068         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3069
3070         // Create some initial channels
3071         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3072         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3073
3074         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3075         // Get the will-be-revoked local txn from nodes[2]
3076         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3077         // Revoke the old state
3078         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3079
3080         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3081
3082         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3083         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3084         check_added_monitors!(nodes[1], 1);
3085         check_closed_broadcast!(nodes[1], true);
3086
3087         expect_pending_htlcs_forwardable!(nodes[1]);
3088         check_added_monitors!(nodes[1], 1);
3089         let events = nodes[1].node.get_and_clear_pending_msg_events();
3090         assert_eq!(events.len(), 1);
3091         match events[0] {
3092                 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, .. } } => {
3093                         assert!(update_add_htlcs.is_empty());
3094                         assert_eq!(update_fail_htlcs.len(), 1);
3095                         assert!(update_fulfill_htlcs.is_empty());
3096                         assert!(update_fail_malformed_htlcs.is_empty());
3097                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3098
3099                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3100                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3101                         expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
3102                         expect_payment_failed!(nodes[0], payment_hash, false);
3103                 },
3104                 _ => panic!("Unexpected event"),
3105         }
3106 }
3107
3108 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3109         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3110         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3111         // commitment transaction anymore.
3112         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3113         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3114         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3115         // technically disallowed and we should probably handle it reasonably.
3116         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3117         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3118         // transactions:
3119         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3120         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3121         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3122         //   and once they revoke the previous commitment transaction (allowing us to send a new
3123         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3124         let chanmon_cfgs = create_chanmon_cfgs(3);
3125         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3126         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3127         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3128
3129         // Create some initial channels
3130         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3131         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3132
3133         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 });
3134         // Get the will-be-revoked local txn from nodes[2]
3135         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3136         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3137         // Revoke the old state
3138         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3139
3140         let value = if use_dust {
3141                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3142                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3143                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3144         } else { 3000000 };
3145
3146         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3147         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3148         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3149
3150         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3151         expect_pending_htlcs_forwardable!(nodes[2]);
3152         check_added_monitors!(nodes[2], 1);
3153         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3154         assert!(updates.update_add_htlcs.is_empty());
3155         assert!(updates.update_fulfill_htlcs.is_empty());
3156         assert!(updates.update_fail_malformed_htlcs.is_empty());
3157         assert_eq!(updates.update_fail_htlcs.len(), 1);
3158         assert!(updates.update_fee.is_none());
3159         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3160         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3161         // Drop the last RAA from 3 -> 2
3162
3163         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3164         expect_pending_htlcs_forwardable!(nodes[2]);
3165         check_added_monitors!(nodes[2], 1);
3166         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3167         assert!(updates.update_add_htlcs.is_empty());
3168         assert!(updates.update_fulfill_htlcs.is_empty());
3169         assert!(updates.update_fail_malformed_htlcs.is_empty());
3170         assert_eq!(updates.update_fail_htlcs.len(), 1);
3171         assert!(updates.update_fee.is_none());
3172         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3173         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3174         check_added_monitors!(nodes[1], 1);
3175         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3176         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3177         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3178         check_added_monitors!(nodes[2], 1);
3179
3180         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3181         expect_pending_htlcs_forwardable!(nodes[2]);
3182         check_added_monitors!(nodes[2], 1);
3183         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3184         assert!(updates.update_add_htlcs.is_empty());
3185         assert!(updates.update_fulfill_htlcs.is_empty());
3186         assert!(updates.update_fail_malformed_htlcs.is_empty());
3187         assert_eq!(updates.update_fail_htlcs.len(), 1);
3188         assert!(updates.update_fee.is_none());
3189         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3190         // At this point first_payment_hash has dropped out of the latest two commitment
3191         // transactions that nodes[1] is tracking...
3192         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3193         check_added_monitors!(nodes[1], 1);
3194         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3195         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3196         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3197         check_added_monitors!(nodes[2], 1);
3198
3199         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3200         // on nodes[2]'s RAA.
3201         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3202         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3203         let logger = test_utils::TestLogger::new();
3204         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();
3205         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3206         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3207         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3208         check_added_monitors!(nodes[1], 0);
3209
3210         if deliver_bs_raa {
3211                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3212                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3213                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3214                 check_added_monitors!(nodes[1], 1);
3215                 let events = nodes[1].node.get_and_clear_pending_events();
3216                 assert_eq!(events.len(), 1);
3217                 match events[0] {
3218                         Event::PendingHTLCsForwardable { .. } => { },
3219                         _ => panic!("Unexpected event"),
3220                 };
3221                 // Deliberately don't process the pending fail-back so they all fail back at once after
3222                 // block connection just like the !deliver_bs_raa case
3223         }
3224
3225         let mut failed_htlcs = HashSet::new();
3226         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3227
3228         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3229         check_added_monitors!(nodes[1], 1);
3230         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3231
3232         let events = nodes[1].node.get_and_clear_pending_events();
3233         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3234         match events[0] {
3235                 Event::PaymentFailed { ref payment_hash, .. } => {
3236                         assert_eq!(*payment_hash, fourth_payment_hash);
3237                 },
3238                 _ => panic!("Unexpected event"),
3239         }
3240         if !deliver_bs_raa {
3241                 match events[1] {
3242                         Event::PendingHTLCsForwardable { .. } => { },
3243                         _ => panic!("Unexpected event"),
3244                 };
3245         }
3246         nodes[1].node.process_pending_htlc_forwards();
3247         check_added_monitors!(nodes[1], 1);
3248
3249         let events = nodes[1].node.get_and_clear_pending_msg_events();
3250         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3251         match events[if deliver_bs_raa { 1 } else { 0 }] {
3252                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3253                 _ => panic!("Unexpected event"),
3254         }
3255         match events[if deliver_bs_raa { 2 } else { 1 }] {
3256                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3257                         assert_eq!(channel_id, chan_2.2);
3258                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3259                 },
3260                 _ => panic!("Unexpected event"),
3261         }
3262         if deliver_bs_raa {
3263                 match events[0] {
3264                         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, .. } } => {
3265                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3266                                 assert_eq!(update_add_htlcs.len(), 1);
3267                                 assert!(update_fulfill_htlcs.is_empty());
3268                                 assert!(update_fail_htlcs.is_empty());
3269                                 assert!(update_fail_malformed_htlcs.is_empty());
3270                         },
3271                         _ => panic!("Unexpected event"),
3272                 }
3273         }
3274         match events[if deliver_bs_raa { 3 } else { 2 }] {
3275                 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, .. } } => {
3276                         assert!(update_add_htlcs.is_empty());
3277                         assert_eq!(update_fail_htlcs.len(), 3);
3278                         assert!(update_fulfill_htlcs.is_empty());
3279                         assert!(update_fail_malformed_htlcs.is_empty());
3280                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3281
3282                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3283                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3284                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3285
3286                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3287
3288                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3289                         // If we delivered B's RAA we got an unknown preimage error, not something
3290                         // that we should update our routing table for.
3291                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3292                         for event in events {
3293                                 match event {
3294                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3295                                         _ => panic!("Unexpected event"),
3296                                 }
3297                         }
3298                         let events = nodes[0].node.get_and_clear_pending_events();
3299                         assert_eq!(events.len(), 3);
3300                         match events[0] {
3301                                 Event::PaymentFailed { ref payment_hash, .. } => {
3302                                         assert!(failed_htlcs.insert(payment_hash.0));
3303                                 },
3304                                 _ => panic!("Unexpected event"),
3305                         }
3306                         match events[1] {
3307                                 Event::PaymentFailed { ref payment_hash, .. } => {
3308                                         assert!(failed_htlcs.insert(payment_hash.0));
3309                                 },
3310                                 _ => panic!("Unexpected event"),
3311                         }
3312                         match events[2] {
3313                                 Event::PaymentFailed { ref payment_hash, .. } => {
3314                                         assert!(failed_htlcs.insert(payment_hash.0));
3315                                 },
3316                                 _ => panic!("Unexpected event"),
3317                         }
3318                 },
3319                 _ => panic!("Unexpected event"),
3320         }
3321
3322         assert!(failed_htlcs.contains(&first_payment_hash.0));
3323         assert!(failed_htlcs.contains(&second_payment_hash.0));
3324         assert!(failed_htlcs.contains(&third_payment_hash.0));
3325 }
3326
3327 #[test]
3328 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3329         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3330         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3331         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3332         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3333 }
3334
3335 #[test]
3336 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3337         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3338         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3339         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3340         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3341 }
3342
3343 #[test]
3344 fn fail_backward_pending_htlc_upon_channel_failure() {
3345         let chanmon_cfgs = create_chanmon_cfgs(2);
3346         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3347         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3348         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3349         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3350         let logger = test_utils::TestLogger::new();
3351
3352         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3353         {
3354                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3355                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3356                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3357                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3358                 check_added_monitors!(nodes[0], 1);
3359
3360                 let payment_event = {
3361                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3362                         assert_eq!(events.len(), 1);
3363                         SendEvent::from_event(events.remove(0))
3364                 };
3365                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3366                 assert_eq!(payment_event.msgs.len(), 1);
3367         }
3368
3369         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3370         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3371         {
3372                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3373                 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();
3374                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3375                 check_added_monitors!(nodes[0], 0);
3376
3377                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3378         }
3379
3380         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3381         {
3382                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3383
3384                 let secp_ctx = Secp256k1::new();
3385                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3386                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3387                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3388                 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();
3389                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3390                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3391                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3392
3393                 // Send a 0-msat update_add_htlc to fail the channel.
3394                 let update_add_htlc = msgs::UpdateAddHTLC {
3395                         channel_id: chan.2,
3396                         htlc_id: 0,
3397                         amount_msat: 0,
3398                         payment_hash,
3399                         cltv_expiry,
3400                         onion_routing_packet,
3401                 };
3402                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3403         }
3404
3405         // Check that Alice fails backward the pending HTLC from the second payment.
3406         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3407         check_closed_broadcast!(nodes[0], true);
3408         check_added_monitors!(nodes[0], 1);
3409 }
3410
3411 #[test]
3412 fn test_htlc_ignore_latest_remote_commitment() {
3413         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3414         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3415         let chanmon_cfgs = create_chanmon_cfgs(2);
3416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3419         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3420
3421         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3422         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3423         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3424         check_closed_broadcast!(nodes[0], true);
3425         check_added_monitors!(nodes[0], 1);
3426
3427         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3428         assert_eq!(node_txn.len(), 3);
3429         assert_eq!(node_txn[0], node_txn[1]);
3430
3431         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3432         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3433         check_closed_broadcast!(nodes[1], true);
3434         check_added_monitors!(nodes[1], 1);
3435
3436         // Duplicate the connect_block call since this may happen due to other listeners
3437         // registering new transactions
3438         header.prev_blockhash = header.block_hash();
3439         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3440 }
3441
3442 #[test]
3443 fn test_force_close_fail_back() {
3444         // Check which HTLCs are failed-backwards on channel force-closure
3445         let chanmon_cfgs = create_chanmon_cfgs(3);
3446         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3447         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3448         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3449         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3450         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3451         let logger = test_utils::TestLogger::new();
3452
3453         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3454
3455         let mut payment_event = {
3456                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3457                 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();
3458                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3459                 check_added_monitors!(nodes[0], 1);
3460
3461                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3462                 assert_eq!(events.len(), 1);
3463                 SendEvent::from_event(events.remove(0))
3464         };
3465
3466         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3467         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3468
3469         expect_pending_htlcs_forwardable!(nodes[1]);
3470
3471         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3472         assert_eq!(events_2.len(), 1);
3473         payment_event = SendEvent::from_event(events_2.remove(0));
3474         assert_eq!(payment_event.msgs.len(), 1);
3475
3476         check_added_monitors!(nodes[1], 1);
3477         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3478         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3479         check_added_monitors!(nodes[2], 1);
3480         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3481
3482         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3483         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3484         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3485
3486         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3487         check_closed_broadcast!(nodes[2], true);
3488         check_added_monitors!(nodes[2], 1);
3489         let tx = {
3490                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3491                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3492                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3493                 // back to nodes[1] upon timeout otherwise.
3494                 assert_eq!(node_txn.len(), 1);
3495                 node_txn.remove(0)
3496         };
3497
3498         mine_transaction(&nodes[1], &tx);
3499
3500         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3501         check_closed_broadcast!(nodes[1], true);
3502         check_added_monitors!(nodes[1], 1);
3503
3504         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3505         {
3506                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3507                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3508                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3509         }
3510         mine_transaction(&nodes[2], &tx);
3511         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3512         assert_eq!(node_txn.len(), 1);
3513         assert_eq!(node_txn[0].input.len(), 1);
3514         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3515         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3516         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3517
3518         check_spends!(node_txn[0], tx);
3519 }
3520
3521 #[test]
3522 fn test_dup_events_on_peer_disconnect() {
3523         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3524         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3525         // as we used to generate the event immediately upon receipt of the payment preimage in the
3526         // update_fulfill_htlc message.
3527
3528         let chanmon_cfgs = create_chanmon_cfgs(2);
3529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3531         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3532         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3533
3534         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3535
3536         assert!(nodes[1].node.claim_funds(payment_preimage));
3537         check_added_monitors!(nodes[1], 1);
3538         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3539         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3540         expect_payment_sent!(nodes[0], payment_preimage);
3541
3542         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3543         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3544
3545         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3546         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3547 }
3548
3549 #[test]
3550 fn test_simple_peer_disconnect() {
3551         // Test that we can reconnect when there are no lost messages
3552         let chanmon_cfgs = create_chanmon_cfgs(3);
3553         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3554         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3555         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3556         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3557         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3558
3559         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3560         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3561         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3562
3563         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3564         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3565         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3566         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3567
3568         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3569         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3570         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3571
3572         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3573         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3574         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3575         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3576
3577         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3578         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3579
3580         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3581         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3582
3583         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3584         {
3585                 let events = nodes[0].node.get_and_clear_pending_events();
3586                 assert_eq!(events.len(), 2);
3587                 match events[0] {
3588                         Event::PaymentSent { payment_preimage } => {
3589                                 assert_eq!(payment_preimage, payment_preimage_3);
3590                         },
3591                         _ => panic!("Unexpected event"),
3592                 }
3593                 match events[1] {
3594                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3595                                 assert_eq!(payment_hash, payment_hash_5);
3596                                 assert!(rejected_by_dest);
3597                         },
3598                         _ => panic!("Unexpected event"),
3599                 }
3600         }
3601
3602         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3603         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3604 }
3605
3606 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3607         // Test that we can reconnect when in-flight HTLC updates get dropped
3608         let chanmon_cfgs = create_chanmon_cfgs(2);
3609         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3610         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3611         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3612
3613         let mut as_funding_locked = None;
3614         if messages_delivered == 0 {
3615                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3616                 as_funding_locked = Some(funding_locked);
3617                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3618                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3619                 // it before the channel_reestablish message.
3620         } else {
3621                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3622         }
3623
3624         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3625
3626         let logger = test_utils::TestLogger::new();
3627         let payment_event = {
3628                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3629                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3630                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3631                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3632                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3633                 check_added_monitors!(nodes[0], 1);
3634
3635                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3636                 assert_eq!(events.len(), 1);
3637                 SendEvent::from_event(events.remove(0))
3638         };
3639         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3640
3641         if messages_delivered < 2 {
3642                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3643         } else {
3644                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3645                 if messages_delivered >= 3 {
3646                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3647                         check_added_monitors!(nodes[1], 1);
3648                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3649
3650                         if messages_delivered >= 4 {
3651                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3652                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3653                                 check_added_monitors!(nodes[0], 1);
3654
3655                                 if messages_delivered >= 5 {
3656                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3657                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3658                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3659                                         check_added_monitors!(nodes[0], 1);
3660
3661                                         if messages_delivered >= 6 {
3662                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3663                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3664                                                 check_added_monitors!(nodes[1], 1);
3665                                         }
3666                                 }
3667                         }
3668                 }
3669         }
3670
3671         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3672         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3673         if messages_delivered < 3 {
3674                 if simulate_broken_lnd {
3675                         // lnd has a long-standing bug where they send a funding_locked prior to a
3676                         // channel_reestablish if you reconnect prior to funding_locked time.
3677                         //
3678                         // Here we simulate that behavior, delivering a funding_locked immediately on
3679                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3680                         // in `reconnect_nodes` but we currently don't fail based on that.
3681                         //
3682                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3683                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3684                 }
3685                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3686                 // received on either side, both sides will need to resend them.
3687                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3688         } else if messages_delivered == 3 {
3689                 // nodes[0] still wants its RAA + commitment_signed
3690                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3691         } else if messages_delivered == 4 {
3692                 // nodes[0] still wants its commitment_signed
3693                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3694         } else if messages_delivered == 5 {
3695                 // nodes[1] still wants its final RAA
3696                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3697         } else if messages_delivered == 6 {
3698                 // Everything was delivered...
3699                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3700         }
3701
3702         let events_1 = nodes[1].node.get_and_clear_pending_events();
3703         assert_eq!(events_1.len(), 1);
3704         match events_1[0] {
3705                 Event::PendingHTLCsForwardable { .. } => { },
3706                 _ => panic!("Unexpected event"),
3707         };
3708
3709         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3710         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3711         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3712
3713         nodes[1].node.process_pending_htlc_forwards();
3714
3715         let events_2 = nodes[1].node.get_and_clear_pending_events();
3716         assert_eq!(events_2.len(), 1);
3717         match events_2[0] {
3718                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3719                         assert_eq!(payment_hash_1, *payment_hash);
3720                         assert!(payment_preimage.is_none());
3721                         assert_eq!(payment_secret_1, *payment_secret);
3722                         assert_eq!(amt, 1000000);
3723                 },
3724                 _ => panic!("Unexpected event"),
3725         }
3726
3727         nodes[1].node.claim_funds(payment_preimage_1);
3728         check_added_monitors!(nodes[1], 1);
3729
3730         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3731         assert_eq!(events_3.len(), 1);
3732         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3733                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3734                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3735                         assert!(updates.update_add_htlcs.is_empty());
3736                         assert!(updates.update_fail_htlcs.is_empty());
3737                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3738                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3739                         assert!(updates.update_fee.is_none());
3740                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3741                 },
3742                 _ => panic!("Unexpected event"),
3743         };
3744
3745         if messages_delivered >= 1 {
3746                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3747
3748                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3749                 assert_eq!(events_4.len(), 1);
3750                 match events_4[0] {
3751                         Event::PaymentSent { ref payment_preimage } => {
3752                                 assert_eq!(payment_preimage_1, *payment_preimage);
3753                         },
3754                         _ => panic!("Unexpected event"),
3755                 }
3756
3757                 if messages_delivered >= 2 {
3758                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3759                         check_added_monitors!(nodes[0], 1);
3760                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3761
3762                         if messages_delivered >= 3 {
3763                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3764                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3765                                 check_added_monitors!(nodes[1], 1);
3766
3767                                 if messages_delivered >= 4 {
3768                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3769                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3770                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3771                                         check_added_monitors!(nodes[1], 1);
3772
3773                                         if messages_delivered >= 5 {
3774                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3775                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3776                                                 check_added_monitors!(nodes[0], 1);
3777                                         }
3778                                 }
3779                         }
3780                 }
3781         }
3782
3783         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3784         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3785         if messages_delivered < 2 {
3786                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3787                 if messages_delivered < 1 {
3788                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3789                         assert_eq!(events_4.len(), 1);
3790                         match events_4[0] {
3791                                 Event::PaymentSent { ref payment_preimage } => {
3792                                         assert_eq!(payment_preimage_1, *payment_preimage);
3793                                 },
3794                                 _ => panic!("Unexpected event"),
3795                         }
3796                 } else {
3797                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3798                 }
3799         } else if messages_delivered == 2 {
3800                 // nodes[0] still wants its RAA + commitment_signed
3801                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3802         } else if messages_delivered == 3 {
3803                 // nodes[0] still wants its commitment_signed
3804                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3805         } else if messages_delivered == 4 {
3806                 // nodes[1] still wants its final RAA
3807                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3808         } else if messages_delivered == 5 {
3809                 // Everything was delivered...
3810                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3811         }
3812
3813         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3814         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3815         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3816
3817         // Channel should still work fine...
3818         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3819         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3820                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3821                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3822         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3823         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3824 }
3825
3826 #[test]
3827 fn test_drop_messages_peer_disconnect_a() {
3828         do_test_drop_messages_peer_disconnect(0, true);
3829         do_test_drop_messages_peer_disconnect(0, false);
3830         do_test_drop_messages_peer_disconnect(1, false);
3831         do_test_drop_messages_peer_disconnect(2, false);
3832 }
3833
3834 #[test]
3835 fn test_drop_messages_peer_disconnect_b() {
3836         do_test_drop_messages_peer_disconnect(3, false);
3837         do_test_drop_messages_peer_disconnect(4, false);
3838         do_test_drop_messages_peer_disconnect(5, false);
3839         do_test_drop_messages_peer_disconnect(6, false);
3840 }
3841
3842 #[test]
3843 fn test_funding_peer_disconnect() {
3844         // Test that we can lock in our funding tx while disconnected
3845         let chanmon_cfgs = create_chanmon_cfgs(2);
3846         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3847         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3848         let persister: test_utils::TestPersister;
3849         let new_chain_monitor: test_utils::TestChainMonitor;
3850         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3851         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3852         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3853
3854         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3855         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3856
3857         confirm_transaction(&nodes[0], &tx);
3858         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3859         assert_eq!(events_1.len(), 1);
3860         match events_1[0] {
3861                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3862                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3863                 },
3864                 _ => panic!("Unexpected event"),
3865         }
3866
3867         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3868
3869         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3870         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3871
3872         confirm_transaction(&nodes[1], &tx);
3873         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3874         assert_eq!(events_2.len(), 2);
3875         let funding_locked = match events_2[0] {
3876                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3877                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3878                         msg.clone()
3879                 },
3880                 _ => panic!("Unexpected event"),
3881         };
3882         let bs_announcement_sigs = match events_2[1] {
3883                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3884                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3885                         msg.clone()
3886                 },
3887                 _ => panic!("Unexpected event"),
3888         };
3889
3890         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3891
3892         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3893         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3894         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3895         assert_eq!(events_3.len(), 2);
3896         let as_announcement_sigs = match events_3[0] {
3897                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3898                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3899                         msg.clone()
3900                 },
3901                 _ => panic!("Unexpected event"),
3902         };
3903         let (as_announcement, as_update) = match events_3[1] {
3904                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3905                         (msg.clone(), update_msg.clone())
3906                 },
3907                 _ => panic!("Unexpected event"),
3908         };
3909
3910         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3911         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3912         assert_eq!(events_4.len(), 1);
3913         let (_, bs_update) = match events_4[0] {
3914                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3915                         (msg.clone(), update_msg.clone())
3916                 },
3917                 _ => panic!("Unexpected event"),
3918         };
3919
3920         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3921         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3922         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3923
3924         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3925         let logger = test_utils::TestLogger::new();
3926         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();
3927         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3928         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3929
3930         // Check that after deserialization and reconnection we can still generate an identical
3931         // channel_announcement from the cached signatures.
3932         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3933
3934         let nodes_0_serialized = nodes[0].node.encode();
3935         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3936         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3937
3938         persister = test_utils::TestPersister::new();
3939         let keys_manager = &chanmon_cfgs[0].keys_manager;
3940         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);
3941         nodes[0].chain_monitor = &new_chain_monitor;
3942         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3943         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3944                 &mut chan_0_monitor_read, keys_manager).unwrap();
3945         assert!(chan_0_monitor_read.is_empty());
3946
3947         let mut nodes_0_read = &nodes_0_serialized[..];
3948         let (_, nodes_0_deserialized_tmp) = {
3949                 let mut channel_monitors = HashMap::new();
3950                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3951                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3952                         default_config: UserConfig::default(),
3953                         keys_manager,
3954                         fee_estimator: node_cfgs[0].fee_estimator,
3955                         chain_monitor: nodes[0].chain_monitor,
3956                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3957                         logger: nodes[0].logger,
3958                         channel_monitors,
3959                 }).unwrap()
3960         };
3961         nodes_0_deserialized = nodes_0_deserialized_tmp;
3962         assert!(nodes_0_read.is_empty());
3963
3964         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3965         nodes[0].node = &nodes_0_deserialized;
3966         check_added_monitors!(nodes[0], 1);
3967
3968         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3969
3970         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3971         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3972         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3973         let mut found_announcement = false;
3974         for event in msgs.iter() {
3975                 match event {
3976                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3977                                 if *msg == as_announcement { found_announcement = true; }
3978                         },
3979                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3980                         _ => panic!("Unexpected event"),
3981                 }
3982         }
3983         assert!(found_announcement);
3984 }
3985
3986 #[test]
3987 fn test_drop_messages_peer_disconnect_dual_htlc() {
3988         // Test that we can handle reconnecting when both sides of a channel have pending
3989         // commitment_updates when we disconnect.
3990         let chanmon_cfgs = create_chanmon_cfgs(2);
3991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3993         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3994         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3995         let logger = test_utils::TestLogger::new();
3996
3997         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3998
3999         // Now try to send a second payment which will fail to send
4000         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
4001         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4002         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();
4003         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
4004         check_added_monitors!(nodes[0], 1);
4005
4006         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
4007         assert_eq!(events_1.len(), 1);
4008         match events_1[0] {
4009                 MessageSendEvent::UpdateHTLCs { .. } => {},
4010                 _ => panic!("Unexpected event"),
4011         }
4012
4013         assert!(nodes[1].node.claim_funds(payment_preimage_1));
4014         check_added_monitors!(nodes[1], 1);
4015
4016         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
4017         assert_eq!(events_2.len(), 1);
4018         match events_2[0] {
4019                 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 } } => {
4020                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4021                         assert!(update_add_htlcs.is_empty());
4022                         assert_eq!(update_fulfill_htlcs.len(), 1);
4023                         assert!(update_fail_htlcs.is_empty());
4024                         assert!(update_fail_malformed_htlcs.is_empty());
4025                         assert!(update_fee.is_none());
4026
4027                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
4028                         let events_3 = nodes[0].node.get_and_clear_pending_events();
4029                         assert_eq!(events_3.len(), 1);
4030                         match events_3[0] {
4031                                 Event::PaymentSent { ref payment_preimage } => {
4032                                         assert_eq!(*payment_preimage, payment_preimage_1);
4033                                 },
4034                                 _ => panic!("Unexpected event"),
4035                         }
4036
4037                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
4038                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4039                         // No commitment_signed so get_event_msg's assert(len == 1) passes
4040                         check_added_monitors!(nodes[0], 1);
4041                 },
4042                 _ => panic!("Unexpected event"),
4043         }
4044
4045         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4046         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4047
4048         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4049         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4050         assert_eq!(reestablish_1.len(), 1);
4051         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4052         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4053         assert_eq!(reestablish_2.len(), 1);
4054
4055         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4056         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4057         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4058         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4059
4060         assert!(as_resp.0.is_none());
4061         assert!(bs_resp.0.is_none());
4062
4063         assert!(bs_resp.1.is_none());
4064         assert!(bs_resp.2.is_none());
4065
4066         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4067
4068         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4069         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4070         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4071         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4072         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4073         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4074         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4075         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4076         // No commitment_signed so get_event_msg's assert(len == 1) passes
4077         check_added_monitors!(nodes[1], 1);
4078
4079         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4080         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4081         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4082         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4083         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4084         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4085         assert!(bs_second_commitment_signed.update_fee.is_none());
4086         check_added_monitors!(nodes[1], 1);
4087
4088         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4089         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4090         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4091         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4092         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4093         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4094         assert!(as_commitment_signed.update_fee.is_none());
4095         check_added_monitors!(nodes[0], 1);
4096
4097         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4098         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4099         // No commitment_signed so get_event_msg's assert(len == 1) passes
4100         check_added_monitors!(nodes[0], 1);
4101
4102         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4103         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4104         // No commitment_signed so get_event_msg's assert(len == 1) passes
4105         check_added_monitors!(nodes[1], 1);
4106
4107         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4108         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4109         check_added_monitors!(nodes[1], 1);
4110
4111         expect_pending_htlcs_forwardable!(nodes[1]);
4112
4113         let events_5 = nodes[1].node.get_and_clear_pending_events();
4114         assert_eq!(events_5.len(), 1);
4115         match events_5[0] {
4116                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
4117                         assert_eq!(payment_hash_2, *payment_hash);
4118                         assert!(payment_preimage.is_none());
4119                         assert_eq!(payment_secret_2, *payment_secret);
4120                 },
4121                 _ => panic!("Unexpected event"),
4122         }
4123
4124         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4125         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4126         check_added_monitors!(nodes[0], 1);
4127
4128         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4129 }
4130
4131 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4132         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4133         // to avoid our counterparty failing the channel.
4134         let chanmon_cfgs = create_chanmon_cfgs(2);
4135         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4136         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4137         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4138
4139         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4140         let logger = test_utils::TestLogger::new();
4141
4142         let our_payment_hash = if send_partial_mpp {
4143                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4144                 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();
4145                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4146                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4147                 // indicates there are more HTLCs coming.
4148                 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.
4149                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4150                 check_added_monitors!(nodes[0], 1);
4151                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4152                 assert_eq!(events.len(), 1);
4153                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4154                 // hop should *not* yet generate any PaymentReceived event(s).
4155                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4156                 our_payment_hash
4157         } else {
4158                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4159         };
4160
4161         let mut block = Block {
4162                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4163                 txdata: vec![],
4164         };
4165         connect_block(&nodes[0], &block);
4166         connect_block(&nodes[1], &block);
4167         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4168         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4169                 block.header.prev_blockhash = block.block_hash();
4170                 connect_block(&nodes[0], &block);
4171                 connect_block(&nodes[1], &block);
4172         }
4173
4174         expect_pending_htlcs_forwardable!(nodes[1]);
4175
4176         check_added_monitors!(nodes[1], 1);
4177         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4178         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4179         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4180         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4181         assert!(htlc_timeout_updates.update_fee.is_none());
4182
4183         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4184         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4185         // 100_000 msat as u64, followed by the height at which we failed back above
4186         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4187         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4188         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4189 }
4190
4191 #[test]
4192 fn test_htlc_timeout() {
4193         do_test_htlc_timeout(true);
4194         do_test_htlc_timeout(false);
4195 }
4196
4197 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4198         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4199         let chanmon_cfgs = create_chanmon_cfgs(3);
4200         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4201         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4202         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4203         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4204         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4205
4206         // Make sure all nodes are at the same starting height
4207         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4208         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4209         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4210
4211         let logger = test_utils::TestLogger::new();
4212
4213         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4214         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4215         {
4216                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4217                 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();
4218                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4219         }
4220         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4221         check_added_monitors!(nodes[1], 1);
4222
4223         // Now attempt to route a second payment, which should be placed in the holding cell
4224         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4225         if forwarded_htlc {
4226                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4227                 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();
4228                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4229                 check_added_monitors!(nodes[0], 1);
4230                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4231                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4232                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4233                 expect_pending_htlcs_forwardable!(nodes[1]);
4234                 check_added_monitors!(nodes[1], 0);
4235         } else {
4236                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4237                 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();
4238                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4239                 check_added_monitors!(nodes[1], 0);
4240         }
4241
4242         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4243         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4244         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4245         connect_blocks(&nodes[1], 1);
4246
4247         if forwarded_htlc {
4248                 expect_pending_htlcs_forwardable!(nodes[1]);
4249                 check_added_monitors!(nodes[1], 1);
4250                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4251                 assert_eq!(fail_commit.len(), 1);
4252                 match fail_commit[0] {
4253                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4254                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4255                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4256                         },
4257                         _ => unreachable!(),
4258                 }
4259                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4260                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, false);
4261         } else {
4262                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4263         }
4264 }
4265
4266 #[test]
4267 fn test_holding_cell_htlc_add_timeouts() {
4268         do_test_holding_cell_htlc_add_timeouts(false);
4269         do_test_holding_cell_htlc_add_timeouts(true);
4270 }
4271
4272 #[test]
4273 fn test_invalid_channel_announcement() {
4274         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4275         let secp_ctx = Secp256k1::new();
4276         let chanmon_cfgs = create_chanmon_cfgs(2);
4277         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4279         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4280
4281         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4282
4283         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4284         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4285         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4286         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4287
4288         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 } );
4289
4290         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4291         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4292
4293         let as_network_key = nodes[0].node.get_our_node_id();
4294         let bs_network_key = nodes[1].node.get_our_node_id();
4295
4296         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4297
4298         let mut chan_announcement;
4299
4300         macro_rules! dummy_unsigned_msg {
4301                 () => {
4302                         msgs::UnsignedChannelAnnouncement {
4303                                 features: ChannelFeatures::known(),
4304                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4305                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4306                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4307                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4308                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4309                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4310                                 excess_data: Vec::new(),
4311                         };
4312                 }
4313         }
4314
4315         macro_rules! sign_msg {
4316                 ($unsigned_msg: expr) => {
4317                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4318                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4319                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4320                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4321                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4322                         chan_announcement = msgs::ChannelAnnouncement {
4323                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4324                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4325                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4326                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4327                                 contents: $unsigned_msg
4328                         }
4329                 }
4330         }
4331
4332         let unsigned_msg = dummy_unsigned_msg!();
4333         sign_msg!(unsigned_msg);
4334         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4335         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 } );
4336
4337         // Configured with Network::Testnet
4338         let mut unsigned_msg = dummy_unsigned_msg!();
4339         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4340         sign_msg!(unsigned_msg);
4341         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4342
4343         let mut unsigned_msg = dummy_unsigned_msg!();
4344         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4345         sign_msg!(unsigned_msg);
4346         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4347 }
4348
4349 #[test]
4350 fn test_no_txn_manager_serialize_deserialize() {
4351         let chanmon_cfgs = create_chanmon_cfgs(2);
4352         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4353         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4354         let logger: test_utils::TestLogger;
4355         let fee_estimator: test_utils::TestFeeEstimator;
4356         let persister: test_utils::TestPersister;
4357         let new_chain_monitor: test_utils::TestChainMonitor;
4358         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4359         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4360
4361         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4362
4363         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4364
4365         let nodes_0_serialized = nodes[0].node.encode();
4366         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4367         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4368
4369         logger = test_utils::TestLogger::new();
4370         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4371         persister = test_utils::TestPersister::new();
4372         let keys_manager = &chanmon_cfgs[0].keys_manager;
4373         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4374         nodes[0].chain_monitor = &new_chain_monitor;
4375         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4376         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4377                 &mut chan_0_monitor_read, keys_manager).unwrap();
4378         assert!(chan_0_monitor_read.is_empty());
4379
4380         let mut nodes_0_read = &nodes_0_serialized[..];
4381         let config = UserConfig::default();
4382         let (_, nodes_0_deserialized_tmp) = {
4383                 let mut channel_monitors = HashMap::new();
4384                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4385                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4386                         default_config: config,
4387                         keys_manager,
4388                         fee_estimator: &fee_estimator,
4389                         chain_monitor: nodes[0].chain_monitor,
4390                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4391                         logger: &logger,
4392                         channel_monitors,
4393                 }).unwrap()
4394         };
4395         nodes_0_deserialized = nodes_0_deserialized_tmp;
4396         assert!(nodes_0_read.is_empty());
4397
4398         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4399         nodes[0].node = &nodes_0_deserialized;
4400         assert_eq!(nodes[0].node.list_channels().len(), 1);
4401         check_added_monitors!(nodes[0], 1);
4402
4403         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4404         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4405         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4406         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4407
4408         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4409         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4410         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4411         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4412
4413         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4414         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4415         for node in nodes.iter() {
4416                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4417                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4418                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4419         }
4420
4421         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4422 }
4423
4424 #[test]
4425 fn test_dup_htlc_onchain_fails_on_reload() {
4426         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4427         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4428         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4429         // the ChannelMonitor tells it to.
4430         //
4431         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4432         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4433         // PaymentFailed event appearing). However, because we may not serialize the relevant
4434         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4435         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4436         // and de-duplicates ChannelMonitor events.
4437         //
4438         // This tests that explicit tracking behavior.
4439         let chanmon_cfgs = create_chanmon_cfgs(2);
4440         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4441         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4442         let persister: test_utils::TestPersister;
4443         let new_chain_monitor: test_utils::TestChainMonitor;
4444         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4445         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4446
4447         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4448
4449         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4450         // nodes[0].
4451         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4452         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4453         check_closed_broadcast!(nodes[0], true);
4454         check_added_monitors!(nodes[0], 1);
4455
4456         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4457         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4458
4459         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4460         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4461         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4462         assert_eq!(node_txn.len(), 3);
4463         assert_eq!(node_txn[0], node_txn[1]);
4464
4465         assert!(nodes[1].node.claim_funds(payment_preimage));
4466         check_added_monitors!(nodes[1], 1);
4467
4468         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4469         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4470         check_closed_broadcast!(nodes[1], true);
4471         check_added_monitors!(nodes[1], 1);
4472         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4473
4474         header.prev_blockhash = nodes[0].best_block_hash();
4475         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4476
4477         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4478         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4479         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4480         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4481         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4482
4483         header.prev_blockhash = nodes[0].best_block_hash();
4484         let claim_block = Block { header, txdata: claim_txn};
4485         connect_block(&nodes[0], &claim_block);
4486         expect_payment_sent!(nodes[0], payment_preimage);
4487
4488         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4489         // connected a highly-relevant block, it likely gets serialized out now.
4490         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4491         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4492
4493         // Now reload nodes[0]...
4494         persister = test_utils::TestPersister::new();
4495         let keys_manager = &chanmon_cfgs[0].keys_manager;
4496         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);
4497         nodes[0].chain_monitor = &new_chain_monitor;
4498         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4499         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4500                 &mut chan_0_monitor_read, keys_manager).unwrap();
4501         assert!(chan_0_monitor_read.is_empty());
4502
4503         let (_, nodes_0_deserialized_tmp) = {
4504                 let mut channel_monitors = HashMap::new();
4505                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4506                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4507                         ::read(&mut std::io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4508                                 default_config: Default::default(),
4509                                 keys_manager,
4510                                 fee_estimator: node_cfgs[0].fee_estimator,
4511                                 chain_monitor: nodes[0].chain_monitor,
4512                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4513                                 logger: nodes[0].logger,
4514                                 channel_monitors,
4515                         }).unwrap()
4516         };
4517         nodes_0_deserialized = nodes_0_deserialized_tmp;
4518
4519         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4520         check_added_monitors!(nodes[0], 1);
4521         nodes[0].node = &nodes_0_deserialized;
4522
4523         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4524         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4525         // payment events should kick in, leaving us with no pending events here.
4526         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4527         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4528         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4529 }
4530
4531 #[test]
4532 fn test_manager_serialize_deserialize_events() {
4533         // This test makes sure the events field in ChannelManager survives de/serialization
4534         let chanmon_cfgs = create_chanmon_cfgs(2);
4535         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4536         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4537         let fee_estimator: test_utils::TestFeeEstimator;
4538         let persister: test_utils::TestPersister;
4539         let logger: test_utils::TestLogger;
4540         let new_chain_monitor: test_utils::TestChainMonitor;
4541         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4543
4544         // Start creating a channel, but stop right before broadcasting the funding transaction
4545         let channel_value = 100000;
4546         let push_msat = 10001;
4547         let a_flags = InitFeatures::known();
4548         let b_flags = InitFeatures::known();
4549         let node_a = nodes.remove(0);
4550         let node_b = nodes.remove(0);
4551         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4552         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()));
4553         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()));
4554
4555         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4556
4557         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4558         check_added_monitors!(node_a, 0);
4559
4560         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()));
4561         {
4562                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4563                 assert_eq!(added_monitors.len(), 1);
4564                 assert_eq!(added_monitors[0].0, funding_output);
4565                 added_monitors.clear();
4566         }
4567
4568         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()));
4569         {
4570                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4571                 assert_eq!(added_monitors.len(), 1);
4572                 assert_eq!(added_monitors[0].0, funding_output);
4573                 added_monitors.clear();
4574         }
4575         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4576
4577         nodes.push(node_a);
4578         nodes.push(node_b);
4579
4580         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4581         let nodes_0_serialized = nodes[0].node.encode();
4582         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4583         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4584
4585         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4586         logger = test_utils::TestLogger::new();
4587         persister = test_utils::TestPersister::new();
4588         let keys_manager = &chanmon_cfgs[0].keys_manager;
4589         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4590         nodes[0].chain_monitor = &new_chain_monitor;
4591         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4592         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4593                 &mut chan_0_monitor_read, keys_manager).unwrap();
4594         assert!(chan_0_monitor_read.is_empty());
4595
4596         let mut nodes_0_read = &nodes_0_serialized[..];
4597         let config = UserConfig::default();
4598         let (_, nodes_0_deserialized_tmp) = {
4599                 let mut channel_monitors = HashMap::new();
4600                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4601                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4602                         default_config: config,
4603                         keys_manager,
4604                         fee_estimator: &fee_estimator,
4605                         chain_monitor: nodes[0].chain_monitor,
4606                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4607                         logger: &logger,
4608                         channel_monitors,
4609                 }).unwrap()
4610         };
4611         nodes_0_deserialized = nodes_0_deserialized_tmp;
4612         assert!(nodes_0_read.is_empty());
4613
4614         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4615
4616         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4617         nodes[0].node = &nodes_0_deserialized;
4618
4619         // After deserializing, make sure the funding_transaction is still held by the channel manager
4620         let events_4 = nodes[0].node.get_and_clear_pending_events();
4621         assert_eq!(events_4.len(), 0);
4622         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4623         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4624
4625         // Make sure the channel is functioning as though the de/serialization never happened
4626         assert_eq!(nodes[0].node.list_channels().len(), 1);
4627         check_added_monitors!(nodes[0], 1);
4628
4629         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4630         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4631         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4632         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4633
4634         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4635         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4636         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4637         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4638
4639         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4640         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4641         for node in nodes.iter() {
4642                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4643                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4644                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4645         }
4646
4647         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4648 }
4649
4650 #[test]
4651 fn test_simple_manager_serialize_deserialize() {
4652         let chanmon_cfgs = create_chanmon_cfgs(2);
4653         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4654         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4655         let logger: test_utils::TestLogger;
4656         let fee_estimator: test_utils::TestFeeEstimator;
4657         let persister: test_utils::TestPersister;
4658         let new_chain_monitor: test_utils::TestChainMonitor;
4659         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4660         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4661         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4662
4663         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4664         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4665
4666         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4667
4668         let nodes_0_serialized = nodes[0].node.encode();
4669         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4670         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4671
4672         logger = test_utils::TestLogger::new();
4673         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4674         persister = test_utils::TestPersister::new();
4675         let keys_manager = &chanmon_cfgs[0].keys_manager;
4676         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4677         nodes[0].chain_monitor = &new_chain_monitor;
4678         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4679         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4680                 &mut chan_0_monitor_read, keys_manager).unwrap();
4681         assert!(chan_0_monitor_read.is_empty());
4682
4683         let mut nodes_0_read = &nodes_0_serialized[..];
4684         let (_, nodes_0_deserialized_tmp) = {
4685                 let mut channel_monitors = HashMap::new();
4686                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4687                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4688                         default_config: UserConfig::default(),
4689                         keys_manager,
4690                         fee_estimator: &fee_estimator,
4691                         chain_monitor: nodes[0].chain_monitor,
4692                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4693                         logger: &logger,
4694                         channel_monitors,
4695                 }).unwrap()
4696         };
4697         nodes_0_deserialized = nodes_0_deserialized_tmp;
4698         assert!(nodes_0_read.is_empty());
4699
4700         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4701         nodes[0].node = &nodes_0_deserialized;
4702         check_added_monitors!(nodes[0], 1);
4703
4704         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4705
4706         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4707         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4708 }
4709
4710 #[test]
4711 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4712         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4713         let chanmon_cfgs = create_chanmon_cfgs(4);
4714         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4715         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4716         let logger: test_utils::TestLogger;
4717         let fee_estimator: test_utils::TestFeeEstimator;
4718         let persister: test_utils::TestPersister;
4719         let new_chain_monitor: test_utils::TestChainMonitor;
4720         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4721         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4722         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4723         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4724         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4725
4726         let mut node_0_stale_monitors_serialized = Vec::new();
4727         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4728                 let mut writer = test_utils::TestVecWriter(Vec::new());
4729                 monitor.1.write(&mut writer).unwrap();
4730                 node_0_stale_monitors_serialized.push(writer.0);
4731         }
4732
4733         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4734
4735         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4736         let nodes_0_serialized = nodes[0].node.encode();
4737
4738         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4739         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4740         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4741         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4742
4743         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4744         // nodes[3])
4745         let mut node_0_monitors_serialized = Vec::new();
4746         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4747                 let mut writer = test_utils::TestVecWriter(Vec::new());
4748                 monitor.1.write(&mut writer).unwrap();
4749                 node_0_monitors_serialized.push(writer.0);
4750         }
4751
4752         logger = test_utils::TestLogger::new();
4753         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4754         persister = test_utils::TestPersister::new();
4755         let keys_manager = &chanmon_cfgs[0].keys_manager;
4756         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4757         nodes[0].chain_monitor = &new_chain_monitor;
4758
4759
4760         let mut node_0_stale_monitors = Vec::new();
4761         for serialized in node_0_stale_monitors_serialized.iter() {
4762                 let mut read = &serialized[..];
4763                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4764                 assert!(read.is_empty());
4765                 node_0_stale_monitors.push(monitor);
4766         }
4767
4768         let mut node_0_monitors = Vec::new();
4769         for serialized in node_0_monitors_serialized.iter() {
4770                 let mut read = &serialized[..];
4771                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4772                 assert!(read.is_empty());
4773                 node_0_monitors.push(monitor);
4774         }
4775
4776         let mut nodes_0_read = &nodes_0_serialized[..];
4777         if let Err(msgs::DecodeError::InvalidValue) =
4778                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4779                 default_config: UserConfig::default(),
4780                 keys_manager,
4781                 fee_estimator: &fee_estimator,
4782                 chain_monitor: nodes[0].chain_monitor,
4783                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4784                 logger: &logger,
4785                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4786         }) { } else {
4787                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4788         };
4789
4790         let mut nodes_0_read = &nodes_0_serialized[..];
4791         let (_, nodes_0_deserialized_tmp) =
4792                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4793                 default_config: UserConfig::default(),
4794                 keys_manager,
4795                 fee_estimator: &fee_estimator,
4796                 chain_monitor: nodes[0].chain_monitor,
4797                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4798                 logger: &logger,
4799                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4800         }).unwrap();
4801         nodes_0_deserialized = nodes_0_deserialized_tmp;
4802         assert!(nodes_0_read.is_empty());
4803
4804         { // Channel close should result in a commitment tx
4805                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4806                 assert_eq!(txn.len(), 1);
4807                 check_spends!(txn[0], funding_tx);
4808                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4809         }
4810
4811         for monitor in node_0_monitors.drain(..) {
4812                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4813                 check_added_monitors!(nodes[0], 1);
4814         }
4815         nodes[0].node = &nodes_0_deserialized;
4816
4817         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4818         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4819         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4820         //... and we can even still claim the payment!
4821         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4822
4823         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4824         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4825         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4826         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4827         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4828         assert_eq!(msg_events.len(), 1);
4829         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4830                 match action {
4831                         &ErrorAction::SendErrorMessage { ref msg } => {
4832                                 assert_eq!(msg.channel_id, channel_id);
4833                         },
4834                         _ => panic!("Unexpected event!"),
4835                 }
4836         }
4837 }
4838
4839 macro_rules! check_spendable_outputs {
4840         ($node: expr, $keysinterface: expr) => {
4841                 {
4842                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4843                         let mut txn = Vec::new();
4844                         let mut all_outputs = Vec::new();
4845                         let secp_ctx = Secp256k1::new();
4846                         for event in events.drain(..) {
4847                                 match event {
4848                                         Event::SpendableOutputs { mut outputs } => {
4849                                                 for outp in outputs.drain(..) {
4850                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4851                                                         all_outputs.push(outp);
4852                                                 }
4853                                         },
4854                                         _ => panic!("Unexpected event"),
4855                                 };
4856                         }
4857                         if all_outputs.len() > 1 {
4858                                 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) {
4859                                         txn.push(tx);
4860                                 }
4861                         }
4862                         txn
4863                 }
4864         }
4865 }
4866
4867 #[test]
4868 fn test_claim_sizeable_push_msat() {
4869         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4870         let chanmon_cfgs = create_chanmon_cfgs(2);
4871         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4872         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4873         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4874
4875         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4876         nodes[1].node.force_close_channel(&chan.2).unwrap();
4877         check_closed_broadcast!(nodes[1], true);
4878         check_added_monitors!(nodes[1], 1);
4879         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4880         assert_eq!(node_txn.len(), 1);
4881         check_spends!(node_txn[0], chan.3);
4882         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
4883
4884         mine_transaction(&nodes[1], &node_txn[0]);
4885         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4886
4887         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4888         assert_eq!(spend_txn.len(), 1);
4889         assert_eq!(spend_txn[0].input.len(), 1);
4890         check_spends!(spend_txn[0], node_txn[0]);
4891         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4892 }
4893
4894 #[test]
4895 fn test_claim_on_remote_sizeable_push_msat() {
4896         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4897         // to_remote output is encumbered by a P2WPKH
4898         let chanmon_cfgs = create_chanmon_cfgs(2);
4899         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4900         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4901         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4902
4903         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4904         nodes[0].node.force_close_channel(&chan.2).unwrap();
4905         check_closed_broadcast!(nodes[0], true);
4906         check_added_monitors!(nodes[0], 1);
4907
4908         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4909         assert_eq!(node_txn.len(), 1);
4910         check_spends!(node_txn[0], chan.3);
4911         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
4912
4913         mine_transaction(&nodes[1], &node_txn[0]);
4914         check_closed_broadcast!(nodes[1], true);
4915         check_added_monitors!(nodes[1], 1);
4916         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4917
4918         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4919         assert_eq!(spend_txn.len(), 1);
4920         check_spends!(spend_txn[0], node_txn[0]);
4921 }
4922
4923 #[test]
4924 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4925         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4926         // to_remote output is encumbered by a P2WPKH
4927
4928         let chanmon_cfgs = create_chanmon_cfgs(2);
4929         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4930         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4931         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4932
4933         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4934         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4935         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4936         assert_eq!(revoked_local_txn[0].input.len(), 1);
4937         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4938
4939         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4940         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4941         check_closed_broadcast!(nodes[1], true);
4942         check_added_monitors!(nodes[1], 1);
4943
4944         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4945         mine_transaction(&nodes[1], &node_txn[0]);
4946         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4947
4948         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4949         assert_eq!(spend_txn.len(), 3);
4950         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4951         check_spends!(spend_txn[1], node_txn[0]);
4952         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4953 }
4954
4955 #[test]
4956 fn test_static_spendable_outputs_preimage_tx() {
4957         let chanmon_cfgs = create_chanmon_cfgs(2);
4958         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4959         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4960         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4961
4962         // Create some initial channels
4963         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4964
4965         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4966
4967         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4968         assert_eq!(commitment_tx[0].input.len(), 1);
4969         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4970
4971         // Settle A's commitment tx on B's chain
4972         assert!(nodes[1].node.claim_funds(payment_preimage));
4973         check_added_monitors!(nodes[1], 1);
4974         mine_transaction(&nodes[1], &commitment_tx[0]);
4975         check_added_monitors!(nodes[1], 1);
4976         let events = nodes[1].node.get_and_clear_pending_msg_events();
4977         match events[0] {
4978                 MessageSendEvent::UpdateHTLCs { .. } => {},
4979                 _ => panic!("Unexpected event"),
4980         }
4981         match events[1] {
4982                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4983                 _ => panic!("Unexepected event"),
4984         }
4985
4986         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4987         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4988         assert_eq!(node_txn.len(), 3);
4989         check_spends!(node_txn[0], commitment_tx[0]);
4990         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4991         check_spends!(node_txn[1], chan_1.3);
4992         check_spends!(node_txn[2], node_txn[1]);
4993
4994         mine_transaction(&nodes[1], &node_txn[0]);
4995         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4996
4997         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4998         assert_eq!(spend_txn.len(), 1);
4999         check_spends!(spend_txn[0], node_txn[0]);
5000 }
5001
5002 #[test]
5003 fn test_static_spendable_outputs_timeout_tx() {
5004         let chanmon_cfgs = create_chanmon_cfgs(2);
5005         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5006         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5007         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5008
5009         // Create some initial channels
5010         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5011
5012         // Rebalance the network a bit by relaying one payment through all the channels ...
5013         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5014
5015         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
5016
5017         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5018         assert_eq!(commitment_tx[0].input.len(), 1);
5019         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
5020
5021         // Settle A's commitment tx on B' chain
5022         mine_transaction(&nodes[1], &commitment_tx[0]);
5023         check_added_monitors!(nodes[1], 1);
5024         let events = nodes[1].node.get_and_clear_pending_msg_events();
5025         match events[0] {
5026                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5027                 _ => panic!("Unexpected event"),
5028         }
5029         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5030
5031         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5032         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5033         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5034         check_spends!(node_txn[0], chan_1.3.clone());
5035         check_spends!(node_txn[1],  commitment_tx[0].clone());
5036         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5037
5038         mine_transaction(&nodes[1], &node_txn[1]);
5039         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5040         expect_payment_failed!(nodes[1], our_payment_hash, true);
5041
5042         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5043         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5044         check_spends!(spend_txn[0], commitment_tx[0]);
5045         check_spends!(spend_txn[1], node_txn[1]);
5046         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5047 }
5048
5049 #[test]
5050 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5051         let chanmon_cfgs = create_chanmon_cfgs(2);
5052         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5053         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5054         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5055
5056         // Create some initial channels
5057         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5058
5059         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5060         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5061         assert_eq!(revoked_local_txn[0].input.len(), 1);
5062         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5063
5064         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5065
5066         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5067         check_closed_broadcast!(nodes[1], true);
5068         check_added_monitors!(nodes[1], 1);
5069
5070         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5071         assert_eq!(node_txn.len(), 2);
5072         assert_eq!(node_txn[0].input.len(), 2);
5073         check_spends!(node_txn[0], revoked_local_txn[0]);
5074
5075         mine_transaction(&nodes[1], &node_txn[0]);
5076         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5077
5078         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5079         assert_eq!(spend_txn.len(), 1);
5080         check_spends!(spend_txn[0], node_txn[0]);
5081 }
5082
5083 #[test]
5084 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5085         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5086         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5087         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5088         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5089         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5090
5091         // Create some initial channels
5092         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5093
5094         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5095         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5096         assert_eq!(revoked_local_txn[0].input.len(), 1);
5097         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5098
5099         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5100
5101         // A will generate HTLC-Timeout from revoked commitment tx
5102         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5103         check_closed_broadcast!(nodes[0], true);
5104         check_added_monitors!(nodes[0], 1);
5105         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5106
5107         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5108         assert_eq!(revoked_htlc_txn.len(), 2);
5109         check_spends!(revoked_htlc_txn[0], chan_1.3);
5110         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5111         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5112         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5113         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5114
5115         // B will generate justice tx from A's revoked commitment/HTLC tx
5116         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5117         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5118         check_closed_broadcast!(nodes[1], true);
5119         check_added_monitors!(nodes[1], 1);
5120
5121         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5122         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5123         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5124         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5125         // transactions next...
5126         assert_eq!(node_txn[0].input.len(), 3);
5127         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5128
5129         assert_eq!(node_txn[1].input.len(), 2);
5130         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5131         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5132                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5133         } else {
5134                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5135                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5136         }
5137
5138         assert_eq!(node_txn[2].input.len(), 1);
5139         check_spends!(node_txn[2], chan_1.3);
5140
5141         mine_transaction(&nodes[1], &node_txn[1]);
5142         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5143
5144         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5145         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5146         assert_eq!(spend_txn.len(), 1);
5147         assert_eq!(spend_txn[0].input.len(), 1);
5148         check_spends!(spend_txn[0], node_txn[1]);
5149 }
5150
5151 #[test]
5152 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5153         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5154         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5155         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5156         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5157         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5158
5159         // Create some initial channels
5160         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5161
5162         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5163         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5164         assert_eq!(revoked_local_txn[0].input.len(), 1);
5165         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5166
5167         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5168         assert_eq!(revoked_local_txn[0].output.len(), 2);
5169
5170         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5171
5172         // B will generate HTLC-Success from revoked commitment tx
5173         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5174         check_closed_broadcast!(nodes[1], true);
5175         check_added_monitors!(nodes[1], 1);
5176         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5177
5178         assert_eq!(revoked_htlc_txn.len(), 2);
5179         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5180         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5181         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5182
5183         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5184         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5185         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5186
5187         // A will generate justice tx from B's revoked commitment/HTLC tx
5188         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5189         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5190         check_closed_broadcast!(nodes[0], true);
5191         check_added_monitors!(nodes[0], 1);
5192
5193         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5194         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5195
5196         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5197         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5198         // transactions next...
5199         assert_eq!(node_txn[0].input.len(), 2);
5200         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5201         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5202                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5203         } else {
5204                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5205                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5206         }
5207
5208         assert_eq!(node_txn[1].input.len(), 1);
5209         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5210
5211         check_spends!(node_txn[2], chan_1.3);
5212
5213         mine_transaction(&nodes[0], &node_txn[1]);
5214         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5215
5216         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5217         // didn't try to generate any new transactions.
5218
5219         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5220         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5221         assert_eq!(spend_txn.len(), 3);
5222         assert_eq!(spend_txn[0].input.len(), 1);
5223         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5224         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5225         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5226         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5227 }
5228
5229 #[test]
5230 fn test_onchain_to_onchain_claim() {
5231         // Test that in case of channel closure, we detect the state of output and claim HTLC
5232         // on downstream peer's remote commitment tx.
5233         // First, have C claim an HTLC against its own latest commitment transaction.
5234         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5235         // channel.
5236         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5237         // gets broadcast.
5238
5239         let chanmon_cfgs = create_chanmon_cfgs(3);
5240         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5241         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5242         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5243
5244         // Create some initial channels
5245         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5246         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5247
5248         // Ensure all nodes are at the same height
5249         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5250         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5251         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5252         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5253
5254         // Rebalance the network a bit by relaying one payment through all the channels ...
5255         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5256         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5257
5258         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5259         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5260         check_spends!(commitment_tx[0], chan_2.3);
5261         nodes[2].node.claim_funds(payment_preimage);
5262         check_added_monitors!(nodes[2], 1);
5263         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5264         assert!(updates.update_add_htlcs.is_empty());
5265         assert!(updates.update_fail_htlcs.is_empty());
5266         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5267         assert!(updates.update_fail_malformed_htlcs.is_empty());
5268
5269         mine_transaction(&nodes[2], &commitment_tx[0]);
5270         check_closed_broadcast!(nodes[2], true);
5271         check_added_monitors!(nodes[2], 1);
5272
5273         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5274         assert_eq!(c_txn.len(), 3);
5275         assert_eq!(c_txn[0], c_txn[2]);
5276         assert_eq!(commitment_tx[0], c_txn[1]);
5277         check_spends!(c_txn[1], chan_2.3);
5278         check_spends!(c_txn[2], c_txn[1]);
5279         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5280         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5281         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5282         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5283
5284         // 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
5285         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5286         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5287         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5288         {
5289                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5290                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx
5291                 assert_eq!(b_txn.len(), 2);
5292                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5293                 check_spends!(b_txn[1], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5294                 assert_eq!(b_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5295                 assert!(b_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5296                 assert_ne!(b_txn[1].lock_time, 0); // Timeout tx
5297                 b_txn.clear();
5298         }
5299         check_added_monitors!(nodes[1], 1);
5300         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5301         assert_eq!(msg_events.len(), 3);
5302         check_added_monitors!(nodes[1], 1);
5303         match msg_events[0] {
5304                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5305                 _ => panic!("Unexpected event"),
5306         }
5307         match msg_events[1] {
5308                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5309                 _ => panic!("Unexpected event"),
5310         }
5311         match msg_events[2] {
5312                 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, .. } } => {
5313                         assert!(update_add_htlcs.is_empty());
5314                         assert!(update_fail_htlcs.is_empty());
5315                         assert_eq!(update_fulfill_htlcs.len(), 1);
5316                         assert!(update_fail_malformed_htlcs.is_empty());
5317                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5318                 },
5319                 _ => panic!("Unexpected event"),
5320         };
5321         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5322         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5323         mine_transaction(&nodes[1], &commitment_tx[0]);
5324         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5325         // ChannelMonitor: HTLC-Success tx + HTLC-Timeout RBF Bump, ChannelManager: local commitment tx + HTLC-Success tx
5326         assert_eq!(b_txn.len(), 4);
5327         check_spends!(b_txn[2], chan_1.3);
5328         check_spends!(b_txn[3], b_txn[2]);
5329         let (htlc_success_claim, htlc_timeout_bumped) =
5330                 if b_txn[0].input[0].previous_output.txid == commitment_tx[0].txid()
5331                         { (&b_txn[0], &b_txn[1]) } else { (&b_txn[1], &b_txn[0]) };
5332         check_spends!(htlc_success_claim, commitment_tx[0]);
5333         assert_eq!(htlc_success_claim.input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5334         assert!(htlc_success_claim.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5335         assert_eq!(htlc_success_claim.lock_time, 0); // Success tx
5336         check_spends!(htlc_timeout_bumped, c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5337         assert_ne!(htlc_timeout_bumped.lock_time, 0); // Success tx
5338
5339         check_closed_broadcast!(nodes[1], true);
5340         check_added_monitors!(nodes[1], 1);
5341 }
5342
5343 #[test]
5344 fn test_duplicate_payment_hash_one_failure_one_success() {
5345         // Topology : A --> B --> C --> D
5346         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5347         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5348         // we forward one of the payments onwards to D.
5349         let chanmon_cfgs = create_chanmon_cfgs(4);
5350         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5351         // When this test was written, the default base fee floated based on the HTLC count.
5352         // It is now fixed, so we simply set the fee to the expected value here.
5353         let mut config = test_default_channel_config();
5354         config.channel_options.forwarding_fee_base_msat = 196;
5355         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5356                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5357         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5358
5359         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5360         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5361         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5362
5363         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5364         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5365         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5366         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5367         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5368
5369         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5370
5371         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5372         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5373         // script push size limit so that the below script length checks match
5374         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5375         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5376                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5377         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5378
5379         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5380         assert_eq!(commitment_txn[0].input.len(), 1);
5381         check_spends!(commitment_txn[0], chan_2.3);
5382
5383         mine_transaction(&nodes[1], &commitment_txn[0]);
5384         check_closed_broadcast!(nodes[1], true);
5385         check_added_monitors!(nodes[1], 1);
5386         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5387
5388         let htlc_timeout_tx;
5389         { // Extract one of the two HTLC-Timeout transaction
5390                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5391                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5392                 assert_eq!(node_txn.len(), 4);
5393                 check_spends!(node_txn[0], chan_2.3);
5394
5395                 check_spends!(node_txn[1], commitment_txn[0]);
5396                 assert_eq!(node_txn[1].input.len(), 1);
5397                 check_spends!(node_txn[2], commitment_txn[0]);
5398                 assert_eq!(node_txn[2].input.len(), 1);
5399                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5400                 check_spends!(node_txn[3], commitment_txn[0]);
5401                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5402
5403                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5404                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5405                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5406                 htlc_timeout_tx = node_txn[1].clone();
5407         }
5408
5409         nodes[2].node.claim_funds(our_payment_preimage);
5410         mine_transaction(&nodes[2], &commitment_txn[0]);
5411         check_added_monitors!(nodes[2], 2);
5412         let events = nodes[2].node.get_and_clear_pending_msg_events();
5413         match events[0] {
5414                 MessageSendEvent::UpdateHTLCs { .. } => {},
5415                 _ => panic!("Unexpected event"),
5416         }
5417         match events[1] {
5418                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5419                 _ => panic!("Unexepected event"),
5420         }
5421         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5422         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)
5423         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5424         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5425         assert_eq!(htlc_success_txn[0].input.len(), 1);
5426         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5427         assert_eq!(htlc_success_txn[1].input.len(), 1);
5428         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5429         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5430         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5431         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5432         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5433         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5434
5435         mine_transaction(&nodes[1], &htlc_timeout_tx);
5436         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5437         expect_pending_htlcs_forwardable!(nodes[1]);
5438         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5439         assert!(htlc_updates.update_add_htlcs.is_empty());
5440         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5441         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5442         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5443         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5444         check_added_monitors!(nodes[1], 1);
5445
5446         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5447         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5448         {
5449                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5450                 expect_payment_failure_chan_update!(nodes[0], chan_2.0.contents.short_channel_id, true);
5451         }
5452         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5453
5454         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5455         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5456         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5457         assert!(updates.update_add_htlcs.is_empty());
5458         assert!(updates.update_fail_htlcs.is_empty());
5459         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5460         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5461         assert!(updates.update_fail_malformed_htlcs.is_empty());
5462         check_added_monitors!(nodes[1], 1);
5463
5464         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5465         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5466
5467         let events = nodes[0].node.get_and_clear_pending_events();
5468         match events[0] {
5469                 Event::PaymentSent { ref payment_preimage } => {
5470                         assert_eq!(*payment_preimage, our_payment_preimage);
5471                 }
5472                 _ => panic!("Unexpected event"),
5473         }
5474 }
5475
5476 #[test]
5477 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5478         let chanmon_cfgs = create_chanmon_cfgs(2);
5479         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5480         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5481         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5482
5483         // Create some initial channels
5484         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5485
5486         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5487         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5488         assert_eq!(local_txn.len(), 1);
5489         assert_eq!(local_txn[0].input.len(), 1);
5490         check_spends!(local_txn[0], chan_1.3);
5491
5492         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5493         nodes[1].node.claim_funds(payment_preimage);
5494         check_added_monitors!(nodes[1], 1);
5495         mine_transaction(&nodes[1], &local_txn[0]);
5496         check_added_monitors!(nodes[1], 1);
5497         let events = nodes[1].node.get_and_clear_pending_msg_events();
5498         match events[0] {
5499                 MessageSendEvent::UpdateHTLCs { .. } => {},
5500                 _ => panic!("Unexpected event"),
5501         }
5502         match events[1] {
5503                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5504                 _ => panic!("Unexepected event"),
5505         }
5506         let node_tx = {
5507                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5508                 assert_eq!(node_txn.len(), 3);
5509                 assert_eq!(node_txn[0], node_txn[2]);
5510                 assert_eq!(node_txn[1], local_txn[0]);
5511                 assert_eq!(node_txn[0].input.len(), 1);
5512                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5513                 check_spends!(node_txn[0], local_txn[0]);
5514                 node_txn[0].clone()
5515         };
5516
5517         mine_transaction(&nodes[1], &node_tx);
5518         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5519
5520         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5521         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5522         assert_eq!(spend_txn.len(), 1);
5523         assert_eq!(spend_txn[0].input.len(), 1);
5524         check_spends!(spend_txn[0], node_tx);
5525         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5526 }
5527
5528 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5529         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5530         // unrevoked commitment transaction.
5531         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5532         // a remote RAA before they could be failed backwards (and combinations thereof).
5533         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5534         // use the same payment hashes.
5535         // Thus, we use a six-node network:
5536         //
5537         // A \         / E
5538         //    - C - D -
5539         // B /         \ F
5540         // And test where C fails back to A/B when D announces its latest commitment transaction
5541         let chanmon_cfgs = create_chanmon_cfgs(6);
5542         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5543         // When this test was written, the default base fee floated based on the HTLC count.
5544         // It is now fixed, so we simply set the fee to the expected value here.
5545         let mut config = test_default_channel_config();
5546         config.channel_options.forwarding_fee_base_msat = 196;
5547         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5548                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5549         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5550         let logger = test_utils::TestLogger::new();
5551
5552         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5553         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5554         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5555         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5556         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5557
5558         // Rebalance and check output sanity...
5559         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5560         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5561         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5562
5563         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5564         // 0th HTLC:
5565         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
5566         // 1st HTLC:
5567         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
5568         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5569         let our_node_id = &nodes[1].node.get_our_node_id();
5570         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();
5571         // 2nd HTLC:
5572         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
5573         // 3rd HTLC:
5574         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
5575         // 4th HTLC:
5576         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5577         // 5th HTLC:
5578         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5579         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();
5580         // 6th HTLC:
5581         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());
5582         // 7th HTLC:
5583         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());
5584
5585         // 8th HTLC:
5586         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5587         // 9th HTLC:
5588         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();
5589         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
5590
5591         // 10th HTLC:
5592         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
5593         // 11th HTLC:
5594         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();
5595         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());
5596
5597         // Double-check that six of the new HTLC were added
5598         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5599         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5600         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5601         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5602
5603         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5604         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5605         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5606         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5607         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5608         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5609         check_added_monitors!(nodes[4], 0);
5610         expect_pending_htlcs_forwardable!(nodes[4]);
5611         check_added_monitors!(nodes[4], 1);
5612
5613         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5614         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5615         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5616         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5617         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5618         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5619
5620         // Fail 3rd below-dust and 7th above-dust HTLCs
5621         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5622         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5623         check_added_monitors!(nodes[5], 0);
5624         expect_pending_htlcs_forwardable!(nodes[5]);
5625         check_added_monitors!(nodes[5], 1);
5626
5627         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5628         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5629         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5630         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5631
5632         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5633
5634         expect_pending_htlcs_forwardable!(nodes[3]);
5635         check_added_monitors!(nodes[3], 1);
5636         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5637         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5638         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5639         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5640         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5641         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5642         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5643         if deliver_last_raa {
5644                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5645         } else {
5646                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5647         }
5648
5649         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5650         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5651         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5652         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5653         //
5654         // We now broadcast the latest commitment transaction, which *should* result in failures for
5655         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5656         // the non-broadcast above-dust HTLCs.
5657         //
5658         // Alternatively, we may broadcast the previous commitment transaction, which should only
5659         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5660         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5661
5662         if announce_latest {
5663                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5664         } else {
5665                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5666         }
5667         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5668         check_closed_broadcast!(nodes[2], true);
5669         expect_pending_htlcs_forwardable!(nodes[2]);
5670         check_added_monitors!(nodes[2], 3);
5671
5672         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5673         assert_eq!(cs_msgs.len(), 2);
5674         let mut a_done = false;
5675         for msg in cs_msgs {
5676                 match msg {
5677                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5678                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5679                                 // should be failed-backwards here.
5680                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5681                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5682                                         for htlc in &updates.update_fail_htlcs {
5683                                                 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 });
5684                                         }
5685                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5686                                         assert!(!a_done);
5687                                         a_done = true;
5688                                         &nodes[0]
5689                                 } else {
5690                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5691                                         for htlc in &updates.update_fail_htlcs {
5692                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5693                                         }
5694                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5695                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5696                                         &nodes[1]
5697                                 };
5698                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5699                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5700                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5701                                 if announce_latest {
5702                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5703                                         if *node_id == nodes[0].node.get_our_node_id() {
5704                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5705                                         }
5706                                 }
5707                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5708                         },
5709                         _ => panic!("Unexpected event"),
5710                 }
5711         }
5712
5713         let as_events = nodes[0].node.get_and_clear_pending_events();
5714         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5715         let mut as_failds = HashSet::new();
5716         for event in as_events.iter() {
5717                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5718                         assert!(as_failds.insert(*payment_hash));
5719                         if *payment_hash != payment_hash_2 {
5720                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5721                         } else {
5722                                 assert!(!rejected_by_dest);
5723                         }
5724                 } else { panic!("Unexpected event"); }
5725         }
5726         assert!(as_failds.contains(&payment_hash_1));
5727         assert!(as_failds.contains(&payment_hash_2));
5728         if announce_latest {
5729                 assert!(as_failds.contains(&payment_hash_3));
5730                 assert!(as_failds.contains(&payment_hash_5));
5731         }
5732         assert!(as_failds.contains(&payment_hash_6));
5733
5734         let bs_events = nodes[1].node.get_and_clear_pending_events();
5735         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5736         let mut bs_failds = HashSet::new();
5737         for event in bs_events.iter() {
5738                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5739                         assert!(bs_failds.insert(*payment_hash));
5740                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5741                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5742                         } else {
5743                                 assert!(!rejected_by_dest);
5744                         }
5745                 } else { panic!("Unexpected event"); }
5746         }
5747         assert!(bs_failds.contains(&payment_hash_1));
5748         assert!(bs_failds.contains(&payment_hash_2));
5749         if announce_latest {
5750                 assert!(bs_failds.contains(&payment_hash_4));
5751         }
5752         assert!(bs_failds.contains(&payment_hash_5));
5753
5754         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5755         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5756         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5757         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5758         // PaymentFailureNetworkUpdates.
5759         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5760         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5761         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5762         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5763         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5764                 match event {
5765                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5766                         _ => panic!("Unexpected event"),
5767                 }
5768         }
5769 }
5770
5771 #[test]
5772 fn test_fail_backwards_latest_remote_announce_a() {
5773         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5774 }
5775
5776 #[test]
5777 fn test_fail_backwards_latest_remote_announce_b() {
5778         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5779 }
5780
5781 #[test]
5782 fn test_fail_backwards_previous_remote_announce() {
5783         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5784         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5785         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5786 }
5787
5788 #[test]
5789 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5790         let chanmon_cfgs = create_chanmon_cfgs(2);
5791         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5792         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5793         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5794
5795         // Create some initial channels
5796         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5797
5798         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5799         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5800         assert_eq!(local_txn[0].input.len(), 1);
5801         check_spends!(local_txn[0], chan_1.3);
5802
5803         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5804         mine_transaction(&nodes[0], &local_txn[0]);
5805         check_closed_broadcast!(nodes[0], true);
5806         check_added_monitors!(nodes[0], 1);
5807         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5808
5809         let htlc_timeout = {
5810                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5811                 assert_eq!(node_txn.len(), 2);
5812                 check_spends!(node_txn[0], chan_1.3);
5813                 assert_eq!(node_txn[1].input.len(), 1);
5814                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5815                 check_spends!(node_txn[1], local_txn[0]);
5816                 node_txn[1].clone()
5817         };
5818
5819         mine_transaction(&nodes[0], &htlc_timeout);
5820         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5821         expect_payment_failed!(nodes[0], our_payment_hash, true);
5822
5823         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5824         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5825         assert_eq!(spend_txn.len(), 3);
5826         check_spends!(spend_txn[0], local_txn[0]);
5827         assert_eq!(spend_txn[1].input.len(), 1);
5828         check_spends!(spend_txn[1], htlc_timeout);
5829         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5830         assert_eq!(spend_txn[2].input.len(), 2);
5831         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5832         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5833                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5834 }
5835
5836 #[test]
5837 fn test_key_derivation_params() {
5838         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5839         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5840         // let us re-derive the channel key set to then derive a delayed_payment_key.
5841
5842         let chanmon_cfgs = create_chanmon_cfgs(3);
5843
5844         // We manually create the node configuration to backup the seed.
5845         let seed = [42; 32];
5846         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5847         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);
5848         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 };
5849         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5850         node_cfgs.remove(0);
5851         node_cfgs.insert(0, node);
5852
5853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5854         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5855
5856         // Create some initial channels
5857         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5858         // for node 0
5859         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5860         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5861         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5862
5863         // Ensure all nodes are at the same height
5864         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5865         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5866         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5867         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5868
5869         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5870         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5871         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5872         assert_eq!(local_txn_1[0].input.len(), 1);
5873         check_spends!(local_txn_1[0], chan_1.3);
5874
5875         // We check funding pubkey are unique
5876         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]));
5877         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]));
5878         if from_0_funding_key_0 == from_1_funding_key_0
5879             || from_0_funding_key_0 == from_1_funding_key_1
5880             || from_0_funding_key_1 == from_1_funding_key_0
5881             || from_0_funding_key_1 == from_1_funding_key_1 {
5882                 panic!("Funding pubkeys aren't unique");
5883         }
5884
5885         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5886         mine_transaction(&nodes[0], &local_txn_1[0]);
5887         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5888         check_closed_broadcast!(nodes[0], true);
5889         check_added_monitors!(nodes[0], 1);
5890
5891         let htlc_timeout = {
5892                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5893                 assert_eq!(node_txn[1].input.len(), 1);
5894                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5895                 check_spends!(node_txn[1], local_txn_1[0]);
5896                 node_txn[1].clone()
5897         };
5898
5899         mine_transaction(&nodes[0], &htlc_timeout);
5900         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5901         expect_payment_failed!(nodes[0], our_payment_hash, true);
5902
5903         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5904         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5905         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5906         assert_eq!(spend_txn.len(), 3);
5907         check_spends!(spend_txn[0], local_txn_1[0]);
5908         assert_eq!(spend_txn[1].input.len(), 1);
5909         check_spends!(spend_txn[1], htlc_timeout);
5910         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5911         assert_eq!(spend_txn[2].input.len(), 2);
5912         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5913         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5914                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5915 }
5916
5917 #[test]
5918 fn test_static_output_closing_tx() {
5919         let chanmon_cfgs = create_chanmon_cfgs(2);
5920         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5921         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5922         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5923
5924         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5925
5926         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5927         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5928
5929         mine_transaction(&nodes[0], &closing_tx);
5930         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5931
5932         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5933         assert_eq!(spend_txn.len(), 1);
5934         check_spends!(spend_txn[0], closing_tx);
5935
5936         mine_transaction(&nodes[1], &closing_tx);
5937         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5938
5939         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5940         assert_eq!(spend_txn.len(), 1);
5941         check_spends!(spend_txn[0], closing_tx);
5942 }
5943
5944 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5945         let chanmon_cfgs = create_chanmon_cfgs(2);
5946         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5947         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5948         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5949         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5950
5951         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5952
5953         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5954         // present in B's local commitment transaction, but none of A's commitment transactions.
5955         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5956         check_added_monitors!(nodes[1], 1);
5957
5958         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5959         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5960         let events = nodes[0].node.get_and_clear_pending_events();
5961         assert_eq!(events.len(), 1);
5962         match events[0] {
5963                 Event::PaymentSent { payment_preimage } => {
5964                         assert_eq!(payment_preimage, our_payment_preimage);
5965                 },
5966                 _ => panic!("Unexpected event"),
5967         }
5968
5969         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5970         check_added_monitors!(nodes[0], 1);
5971         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5972         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5973         check_added_monitors!(nodes[1], 1);
5974
5975         let starting_block = nodes[1].best_block_info();
5976         let mut block = Block {
5977                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5978                 txdata: vec![],
5979         };
5980         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5981                 connect_block(&nodes[1], &block);
5982                 block.header.prev_blockhash = block.block_hash();
5983         }
5984         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5985         check_closed_broadcast!(nodes[1], true);
5986         check_added_monitors!(nodes[1], 1);
5987 }
5988
5989 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5990         let chanmon_cfgs = create_chanmon_cfgs(2);
5991         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5992         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5993         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5994         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5995         let logger = test_utils::TestLogger::new();
5996
5997         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5998         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5999         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();
6000         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6001         check_added_monitors!(nodes[0], 1);
6002
6003         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6004
6005         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6006         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6007         // to "time out" the HTLC.
6008
6009         let starting_block = nodes[1].best_block_info();
6010         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6011
6012         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6013                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6014                 header.prev_blockhash = header.block_hash();
6015         }
6016         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6017         check_closed_broadcast!(nodes[0], true);
6018         check_added_monitors!(nodes[0], 1);
6019 }
6020
6021 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6022         let chanmon_cfgs = create_chanmon_cfgs(3);
6023         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6024         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6025         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6026         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6027
6028         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6029         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6030         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6031         // actually revoked.
6032         let htlc_value = if use_dust { 50000 } else { 3000000 };
6033         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6034         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6035         expect_pending_htlcs_forwardable!(nodes[1]);
6036         check_added_monitors!(nodes[1], 1);
6037
6038         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6039         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6040         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6041         check_added_monitors!(nodes[0], 1);
6042         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6043         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6044         check_added_monitors!(nodes[1], 1);
6045         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6046         check_added_monitors!(nodes[1], 1);
6047         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6048
6049         if check_revoke_no_close {
6050                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6051                 check_added_monitors!(nodes[0], 1);
6052         }
6053
6054         let starting_block = nodes[1].best_block_info();
6055         let mut block = Block {
6056                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6057                 txdata: vec![],
6058         };
6059         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6060                 connect_block(&nodes[0], &block);
6061                 block.header.prev_blockhash = block.block_hash();
6062         }
6063         if !check_revoke_no_close {
6064                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6065                 check_closed_broadcast!(nodes[0], true);
6066                 check_added_monitors!(nodes[0], 1);
6067         } else {
6068                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6069         }
6070 }
6071
6072 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6073 // There are only a few cases to test here:
6074 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6075 //    broadcastable commitment transactions result in channel closure,
6076 //  * its included in an unrevoked-but-previous remote commitment transaction,
6077 //  * its included in the latest remote or local commitment transactions.
6078 // We test each of the three possible commitment transactions individually and use both dust and
6079 // non-dust HTLCs.
6080 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6081 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6082 // tested for at least one of the cases in other tests.
6083 #[test]
6084 fn htlc_claim_single_commitment_only_a() {
6085         do_htlc_claim_local_commitment_only(true);
6086         do_htlc_claim_local_commitment_only(false);
6087
6088         do_htlc_claim_current_remote_commitment_only(true);
6089         do_htlc_claim_current_remote_commitment_only(false);
6090 }
6091
6092 #[test]
6093 fn htlc_claim_single_commitment_only_b() {
6094         do_htlc_claim_previous_remote_commitment_only(true, false);
6095         do_htlc_claim_previous_remote_commitment_only(false, false);
6096         do_htlc_claim_previous_remote_commitment_only(true, true);
6097         do_htlc_claim_previous_remote_commitment_only(false, true);
6098 }
6099
6100 #[test]
6101 #[should_panic]
6102 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6103         let chanmon_cfgs = create_chanmon_cfgs(2);
6104         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6105         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6106         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6107         //Force duplicate channel ids
6108         for node in nodes.iter() {
6109                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6110         }
6111
6112         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6113         let channel_value_satoshis=10000;
6114         let push_msat=10001;
6115         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6116         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6117         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6118
6119         //Create a second channel with a channel_id collision
6120         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6121 }
6122
6123 #[test]
6124 fn bolt2_open_channel_sending_node_checks_part2() {
6125         let chanmon_cfgs = create_chanmon_cfgs(2);
6126         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6127         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6128         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6129
6130         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6131         let channel_value_satoshis=2^24;
6132         let push_msat=10001;
6133         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6134
6135         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6136         let channel_value_satoshis=10000;
6137         // Test when push_msat is equal to 1000 * funding_satoshis.
6138         let push_msat=1000*channel_value_satoshis+1;
6139         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6140
6141         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6142         let channel_value_satoshis=10000;
6143         let push_msat=10001;
6144         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
6145         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6146         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6147
6148         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6149         // 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
6150         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6151
6152         // 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.
6153         assert!(BREAKDOWN_TIMEOUT>0);
6154         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6155
6156         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6157         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6158         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6159
6160         // 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.
6161         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6162         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6163         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6164         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6165         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6166 }
6167
6168 #[test]
6169 fn bolt2_open_channel_sane_dust_limit() {
6170         let chanmon_cfgs = create_chanmon_cfgs(2);
6171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6174
6175         let channel_value_satoshis=1000000;
6176         let push_msat=10001;
6177         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6178         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6179         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
6180         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6181
6182         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6183         let events = nodes[1].node.get_and_clear_pending_msg_events();
6184         let err_msg = match events[0] {
6185                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6186                         msg.clone()
6187                 },
6188                 _ => panic!("Unexpected event"),
6189         };
6190         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
6191 }
6192
6193 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6194 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6195 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6196 // is no longer affordable once it's freed.
6197 #[test]
6198 fn test_fail_holding_cell_htlc_upon_free() {
6199         let chanmon_cfgs = create_chanmon_cfgs(2);
6200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6202         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6203         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6204         let logger = test_utils::TestLogger::new();
6205
6206         // First nodes[0] generates an update_fee, setting the channel's
6207         // pending_update_fee.
6208         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6209         check_added_monitors!(nodes[0], 1);
6210
6211         let events = nodes[0].node.get_and_clear_pending_msg_events();
6212         assert_eq!(events.len(), 1);
6213         let (update_msg, commitment_signed) = match events[0] {
6214                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6215                         (update_fee.as_ref(), commitment_signed)
6216                 },
6217                 _ => panic!("Unexpected event"),
6218         };
6219
6220         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6221
6222         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6223         let channel_reserve = chan_stat.channel_reserve_msat;
6224         let feerate = get_feerate!(nodes[0], chan.2);
6225
6226         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6227         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6228         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6229         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6230         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();
6231
6232         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6233         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6234         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6235         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6236
6237         // Flush the pending fee update.
6238         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6239         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6240         check_added_monitors!(nodes[1], 1);
6241         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6242         check_added_monitors!(nodes[0], 1);
6243
6244         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6245         // HTLC, but now that the fee has been raised the payment will now fail, causing
6246         // us to surface its failure to the user.
6247         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6248         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6249         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);
6250         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 {}",
6251                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6252         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6253
6254         // Check that the payment failed to be sent out.
6255         let events = nodes[0].node.get_and_clear_pending_events();
6256         assert_eq!(events.len(), 1);
6257         match &events[0] {
6258                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6259                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6260                         assert_eq!(*rejected_by_dest, false);
6261                         assert_eq!(*error_code, None);
6262                         assert_eq!(*error_data, None);
6263                 },
6264                 _ => panic!("Unexpected event"),
6265         }
6266 }
6267
6268 // Test that if multiple HTLCs are released from the holding cell and one is
6269 // valid but the other is no longer valid upon release, the valid HTLC can be
6270 // successfully completed while the other one fails as expected.
6271 #[test]
6272 fn test_free_and_fail_holding_cell_htlcs() {
6273         let chanmon_cfgs = create_chanmon_cfgs(2);
6274         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6275         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6276         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6277         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6278         let logger = test_utils::TestLogger::new();
6279
6280         // First nodes[0] generates an update_fee, setting the channel's
6281         // pending_update_fee.
6282         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6283         check_added_monitors!(nodes[0], 1);
6284
6285         let events = nodes[0].node.get_and_clear_pending_msg_events();
6286         assert_eq!(events.len(), 1);
6287         let (update_msg, commitment_signed) = match events[0] {
6288                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6289                         (update_fee.as_ref(), commitment_signed)
6290                 },
6291                 _ => panic!("Unexpected event"),
6292         };
6293
6294         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6295
6296         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6297         let channel_reserve = chan_stat.channel_reserve_msat;
6298         let feerate = get_feerate!(nodes[0], chan.2);
6299
6300         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6301         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6302         let amt_1 = 20000;
6303         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6304         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6305         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6306         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();
6307         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();
6308
6309         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6310         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6311         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6312         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6313         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6314         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6315         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6316
6317         // Flush the pending fee update.
6318         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6319         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6320         check_added_monitors!(nodes[1], 1);
6321         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6322         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6323         check_added_monitors!(nodes[0], 2);
6324
6325         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6326         // but now that the fee has been raised the second payment will now fail, causing us
6327         // to surface its failure to the user. The first payment should succeed.
6328         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6329         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6330         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);
6331         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 {}",
6332                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6333         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6334
6335         // Check that the second payment failed to be sent out.
6336         let events = nodes[0].node.get_and_clear_pending_events();
6337         assert_eq!(events.len(), 1);
6338         match &events[0] {
6339                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6340                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6341                         assert_eq!(*rejected_by_dest, false);
6342                         assert_eq!(*error_code, None);
6343                         assert_eq!(*error_data, None);
6344                 },
6345                 _ => panic!("Unexpected event"),
6346         }
6347
6348         // Complete the first payment and the RAA from the fee update.
6349         let (payment_event, send_raa_event) = {
6350                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6351                 assert_eq!(msgs.len(), 2);
6352                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6353         };
6354         let raa = match send_raa_event {
6355                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6356                 _ => panic!("Unexpected event"),
6357         };
6358         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6359         check_added_monitors!(nodes[1], 1);
6360         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6361         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6362         let events = nodes[1].node.get_and_clear_pending_events();
6363         assert_eq!(events.len(), 1);
6364         match events[0] {
6365                 Event::PendingHTLCsForwardable { .. } => {},
6366                 _ => panic!("Unexpected event"),
6367         }
6368         nodes[1].node.process_pending_htlc_forwards();
6369         let events = nodes[1].node.get_and_clear_pending_events();
6370         assert_eq!(events.len(), 1);
6371         match events[0] {
6372                 Event::PaymentReceived { .. } => {},
6373                 _ => panic!("Unexpected event"),
6374         }
6375         nodes[1].node.claim_funds(payment_preimage_1);
6376         check_added_monitors!(nodes[1], 1);
6377         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6378         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6379         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6380         let events = nodes[0].node.get_and_clear_pending_events();
6381         assert_eq!(events.len(), 1);
6382         match events[0] {
6383                 Event::PaymentSent { ref payment_preimage } => {
6384                         assert_eq!(*payment_preimage, payment_preimage_1);
6385                 }
6386                 _ => panic!("Unexpected event"),
6387         }
6388 }
6389
6390 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6391 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6392 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6393 // once it's freed.
6394 #[test]
6395 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6396         let chanmon_cfgs = create_chanmon_cfgs(3);
6397         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6398         // When this test was written, the default base fee floated based on the HTLC count.
6399         // It is now fixed, so we simply set the fee to the expected value here.
6400         let mut config = test_default_channel_config();
6401         config.channel_options.forwarding_fee_base_msat = 196;
6402         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6403         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6404         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6405         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6406         let logger = test_utils::TestLogger::new();
6407
6408         // First nodes[1] generates an update_fee, setting the channel's
6409         // pending_update_fee.
6410         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6411         check_added_monitors!(nodes[1], 1);
6412
6413         let events = nodes[1].node.get_and_clear_pending_msg_events();
6414         assert_eq!(events.len(), 1);
6415         let (update_msg, commitment_signed) = match events[0] {
6416                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6417                         (update_fee.as_ref(), commitment_signed)
6418                 },
6419                 _ => panic!("Unexpected event"),
6420         };
6421
6422         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6423
6424         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6425         let channel_reserve = chan_stat.channel_reserve_msat;
6426         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6427
6428         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6429         let feemsat = 239;
6430         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6431         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6432         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6433         let payment_event = {
6434                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6435                 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();
6436                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6437                 check_added_monitors!(nodes[0], 1);
6438
6439                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6440                 assert_eq!(events.len(), 1);
6441
6442                 SendEvent::from_event(events.remove(0))
6443         };
6444         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6445         check_added_monitors!(nodes[1], 0);
6446         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6447         expect_pending_htlcs_forwardable!(nodes[1]);
6448
6449         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6450         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6451
6452         // Flush the pending fee update.
6453         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6454         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6455         check_added_monitors!(nodes[2], 1);
6456         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6457         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6458         check_added_monitors!(nodes[1], 2);
6459
6460         // A final RAA message is generated to finalize the fee update.
6461         let events = nodes[1].node.get_and_clear_pending_msg_events();
6462         assert_eq!(events.len(), 1);
6463
6464         let raa_msg = match &events[0] {
6465                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6466                         msg.clone()
6467                 },
6468                 _ => panic!("Unexpected event"),
6469         };
6470
6471         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6472         check_added_monitors!(nodes[2], 1);
6473         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6474
6475         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6476         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6477         assert_eq!(process_htlc_forwards_event.len(), 1);
6478         match &process_htlc_forwards_event[0] {
6479                 &Event::PendingHTLCsForwardable { .. } => {},
6480                 _ => panic!("Unexpected event"),
6481         }
6482
6483         // In response, we call ChannelManager's process_pending_htlc_forwards
6484         nodes[1].node.process_pending_htlc_forwards();
6485         check_added_monitors!(nodes[1], 1);
6486
6487         // This causes the HTLC to be failed backwards.
6488         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6489         assert_eq!(fail_event.len(), 1);
6490         let (fail_msg, commitment_signed) = match &fail_event[0] {
6491                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6492                         assert_eq!(updates.update_add_htlcs.len(), 0);
6493                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6494                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6495                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6496                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6497                 },
6498                 _ => panic!("Unexpected event"),
6499         };
6500
6501         // Pass the failure messages back to nodes[0].
6502         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6503         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6504
6505         // Complete the HTLC failure+removal process.
6506         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6507         check_added_monitors!(nodes[0], 1);
6508         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6509         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6510         check_added_monitors!(nodes[1], 2);
6511         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6512         assert_eq!(final_raa_event.len(), 1);
6513         let raa = match &final_raa_event[0] {
6514                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6515                 _ => panic!("Unexpected event"),
6516         };
6517         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6518         expect_payment_failure_chan_update!(nodes[0], chan_1_2.0.contents.short_channel_id, false);
6519         expect_payment_failed!(nodes[0], our_payment_hash, false);
6520         check_added_monitors!(nodes[0], 1);
6521 }
6522
6523 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6524 // 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.
6525 //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.
6526
6527 #[test]
6528 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6529         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6530         let chanmon_cfgs = create_chanmon_cfgs(2);
6531         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6533         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6534         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6535
6536         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6537         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6538         let logger = test_utils::TestLogger::new();
6539         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();
6540         route.paths[0][0].fee_msat = 100;
6541
6542         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6543                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6544         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6545         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6546 }
6547
6548 #[test]
6549 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6550         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6551         let chanmon_cfgs = create_chanmon_cfgs(2);
6552         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6553         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6554         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6555         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6556         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6557
6558         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6559         let logger = test_utils::TestLogger::new();
6560         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();
6561         route.paths[0][0].fee_msat = 0;
6562         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6563                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6564
6565         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6566         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6567 }
6568
6569 #[test]
6570 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6571         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6572         let chanmon_cfgs = create_chanmon_cfgs(2);
6573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6576         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6577
6578         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6579         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6580         let logger = test_utils::TestLogger::new();
6581         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6582         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6583         check_added_monitors!(nodes[0], 1);
6584         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6585         updates.update_add_htlcs[0].amount_msat = 0;
6586
6587         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6588         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6589         check_closed_broadcast!(nodes[1], true).unwrap();
6590         check_added_monitors!(nodes[1], 1);
6591 }
6592
6593 #[test]
6594 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6595         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6596         //It is enforced when constructing a route.
6597         let chanmon_cfgs = create_chanmon_cfgs(2);
6598         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6599         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6600         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6601         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6602         let logger = test_utils::TestLogger::new();
6603
6604         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6605
6606         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6607         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();
6608         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6609                 assert_eq!(err, &"Channel CLTV overflowed?"));
6610 }
6611
6612 #[test]
6613 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6614         //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.
6615         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6616         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6617         let chanmon_cfgs = create_chanmon_cfgs(2);
6618         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6619         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6620         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6621         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6622         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6623
6624         let logger = test_utils::TestLogger::new();
6625         for i in 0..max_accepted_htlcs {
6626                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6627                 let payment_event = {
6628                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6629                         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();
6630                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6631                         check_added_monitors!(nodes[0], 1);
6632
6633                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6634                         assert_eq!(events.len(), 1);
6635                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6636                                 assert_eq!(htlcs[0].htlc_id, i);
6637                         } else {
6638                                 assert!(false);
6639                         }
6640                         SendEvent::from_event(events.remove(0))
6641                 };
6642                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6643                 check_added_monitors!(nodes[1], 0);
6644                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6645
6646                 expect_pending_htlcs_forwardable!(nodes[1]);
6647                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6648         }
6649         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6650         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6651         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();
6652         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6653                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6654
6655         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6656         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6657 }
6658
6659 #[test]
6660 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6661         //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.
6662         let chanmon_cfgs = create_chanmon_cfgs(2);
6663         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6664         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6665         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6666         let channel_value = 100000;
6667         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6668         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6669
6670         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6671
6672         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6673         // Manually create a route over our max in flight (which our router normally automatically
6674         // limits us to.
6675         let route = Route { paths: vec![vec![RouteHop {
6676            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6677            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6678            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6679         }]] };
6680         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6681                 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)));
6682
6683         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6684         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);
6685
6686         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6687 }
6688
6689 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6690 #[test]
6691 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6692         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6693         let chanmon_cfgs = create_chanmon_cfgs(2);
6694         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6695         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6696         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6697         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6698         let htlc_minimum_msat: u64;
6699         {
6700                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6701                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6702                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6703         }
6704
6705         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6706         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6707         let logger = test_utils::TestLogger::new();
6708         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();
6709         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6710         check_added_monitors!(nodes[0], 1);
6711         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6712         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6713         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6714         assert!(nodes[1].node.list_channels().is_empty());
6715         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6716         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()));
6717         check_added_monitors!(nodes[1], 1);
6718 }
6719
6720 #[test]
6721 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6722         //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
6723         let chanmon_cfgs = create_chanmon_cfgs(2);
6724         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6726         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6727         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6728         let logger = test_utils::TestLogger::new();
6729
6730         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6731         let channel_reserve = chan_stat.channel_reserve_msat;
6732         let feerate = get_feerate!(nodes[0], chan.2);
6733         // The 2* and +1 are for the fee spike reserve.
6734         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6735
6736         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6737         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6738         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6739         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();
6740         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6741         check_added_monitors!(nodes[0], 1);
6742         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6743
6744         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6745         // at this time channel-initiatee receivers are not required to enforce that senders
6746         // respect the fee_spike_reserve.
6747         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6748         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6749
6750         assert!(nodes[1].node.list_channels().is_empty());
6751         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6752         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6753         check_added_monitors!(nodes[1], 1);
6754 }
6755
6756 #[test]
6757 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6758         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6759         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6760         let chanmon_cfgs = create_chanmon_cfgs(2);
6761         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6762         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6763         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6764         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6765         let logger = test_utils::TestLogger::new();
6766
6767         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6768         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6769
6770         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6771         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();
6772
6773         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6774         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6775         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6776         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6777
6778         let mut msg = msgs::UpdateAddHTLC {
6779                 channel_id: chan.2,
6780                 htlc_id: 0,
6781                 amount_msat: 1000,
6782                 payment_hash: our_payment_hash,
6783                 cltv_expiry: htlc_cltv,
6784                 onion_routing_packet: onion_packet.clone(),
6785         };
6786
6787         for i in 0..super::channel::OUR_MAX_HTLCS {
6788                 msg.htlc_id = i as u64;
6789                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6790         }
6791         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6792         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6793
6794         assert!(nodes[1].node.list_channels().is_empty());
6795         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6796         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6797         check_added_monitors!(nodes[1], 1);
6798 }
6799
6800 #[test]
6801 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6802         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6803         let chanmon_cfgs = create_chanmon_cfgs(2);
6804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6806         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6807         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6808         let logger = test_utils::TestLogger::new();
6809
6810         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6811         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6812         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();
6813         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6814         check_added_monitors!(nodes[0], 1);
6815         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6816         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6817         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6818
6819         assert!(nodes[1].node.list_channels().is_empty());
6820         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6821         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6822         check_added_monitors!(nodes[1], 1);
6823 }
6824
6825 #[test]
6826 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6827         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6828         let chanmon_cfgs = create_chanmon_cfgs(2);
6829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6831         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6832         let logger = test_utils::TestLogger::new();
6833
6834         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6835         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6836         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6837         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();
6838         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6839         check_added_monitors!(nodes[0], 1);
6840         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6841         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6842         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6843
6844         assert!(nodes[1].node.list_channels().is_empty());
6845         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6846         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6847         check_added_monitors!(nodes[1], 1);
6848 }
6849
6850 #[test]
6851 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6852         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6853         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6854         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6855         let chanmon_cfgs = create_chanmon_cfgs(2);
6856         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6857         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6858         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6859         let logger = test_utils::TestLogger::new();
6860
6861         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6862         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6863         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6864         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();
6865         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6866         check_added_monitors!(nodes[0], 1);
6867         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6868         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6869
6870         //Disconnect and Reconnect
6871         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6872         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6873         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6874         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6875         assert_eq!(reestablish_1.len(), 1);
6876         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6877         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6878         assert_eq!(reestablish_2.len(), 1);
6879         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6880         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6881         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6882         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6883
6884         //Resend HTLC
6885         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6886         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6887         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6888         check_added_monitors!(nodes[1], 1);
6889         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6890
6891         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6892
6893         assert!(nodes[1].node.list_channels().is_empty());
6894         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6895         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6896         check_added_monitors!(nodes[1], 1);
6897 }
6898
6899 #[test]
6900 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6901         //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.
6902
6903         let chanmon_cfgs = create_chanmon_cfgs(2);
6904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6906         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6907         let logger = test_utils::TestLogger::new();
6908         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6909         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6910         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6911         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();
6912         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6913
6914         check_added_monitors!(nodes[0], 1);
6915         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6916         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6917
6918         let update_msg = msgs::UpdateFulfillHTLC{
6919                 channel_id: chan.2,
6920                 htlc_id: 0,
6921                 payment_preimage: our_payment_preimage,
6922         };
6923
6924         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6925
6926         assert!(nodes[0].node.list_channels().is_empty());
6927         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6928         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()));
6929         check_added_monitors!(nodes[0], 1);
6930 }
6931
6932 #[test]
6933 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6934         //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.
6935
6936         let chanmon_cfgs = create_chanmon_cfgs(2);
6937         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6938         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6939         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6940         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6941         let logger = test_utils::TestLogger::new();
6942
6943         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6944         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6945         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();
6946         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6947         check_added_monitors!(nodes[0], 1);
6948         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6949         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6950
6951         let update_msg = msgs::UpdateFailHTLC{
6952                 channel_id: chan.2,
6953                 htlc_id: 0,
6954                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6955         };
6956
6957         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6958
6959         assert!(nodes[0].node.list_channels().is_empty());
6960         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6961         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()));
6962         check_added_monitors!(nodes[0], 1);
6963 }
6964
6965 #[test]
6966 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6967         //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.
6968
6969         let chanmon_cfgs = create_chanmon_cfgs(2);
6970         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6971         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6972         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6973         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6974         let logger = test_utils::TestLogger::new();
6975
6976         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6977         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6978         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();
6979         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6980         check_added_monitors!(nodes[0], 1);
6981         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6982         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6983         let update_msg = msgs::UpdateFailMalformedHTLC{
6984                 channel_id: chan.2,
6985                 htlc_id: 0,
6986                 sha256_of_onion: [1; 32],
6987                 failure_code: 0x8000,
6988         };
6989
6990         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6991
6992         assert!(nodes[0].node.list_channels().is_empty());
6993         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6994         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()));
6995         check_added_monitors!(nodes[0], 1);
6996 }
6997
6998 #[test]
6999 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7000         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7001
7002         let chanmon_cfgs = create_chanmon_cfgs(2);
7003         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7004         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7005         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7006         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7007
7008         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7009
7010         nodes[1].node.claim_funds(our_payment_preimage);
7011         check_added_monitors!(nodes[1], 1);
7012
7013         let events = nodes[1].node.get_and_clear_pending_msg_events();
7014         assert_eq!(events.len(), 1);
7015         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7016                 match events[0] {
7017                         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, .. } } => {
7018                                 assert!(update_add_htlcs.is_empty());
7019                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7020                                 assert!(update_fail_htlcs.is_empty());
7021                                 assert!(update_fail_malformed_htlcs.is_empty());
7022                                 assert!(update_fee.is_none());
7023                                 update_fulfill_htlcs[0].clone()
7024                         },
7025                         _ => panic!("Unexpected event"),
7026                 }
7027         };
7028
7029         update_fulfill_msg.htlc_id = 1;
7030
7031         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7032
7033         assert!(nodes[0].node.list_channels().is_empty());
7034         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7035         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7036         check_added_monitors!(nodes[0], 1);
7037 }
7038
7039 #[test]
7040 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7041         //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.
7042
7043         let chanmon_cfgs = create_chanmon_cfgs(2);
7044         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7045         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7046         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7047         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7048
7049         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7050
7051         nodes[1].node.claim_funds(our_payment_preimage);
7052         check_added_monitors!(nodes[1], 1);
7053
7054         let events = nodes[1].node.get_and_clear_pending_msg_events();
7055         assert_eq!(events.len(), 1);
7056         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7057                 match events[0] {
7058                         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, .. } } => {
7059                                 assert!(update_add_htlcs.is_empty());
7060                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7061                                 assert!(update_fail_htlcs.is_empty());
7062                                 assert!(update_fail_malformed_htlcs.is_empty());
7063                                 assert!(update_fee.is_none());
7064                                 update_fulfill_htlcs[0].clone()
7065                         },
7066                         _ => panic!("Unexpected event"),
7067                 }
7068         };
7069
7070         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7071
7072         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7073
7074         assert!(nodes[0].node.list_channels().is_empty());
7075         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7076         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7077         check_added_monitors!(nodes[0], 1);
7078 }
7079
7080 #[test]
7081 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7082         //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.
7083
7084         let chanmon_cfgs = create_chanmon_cfgs(2);
7085         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7086         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7087         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7088         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7089         let logger = test_utils::TestLogger::new();
7090
7091         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7092         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7093         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7094         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7095         check_added_monitors!(nodes[0], 1);
7096
7097         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7098         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7099
7100         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7101         check_added_monitors!(nodes[1], 0);
7102         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7103
7104         let events = nodes[1].node.get_and_clear_pending_msg_events();
7105
7106         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7107                 match events[0] {
7108                         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, .. } } => {
7109                                 assert!(update_add_htlcs.is_empty());
7110                                 assert!(update_fulfill_htlcs.is_empty());
7111                                 assert!(update_fail_htlcs.is_empty());
7112                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7113                                 assert!(update_fee.is_none());
7114                                 update_fail_malformed_htlcs[0].clone()
7115                         },
7116                         _ => panic!("Unexpected event"),
7117                 }
7118         };
7119         update_msg.failure_code &= !0x8000;
7120         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7121
7122         assert!(nodes[0].node.list_channels().is_empty());
7123         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7124         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7125         check_added_monitors!(nodes[0], 1);
7126 }
7127
7128 #[test]
7129 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7130         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7131         //    * 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.
7132
7133         let chanmon_cfgs = create_chanmon_cfgs(3);
7134         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7135         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7136         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7137         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7138         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7139         let logger = test_utils::TestLogger::new();
7140
7141         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7142
7143         //First hop
7144         let mut payment_event = {
7145                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7146                 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();
7147                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7148                 check_added_monitors!(nodes[0], 1);
7149                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7150                 assert_eq!(events.len(), 1);
7151                 SendEvent::from_event(events.remove(0))
7152         };
7153         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7154         check_added_monitors!(nodes[1], 0);
7155         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7156         expect_pending_htlcs_forwardable!(nodes[1]);
7157         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7158         assert_eq!(events_2.len(), 1);
7159         check_added_monitors!(nodes[1], 1);
7160         payment_event = SendEvent::from_event(events_2.remove(0));
7161         assert_eq!(payment_event.msgs.len(), 1);
7162
7163         //Second Hop
7164         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7165         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7166         check_added_monitors!(nodes[2], 0);
7167         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7168
7169         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7170         assert_eq!(events_3.len(), 1);
7171         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7172                 match events_3[0] {
7173                         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 } } => {
7174                                 assert!(update_add_htlcs.is_empty());
7175                                 assert!(update_fulfill_htlcs.is_empty());
7176                                 assert!(update_fail_htlcs.is_empty());
7177                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7178                                 assert!(update_fee.is_none());
7179                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7180                         },
7181                         _ => panic!("Unexpected event"),
7182                 }
7183         };
7184
7185         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7186
7187         check_added_monitors!(nodes[1], 0);
7188         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7189         expect_pending_htlcs_forwardable!(nodes[1]);
7190         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7191         assert_eq!(events_4.len(), 1);
7192
7193         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7194         match events_4[0] {
7195                 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, .. } } => {
7196                         assert!(update_add_htlcs.is_empty());
7197                         assert!(update_fulfill_htlcs.is_empty());
7198                         assert_eq!(update_fail_htlcs.len(), 1);
7199                         assert!(update_fail_malformed_htlcs.is_empty());
7200                         assert!(update_fee.is_none());
7201                 },
7202                 _ => panic!("Unexpected event"),
7203         };
7204
7205         check_added_monitors!(nodes[1], 1);
7206 }
7207
7208 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7209         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7210         // 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
7211         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7212
7213         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7214         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7215         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7216         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7217         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7218         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7219
7220         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7221
7222         // We route 2 dust-HTLCs between A and B
7223         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7224         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7225         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7226
7227         // Cache one local commitment tx as previous
7228         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7229
7230         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7231         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7232         check_added_monitors!(nodes[1], 0);
7233         expect_pending_htlcs_forwardable!(nodes[1]);
7234         check_added_monitors!(nodes[1], 1);
7235
7236         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7237         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7238         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7239         check_added_monitors!(nodes[0], 1);
7240
7241         // Cache one local commitment tx as lastest
7242         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7243
7244         let events = nodes[0].node.get_and_clear_pending_msg_events();
7245         match events[0] {
7246                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7247                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7248                 },
7249                 _ => panic!("Unexpected event"),
7250         }
7251         match events[1] {
7252                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7253                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7254                 },
7255                 _ => panic!("Unexpected event"),
7256         }
7257
7258         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7259         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7260         if announce_latest {
7261                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7262         } else {
7263                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7264         }
7265
7266         check_closed_broadcast!(nodes[0], true);
7267         check_added_monitors!(nodes[0], 1);
7268
7269         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7270         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7271         let events = nodes[0].node.get_and_clear_pending_events();
7272         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7273         assert_eq!(events.len(), 2);
7274         let mut first_failed = false;
7275         for event in events {
7276                 match event {
7277                         Event::PaymentFailed { payment_hash, .. } => {
7278                                 if payment_hash == payment_hash_1 {
7279                                         assert!(!first_failed);
7280                                         first_failed = true;
7281                                 } else {
7282                                         assert_eq!(payment_hash, payment_hash_2);
7283                                 }
7284                         }
7285                         _ => panic!("Unexpected event"),
7286                 }
7287         }
7288 }
7289
7290 #[test]
7291 fn test_failure_delay_dust_htlc_local_commitment() {
7292         do_test_failure_delay_dust_htlc_local_commitment(true);
7293         do_test_failure_delay_dust_htlc_local_commitment(false);
7294 }
7295
7296 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7297         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7298         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7299         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7300         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7301         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7302         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7303
7304         let chanmon_cfgs = create_chanmon_cfgs(3);
7305         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7306         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7307         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7308         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7309
7310         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7311
7312         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7313         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7314
7315         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7316         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7317
7318         // We revoked bs_commitment_tx
7319         if revoked {
7320                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7321                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7322         }
7323
7324         let mut timeout_tx = Vec::new();
7325         if local {
7326                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7327                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7328                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7329                 expect_payment_failed!(nodes[0], dust_hash, true);
7330
7331                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7332                 check_closed_broadcast!(nodes[0], true);
7333                 check_added_monitors!(nodes[0], 1);
7334                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7335                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7336                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7337                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7338                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7339                 mine_transaction(&nodes[0], &timeout_tx[0]);
7340                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7341                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7342         } else {
7343                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7344                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7345                 check_closed_broadcast!(nodes[0], true);
7346                 check_added_monitors!(nodes[0], 1);
7347                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7348                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7349                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7350                 if !revoked {
7351                         expect_payment_failed!(nodes[0], dust_hash, true);
7352                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7353                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7354                         mine_transaction(&nodes[0], &timeout_tx[0]);
7355                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7356                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7357                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7358                 } else {
7359                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7360                         // commitment tx
7361                         let events = nodes[0].node.get_and_clear_pending_events();
7362                         assert_eq!(events.len(), 2);
7363                         let first;
7364                         match events[0] {
7365                                 Event::PaymentFailed { payment_hash, .. } => {
7366                                         if payment_hash == dust_hash { first = true; }
7367                                         else { first = false; }
7368                                 },
7369                                 _ => panic!("Unexpected event"),
7370                         }
7371                         match events[1] {
7372                                 Event::PaymentFailed { payment_hash, .. } => {
7373                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7374                                         else { assert_eq!(payment_hash, dust_hash); }
7375                                 },
7376                                 _ => panic!("Unexpected event"),
7377                         }
7378                 }
7379         }
7380 }
7381
7382 #[test]
7383 fn test_sweep_outbound_htlc_failure_update() {
7384         do_test_sweep_outbound_htlc_failure_update(false, true);
7385         do_test_sweep_outbound_htlc_failure_update(false, false);
7386         do_test_sweep_outbound_htlc_failure_update(true, false);
7387 }
7388
7389 #[test]
7390 fn test_upfront_shutdown_script() {
7391         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7392         // enforce it at shutdown message
7393
7394         let mut config = UserConfig::default();
7395         config.channel_options.announced_channel = true;
7396         config.peer_channel_config_limits.force_announced_channel_preference = false;
7397         config.channel_options.commit_upfront_shutdown_pubkey = false;
7398         let user_cfgs = [None, Some(config), None];
7399         let chanmon_cfgs = create_chanmon_cfgs(3);
7400         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7401         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7402         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7403
7404         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7405         let flags = InitFeatures::known();
7406         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7407         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7408         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7409         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7410         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7411         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7412     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()));
7413         check_added_monitors!(nodes[2], 1);
7414
7415         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7416         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7417         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7418         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7419         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7420         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7421         let events = nodes[2].node.get_and_clear_pending_msg_events();
7422         assert_eq!(events.len(), 1);
7423         match events[0] {
7424                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7425                 _ => panic!("Unexpected event"),
7426         }
7427
7428         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7429         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7430         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7431         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7432         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7433         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7434         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7435         let events = nodes[1].node.get_and_clear_pending_msg_events();
7436         assert_eq!(events.len(), 1);
7437         match events[0] {
7438                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7439                 _ => panic!("Unexpected event"),
7440         }
7441
7442         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7443         // channel smoothly, opt-out is from channel initiator here
7444         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7445         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7446         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7447         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7448         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7449         let events = nodes[0].node.get_and_clear_pending_msg_events();
7450         assert_eq!(events.len(), 1);
7451         match events[0] {
7452                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7453                 _ => panic!("Unexpected event"),
7454         }
7455
7456         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7457         //// channel smoothly
7458         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7459         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7460         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7461         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7462         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7463         let events = nodes[0].node.get_and_clear_pending_msg_events();
7464         assert_eq!(events.len(), 2);
7465         match events[0] {
7466                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7467                 _ => panic!("Unexpected event"),
7468         }
7469         match events[1] {
7470                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7471                 _ => panic!("Unexpected event"),
7472         }
7473 }
7474
7475 #[test]
7476 fn test_upfront_shutdown_script_unsupport_segwit() {
7477         // We test that channel is closed early
7478         // if a segwit program is passed as upfront shutdown script,
7479         // but the peer does not support segwit.
7480         let chanmon_cfgs = create_chanmon_cfgs(2);
7481         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7482         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7483         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7484
7485         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7486
7487         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7488         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7489                 .push_slice(&[0, 0])
7490                 .into_script());
7491
7492         let features = InitFeatures::known().clear_shutdown_anysegwit();
7493         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7494
7495         let events = nodes[0].node.get_and_clear_pending_msg_events();
7496         assert_eq!(events.len(), 1);
7497         match events[0] {
7498                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7499                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7500                         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));
7501                 },
7502                 _ => panic!("Unexpected event"),
7503         }
7504 }
7505
7506 #[test]
7507 fn test_shutdown_script_any_segwit_allowed() {
7508         let mut config = UserConfig::default();
7509         config.channel_options.announced_channel = true;
7510         config.peer_channel_config_limits.force_announced_channel_preference = false;
7511         config.channel_options.commit_upfront_shutdown_pubkey = false;
7512         let user_cfgs = [None, Some(config), None];
7513         let chanmon_cfgs = create_chanmon_cfgs(3);
7514         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7515         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7516         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7517
7518         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7519         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7520         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7521         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7522         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7523                 .push_slice(&[0, 0])
7524                 .into_script();
7525         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7526         let events = nodes[0].node.get_and_clear_pending_msg_events();
7527         assert_eq!(events.len(), 2);
7528         match events[0] {
7529                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7530                 _ => panic!("Unexpected event"),
7531         }
7532         match events[1] {
7533                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7534                 _ => panic!("Unexpected event"),
7535         }
7536 }
7537
7538 #[test]
7539 fn test_shutdown_script_any_segwit_not_allowed() {
7540         let mut config = UserConfig::default();
7541         config.channel_options.announced_channel = true;
7542         config.peer_channel_config_limits.force_announced_channel_preference = false;
7543         config.channel_options.commit_upfront_shutdown_pubkey = false;
7544         let user_cfgs = [None, Some(config), None];
7545         let chanmon_cfgs = create_chanmon_cfgs(3);
7546         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7547         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7548         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7549
7550         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7551         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7552         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7553         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7554         // Make an any segwit version script
7555         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7556                 .push_slice(&[0, 0])
7557                 .into_script();
7558         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7559         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7560         let events = nodes[0].node.get_and_clear_pending_msg_events();
7561         assert_eq!(events.len(), 2);
7562         match events[1] {
7563                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7564                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7565                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7566                 },
7567                 _ => panic!("Unexpected event"),
7568         }
7569         check_added_monitors!(nodes[0], 1);
7570 }
7571
7572 #[test]
7573 fn test_shutdown_script_segwit_but_not_anysegwit() {
7574         let mut config = UserConfig::default();
7575         config.channel_options.announced_channel = true;
7576         config.peer_channel_config_limits.force_announced_channel_preference = false;
7577         config.channel_options.commit_upfront_shutdown_pubkey = false;
7578         let user_cfgs = [None, Some(config), None];
7579         let chanmon_cfgs = create_chanmon_cfgs(3);
7580         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7581         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7582         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7583
7584         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7585         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7586         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7587         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7588         // Make a segwit script that is not a valid as any segwit
7589         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7590                 .push_slice(&[0, 0])
7591                 .into_script();
7592         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7593         let events = nodes[0].node.get_and_clear_pending_msg_events();
7594         assert_eq!(events.len(), 2);
7595         match events[1] {
7596                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7597                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7598                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7599                 },
7600                 _ => panic!("Unexpected event"),
7601         }
7602         check_added_monitors!(nodes[0], 1);
7603 }
7604
7605 #[test]
7606 fn test_user_configurable_csv_delay() {
7607         // We test our channel constructors yield errors when we pass them absurd csv delay
7608
7609         let mut low_our_to_self_config = UserConfig::default();
7610         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7611         let mut high_their_to_self_config = UserConfig::default();
7612         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7613         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7614         let chanmon_cfgs = create_chanmon_cfgs(2);
7615         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7616         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7617         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7618
7619         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7620         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7621                 match error {
7622                         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())); },
7623                         _ => panic!("Unexpected event"),
7624                 }
7625         } else { assert!(false) }
7626
7627         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7628         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7629         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7630         open_channel.to_self_delay = 200;
7631         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7632                 match error {
7633                         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()));  },
7634                         _ => panic!("Unexpected event"),
7635                 }
7636         } else { assert!(false); }
7637
7638         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7639         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7640         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()));
7641         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7642         accept_channel.to_self_delay = 200;
7643         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7644         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7645                 match action {
7646                         &ErrorAction::SendErrorMessage { ref msg } => {
7647                                 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()));
7648                         },
7649                         _ => { assert!(false); }
7650                 }
7651         } else { assert!(false); }
7652
7653         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7654         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7655         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7656         open_channel.to_self_delay = 200;
7657         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7658                 match error {
7659                         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())); },
7660                         _ => panic!("Unexpected event"),
7661                 }
7662         } else { assert!(false); }
7663 }
7664
7665 #[test]
7666 fn test_data_loss_protect() {
7667         // We want to be sure that :
7668         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7669         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7670         // * we close channel in case of detecting other being fallen behind
7671         // * we are able to claim our own outputs thanks to to_remote being static
7672         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7673         let persister;
7674         let logger;
7675         let fee_estimator;
7676         let tx_broadcaster;
7677         let chain_source;
7678         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7679         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7680         // during signing due to revoked tx
7681         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7682         let keys_manager = &chanmon_cfgs[0].keys_manager;
7683         let monitor;
7684         let node_state_0;
7685         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7686         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7687         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7688
7689         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7690
7691         // Cache node A state before any channel update
7692         let previous_node_state = nodes[0].node.encode();
7693         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7694         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7695
7696         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7697         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7698
7699         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7700         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7701
7702         // Restore node A from previous state
7703         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7704         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7705         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7706         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7707         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7708         persister = test_utils::TestPersister::new();
7709         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7710         node_state_0 = {
7711                 let mut channel_monitors = HashMap::new();
7712                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7713                 <(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 {
7714                         keys_manager: keys_manager,
7715                         fee_estimator: &fee_estimator,
7716                         chain_monitor: &monitor,
7717                         logger: &logger,
7718                         tx_broadcaster: &tx_broadcaster,
7719                         default_config: UserConfig::default(),
7720                         channel_monitors,
7721                 }).unwrap().1
7722         };
7723         nodes[0].node = &node_state_0;
7724         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7725         nodes[0].chain_monitor = &monitor;
7726         nodes[0].chain_source = &chain_source;
7727
7728         check_added_monitors!(nodes[0], 1);
7729
7730         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7731         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7732
7733         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7734
7735         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7736         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7737         check_added_monitors!(nodes[0], 1);
7738
7739         {
7740                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7741                 assert_eq!(node_txn.len(), 0);
7742         }
7743
7744         let mut reestablish_1 = Vec::with_capacity(1);
7745         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7746                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7747                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7748                         reestablish_1.push(msg.clone());
7749                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7750                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7751                         match action {
7752                                 &ErrorAction::SendErrorMessage { ref msg } => {
7753                                         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");
7754                                 },
7755                                 _ => panic!("Unexpected event!"),
7756                         }
7757                 } else {
7758                         panic!("Unexpected event")
7759                 }
7760         }
7761
7762         // Check we close channel detecting A is fallen-behind
7763         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7764         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7765         check_added_monitors!(nodes[1], 1);
7766
7767
7768         // Check A is able to claim to_remote output
7769         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7770         assert_eq!(node_txn.len(), 1);
7771         check_spends!(node_txn[0], chan.3);
7772         assert_eq!(node_txn[0].output.len(), 2);
7773         mine_transaction(&nodes[0], &node_txn[0]);
7774         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7775         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7776         assert_eq!(spend_txn.len(), 1);
7777         check_spends!(spend_txn[0], node_txn[0]);
7778 }
7779
7780 #[test]
7781 fn test_check_htlc_underpaying() {
7782         // Send payment through A -> B but A is maliciously
7783         // sending a probe payment (i.e less than expected value0
7784         // to B, B should refuse payment.
7785
7786         let chanmon_cfgs = create_chanmon_cfgs(2);
7787         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7788         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7789         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7790
7791         // Create some initial channels
7792         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7793
7794         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();
7795         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7796         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7797         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7798         check_added_monitors!(nodes[0], 1);
7799
7800         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7801         assert_eq!(events.len(), 1);
7802         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7803         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7804         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7805
7806         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7807         // and then will wait a second random delay before failing the HTLC back:
7808         expect_pending_htlcs_forwardable!(nodes[1]);
7809         expect_pending_htlcs_forwardable!(nodes[1]);
7810
7811         // Node 3 is expecting payment of 100_000 but received 10_000,
7812         // it should fail htlc like we didn't know the preimage.
7813         nodes[1].node.process_pending_htlc_forwards();
7814
7815         let events = nodes[1].node.get_and_clear_pending_msg_events();
7816         assert_eq!(events.len(), 1);
7817         let (update_fail_htlc, commitment_signed) = match events[0] {
7818                 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 } } => {
7819                         assert!(update_add_htlcs.is_empty());
7820                         assert!(update_fulfill_htlcs.is_empty());
7821                         assert_eq!(update_fail_htlcs.len(), 1);
7822                         assert!(update_fail_malformed_htlcs.is_empty());
7823                         assert!(update_fee.is_none());
7824                         (update_fail_htlcs[0].clone(), commitment_signed)
7825                 },
7826                 _ => panic!("Unexpected event"),
7827         };
7828         check_added_monitors!(nodes[1], 1);
7829
7830         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7831         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7832
7833         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7834         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7835         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7836         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7837 }
7838
7839 #[test]
7840 fn test_announce_disable_channels() {
7841         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7842         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7843
7844         let chanmon_cfgs = create_chanmon_cfgs(2);
7845         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7846         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7847         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7848
7849         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7850         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7851         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7852
7853         // Disconnect peers
7854         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7855         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7856
7857         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7858         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7859         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7860         assert_eq!(msg_events.len(), 3);
7861         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7862         for e in msg_events {
7863                 match e {
7864                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7865                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7866                                 // Check that each channel gets updated exactly once
7867                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7868                                         panic!("Generated ChannelUpdate for wrong chan!");
7869                                 }
7870                         },
7871                         _ => panic!("Unexpected event"),
7872                 }
7873         }
7874         // Reconnect peers
7875         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7876         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7877         assert_eq!(reestablish_1.len(), 3);
7878         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7879         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7880         assert_eq!(reestablish_2.len(), 3);
7881
7882         // Reestablish chan_1
7883         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7884         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7885         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7886         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7887         // Reestablish chan_2
7888         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7889         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7890         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7891         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7892         // Reestablish chan_3
7893         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7894         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7895         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7896         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7897
7898         nodes[0].node.timer_tick_occurred();
7899         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7900         nodes[0].node.timer_tick_occurred();
7901         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7902         assert_eq!(msg_events.len(), 3);
7903         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7904         for e in msg_events {
7905                 match e {
7906                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7907                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7908                                 // Check that each channel gets updated exactly once
7909                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7910                                         panic!("Generated ChannelUpdate for wrong chan!");
7911                                 }
7912                         },
7913                         _ => panic!("Unexpected event"),
7914                 }
7915         }
7916 }
7917
7918 #[test]
7919 fn test_bump_penalty_txn_on_revoked_commitment() {
7920         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7921         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7922
7923         let chanmon_cfgs = create_chanmon_cfgs(2);
7924         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7925         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7926         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7927
7928         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7929         let logger = test_utils::TestLogger::new();
7930
7931         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7932         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7933         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();
7934         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7935
7936         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7937         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7938         assert_eq!(revoked_txn[0].output.len(), 4);
7939         assert_eq!(revoked_txn[0].input.len(), 1);
7940         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7941         let revoked_txid = revoked_txn[0].txid();
7942
7943         let mut penalty_sum = 0;
7944         for outp in revoked_txn[0].output.iter() {
7945                 if outp.script_pubkey.is_v0_p2wsh() {
7946                         penalty_sum += outp.value;
7947                 }
7948         }
7949
7950         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7951         let header_114 = connect_blocks(&nodes[1], 14);
7952
7953         // Actually revoke tx by claiming a HTLC
7954         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7955         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7956         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7957         check_added_monitors!(nodes[1], 1);
7958
7959         // One or more justice tx should have been broadcast, check it
7960         let penalty_1;
7961         let feerate_1;
7962         {
7963                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7964                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7965                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7966                 assert_eq!(node_txn[0].output.len(), 1);
7967                 check_spends!(node_txn[0], revoked_txn[0]);
7968                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7969                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7970                 penalty_1 = node_txn[0].txid();
7971                 node_txn.clear();
7972         };
7973
7974         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7975         connect_blocks(&nodes[1], 15);
7976         let mut penalty_2 = penalty_1;
7977         let mut feerate_2 = 0;
7978         {
7979                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7980                 assert_eq!(node_txn.len(), 1);
7981                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7982                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7983                         assert_eq!(node_txn[0].output.len(), 1);
7984                         check_spends!(node_txn[0], revoked_txn[0]);
7985                         penalty_2 = node_txn[0].txid();
7986                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7987                         assert_ne!(penalty_2, penalty_1);
7988                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7989                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7990                         // Verify 25% bump heuristic
7991                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7992                         node_txn.clear();
7993                 }
7994         }
7995         assert_ne!(feerate_2, 0);
7996
7997         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7998         connect_blocks(&nodes[1], 1);
7999         let penalty_3;
8000         let mut feerate_3 = 0;
8001         {
8002                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8003                 assert_eq!(node_txn.len(), 1);
8004                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8005                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8006                         assert_eq!(node_txn[0].output.len(), 1);
8007                         check_spends!(node_txn[0], revoked_txn[0]);
8008                         penalty_3 = node_txn[0].txid();
8009                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8010                         assert_ne!(penalty_3, penalty_2);
8011                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8012                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8013                         // Verify 25% bump heuristic
8014                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8015                         node_txn.clear();
8016                 }
8017         }
8018         assert_ne!(feerate_3, 0);
8019
8020         nodes[1].node.get_and_clear_pending_events();
8021         nodes[1].node.get_and_clear_pending_msg_events();
8022 }
8023
8024 #[test]
8025 fn test_bump_penalty_txn_on_revoked_htlcs() {
8026         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8027         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8028
8029         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8030         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8031         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8033         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8034
8035         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8036         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8037         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
8038                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8039         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8040         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph.read().unwrap(),
8041                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8042         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8043
8044         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8045         assert_eq!(revoked_local_txn[0].input.len(), 1);
8046         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8047
8048         // Revoke local commitment tx
8049         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8050
8051         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8052         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8053         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8054         check_closed_broadcast!(nodes[1], true);
8055         check_added_monitors!(nodes[1], 1);
8056         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8057
8058         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8059         assert_eq!(revoked_htlc_txn.len(), 3);
8060         check_spends!(revoked_htlc_txn[1], chan.3);
8061
8062         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8063         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8064         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8065
8066         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8067         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8068         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8069         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8070
8071         // Broadcast set of revoked txn on A
8072         let hash_128 = connect_blocks(&nodes[0], 40);
8073         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8074         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8075         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8076         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8077         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8078         let first;
8079         let feerate_1;
8080         let penalty_txn;
8081         {
8082                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8083                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8084                 // Verify claim tx are spending revoked HTLC txn
8085
8086                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8087                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8088                 // which are included in the same block (they are broadcasted because we scan the
8089                 // transactions linearly and generate claims as we go, they likely should be removed in the
8090                 // future).
8091                 assert_eq!(node_txn[0].input.len(), 1);
8092                 check_spends!(node_txn[0], revoked_local_txn[0]);
8093                 assert_eq!(node_txn[1].input.len(), 1);
8094                 check_spends!(node_txn[1], revoked_local_txn[0]);
8095                 assert_eq!(node_txn[2].input.len(), 1);
8096                 check_spends!(node_txn[2], revoked_local_txn[0]);
8097
8098                 // Each of the three justice transactions claim a separate (single) output of the three
8099                 // available, which we check here:
8100                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8101                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8102                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8103
8104                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8105                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8106
8107                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8108                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8109                 // a remote commitment tx has already been confirmed).
8110                 check_spends!(node_txn[3], chan.3);
8111
8112                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8113                 // output, checked above).
8114                 assert_eq!(node_txn[4].input.len(), 2);
8115                 assert_eq!(node_txn[4].output.len(), 1);
8116                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8117
8118                 first = node_txn[4].txid();
8119                 // Store both feerates for later comparison
8120                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8121                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8122                 penalty_txn = vec![node_txn[2].clone()];
8123                 node_txn.clear();
8124         }
8125
8126         // Connect one more block to see if bumped penalty are issued for HTLC txn
8127         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8128         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8129         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8130         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8131         {
8132                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8133                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8134
8135                 check_spends!(node_txn[0], revoked_local_txn[0]);
8136                 check_spends!(node_txn[1], revoked_local_txn[0]);
8137                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8138                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8139                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8140                 } else {
8141                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8142                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8143                 }
8144
8145                 node_txn.clear();
8146         };
8147
8148         // Few more blocks to confirm penalty txn
8149         connect_blocks(&nodes[0], 4);
8150         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8151         let header_144 = connect_blocks(&nodes[0], 9);
8152         let node_txn = {
8153                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8154                 assert_eq!(node_txn.len(), 1);
8155
8156                 assert_eq!(node_txn[0].input.len(), 2);
8157                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8158                 // Verify bumped tx is different and 25% bump heuristic
8159                 assert_ne!(first, node_txn[0].txid());
8160                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8161                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8162                 assert!(feerate_2 * 100 > feerate_1 * 125);
8163                 let txn = vec![node_txn[0].clone()];
8164                 node_txn.clear();
8165                 txn
8166         };
8167         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8168         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8169         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8170         connect_blocks(&nodes[0], 20);
8171         {
8172                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8173                 // We verify than no new transaction has been broadcast because previously
8174                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8175                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8176                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8177                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8178                 // up bumped justice generation.
8179                 assert_eq!(node_txn.len(), 0);
8180                 node_txn.clear();
8181         }
8182         check_closed_broadcast!(nodes[0], true);
8183         check_added_monitors!(nodes[0], 1);
8184 }
8185
8186 #[test]
8187 fn test_bump_penalty_txn_on_remote_commitment() {
8188         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8189         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8190
8191         // Create 2 HTLCs
8192         // Provide preimage for one
8193         // Check aggregation
8194
8195         let chanmon_cfgs = create_chanmon_cfgs(2);
8196         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8197         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8198         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8199
8200         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8201         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8202         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8203
8204         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8205         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8206         assert_eq!(remote_txn[0].output.len(), 4);
8207         assert_eq!(remote_txn[0].input.len(), 1);
8208         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8209
8210         // Claim a HTLC without revocation (provide B monitor with preimage)
8211         nodes[1].node.claim_funds(payment_preimage);
8212         mine_transaction(&nodes[1], &remote_txn[0]);
8213         check_added_monitors!(nodes[1], 2);
8214         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8215
8216         // One or more claim tx should have been broadcast, check it
8217         let timeout;
8218         let preimage;
8219         let preimage_bump;
8220         let feerate_timeout;
8221         let feerate_preimage;
8222         {
8223                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8224                 // 9 transactions including:
8225                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8226                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8227                 // 2 * HTLC-Success (one RBF bump we'll check later)
8228                 // 1 * HTLC-Timeout
8229                 assert_eq!(node_txn.len(), 8);
8230                 assert_eq!(node_txn[0].input.len(), 1);
8231                 assert_eq!(node_txn[6].input.len(), 1);
8232                 check_spends!(node_txn[0], remote_txn[0]);
8233                 check_spends!(node_txn[6], remote_txn[0]);
8234                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8235                 preimage_bump = node_txn[3].clone();
8236
8237                 check_spends!(node_txn[1], chan.3);
8238                 check_spends!(node_txn[2], node_txn[1]);
8239                 assert_eq!(node_txn[1], node_txn[4]);
8240                 assert_eq!(node_txn[2], node_txn[5]);
8241
8242                 timeout = node_txn[6].txid();
8243                 let index = node_txn[6].input[0].previous_output.vout;
8244                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8245                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8246
8247                 preimage = node_txn[0].txid();
8248                 let index = node_txn[0].input[0].previous_output.vout;
8249                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8250                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8251
8252                 node_txn.clear();
8253         };
8254         assert_ne!(feerate_timeout, 0);
8255         assert_ne!(feerate_preimage, 0);
8256
8257         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8258         connect_blocks(&nodes[1], 15);
8259         {
8260                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8261                 assert_eq!(node_txn.len(), 1);
8262                 assert_eq!(node_txn[0].input.len(), 1);
8263                 assert_eq!(preimage_bump.input.len(), 1);
8264                 check_spends!(node_txn[0], remote_txn[0]);
8265                 check_spends!(preimage_bump, remote_txn[0]);
8266
8267                 let index = preimage_bump.input[0].previous_output.vout;
8268                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8269                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8270                 assert!(new_feerate * 100 > feerate_timeout * 125);
8271                 assert_ne!(timeout, preimage_bump.txid());
8272
8273                 let index = node_txn[0].input[0].previous_output.vout;
8274                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8275                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8276                 assert!(new_feerate * 100 > feerate_preimage * 125);
8277                 assert_ne!(preimage, node_txn[0].txid());
8278
8279                 node_txn.clear();
8280         }
8281
8282         nodes[1].node.get_and_clear_pending_events();
8283         nodes[1].node.get_and_clear_pending_msg_events();
8284 }
8285
8286 #[test]
8287 fn test_counterparty_raa_skip_no_crash() {
8288         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8289         // commitment transaction, we would have happily carried on and provided them the next
8290         // commitment transaction based on one RAA forward. This would probably eventually have led to
8291         // channel closure, but it would not have resulted in funds loss. Still, our
8292         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8293         // check simply that the channel is closed in response to such an RAA, but don't check whether
8294         // we decide to punish our counterparty for revoking their funds (as we don't currently
8295         // implement that).
8296         let chanmon_cfgs = create_chanmon_cfgs(2);
8297         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8298         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8299         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8300         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8301
8302         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8303         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8304         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8305         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8306         // Must revoke without gaps
8307         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8308         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8309                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8310
8311         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8312                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8313         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8314         check_added_monitors!(nodes[1], 1);
8315 }
8316
8317 #[test]
8318 fn test_bump_txn_sanitize_tracking_maps() {
8319         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8320         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8321
8322         let chanmon_cfgs = create_chanmon_cfgs(2);
8323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8325         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8326
8327         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8328         // Lock HTLC in both directions
8329         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8330         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8331
8332         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8333         assert_eq!(revoked_local_txn[0].input.len(), 1);
8334         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8335
8336         // Revoke local commitment tx
8337         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8338
8339         // Broadcast set of revoked txn on A
8340         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8341         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8342         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8343
8344         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8345         check_closed_broadcast!(nodes[0], true);
8346         check_added_monitors!(nodes[0], 1);
8347         let penalty_txn = {
8348                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8349                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8350                 check_spends!(node_txn[0], revoked_local_txn[0]);
8351                 check_spends!(node_txn[1], revoked_local_txn[0]);
8352                 check_spends!(node_txn[2], revoked_local_txn[0]);
8353                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8354                 node_txn.clear();
8355                 penalty_txn
8356         };
8357         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8358         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8359         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8360         {
8361                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8362                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8363                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8364                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8365                 }
8366         }
8367 }
8368
8369 #[test]
8370 fn test_override_channel_config() {
8371         let chanmon_cfgs = create_chanmon_cfgs(2);
8372         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8373         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8374         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8375
8376         // Node0 initiates a channel to node1 using the override config.
8377         let mut override_config = UserConfig::default();
8378         override_config.own_channel_config.our_to_self_delay = 200;
8379
8380         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8381
8382         // Assert the channel created by node0 is using the override config.
8383         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8384         assert_eq!(res.channel_flags, 0);
8385         assert_eq!(res.to_self_delay, 200);
8386 }
8387
8388 #[test]
8389 fn test_override_0msat_htlc_minimum() {
8390         let mut zero_config = UserConfig::default();
8391         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8392         let chanmon_cfgs = create_chanmon_cfgs(2);
8393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8396
8397         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8398         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8399         assert_eq!(res.htlc_minimum_msat, 1);
8400
8401         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8402         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8403         assert_eq!(res.htlc_minimum_msat, 1);
8404 }
8405
8406 #[test]
8407 fn test_simple_mpp() {
8408         // Simple test of sending a multi-path payment.
8409         let chanmon_cfgs = create_chanmon_cfgs(4);
8410         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8411         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8412         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8413
8414         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8415         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8416         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8417         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8418         let logger = test_utils::TestLogger::new();
8419
8420         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8421         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8422         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();
8423         let path = route.paths[0].clone();
8424         route.paths.push(path);
8425         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8426         route.paths[0][0].short_channel_id = chan_1_id;
8427         route.paths[0][1].short_channel_id = chan_3_id;
8428         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8429         route.paths[1][0].short_channel_id = chan_2_id;
8430         route.paths[1][1].short_channel_id = chan_4_id;
8431         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8432         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8433 }
8434
8435 #[test]
8436 fn test_preimage_storage() {
8437         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8438         let chanmon_cfgs = create_chanmon_cfgs(2);
8439         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8440         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8441         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8442
8443         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8444
8445         {
8446                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8447
8448                 let logger = test_utils::TestLogger::new();
8449                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8450                 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();
8451                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8452                 check_added_monitors!(nodes[0], 1);
8453                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8454                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8455                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8456                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8457         }
8458         // Note that after leaving the above scope we have no knowledge of any arguments or return
8459         // values from previous calls.
8460         expect_pending_htlcs_forwardable!(nodes[1]);
8461         let events = nodes[1].node.get_and_clear_pending_events();
8462         assert_eq!(events.len(), 1);
8463         match events[0] {
8464                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8465                         assert_eq!(user_payment_id, 42);
8466                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8467                 },
8468                 _ => panic!("Unexpected event"),
8469         }
8470 }
8471
8472 #[test]
8473 fn test_secret_timeout() {
8474         // Simple test of payment secret storage time outs
8475         let chanmon_cfgs = create_chanmon_cfgs(2);
8476         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8477         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8478         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8479
8480         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8481
8482         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8483
8484         // We should fail to register the same payment hash twice, at least until we've connected a
8485         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8486         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8487                 assert_eq!(err, "Duplicate payment hash");
8488         } else { panic!(); }
8489         let mut block = {
8490                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8491                 Block {
8492                         header: BlockHeader {
8493                                 version: 0x2000000,
8494                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8495                                 merkle_root: Default::default(),
8496                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8497                         txdata: vec![],
8498                 }
8499         };
8500         connect_block(&nodes[1], &block);
8501         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8502                 assert_eq!(err, "Duplicate payment hash");
8503         } else { panic!(); }
8504
8505         // If we then connect the second block, we should be able to register the same payment hash
8506         // again with a different user_payment_id (this time getting a new payment secret).
8507         block.header.prev_blockhash = block.header.block_hash();
8508         block.header.time += 1;
8509         connect_block(&nodes[1], &block);
8510         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8511         assert_ne!(payment_secret_1, our_payment_secret);
8512
8513         {
8514                 let logger = test_utils::TestLogger::new();
8515                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8516                 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();
8517                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8518                 check_added_monitors!(nodes[0], 1);
8519                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8520                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8521                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8522                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8523         }
8524         // Note that after leaving the above scope we have no knowledge of any arguments or return
8525         // values from previous calls.
8526         expect_pending_htlcs_forwardable!(nodes[1]);
8527         let events = nodes[1].node.get_and_clear_pending_events();
8528         assert_eq!(events.len(), 1);
8529         match events[0] {
8530                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8531                         assert!(payment_preimage.is_none());
8532                         assert_eq!(user_payment_id, 42);
8533                         assert_eq!(payment_secret, our_payment_secret);
8534                         // We don't actually have the payment preimage with which to claim this payment!
8535                 },
8536                 _ => panic!("Unexpected event"),
8537         }
8538 }
8539
8540 #[test]
8541 fn test_bad_secret_hash() {
8542         // Simple test of unregistered payment hash/invalid payment secret handling
8543         let chanmon_cfgs = create_chanmon_cfgs(2);
8544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8547
8548         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8549
8550         let random_payment_hash = PaymentHash([42; 32]);
8551         let random_payment_secret = PaymentSecret([43; 32]);
8552         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8553
8554         let logger = test_utils::TestLogger::new();
8555         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8556         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();
8557
8558         // All the below cases should end up being handled exactly identically, so we macro the
8559         // resulting events.
8560         macro_rules! handle_unknown_invalid_payment_data {
8561                 () => {
8562                         check_added_monitors!(nodes[0], 1);
8563                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8564                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8565                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8566                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8567
8568                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8569                         // again to process the pending backwards-failure of the HTLC
8570                         expect_pending_htlcs_forwardable!(nodes[1]);
8571                         expect_pending_htlcs_forwardable!(nodes[1]);
8572                         check_added_monitors!(nodes[1], 1);
8573
8574                         // We should fail the payment back
8575                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8576                         match events.pop().unwrap() {
8577                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8578                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8579                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8580                                 },
8581                                 _ => panic!("Unexpected event"),
8582                         }
8583                 }
8584         }
8585
8586         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8587         // Error data is the HTLC value (100,000) and current block height
8588         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8589
8590         // Send a payment with the right payment hash but the wrong payment secret
8591         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8592         handle_unknown_invalid_payment_data!();
8593         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8594
8595         // Send a payment with a random payment hash, but the right payment secret
8596         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8597         handle_unknown_invalid_payment_data!();
8598         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8599
8600         // Send a payment with a random payment hash and random payment secret
8601         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8602         handle_unknown_invalid_payment_data!();
8603         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8604 }
8605
8606 #[test]
8607 fn test_update_err_monitor_lockdown() {
8608         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8609         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8610         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8611         //
8612         // This scenario may happen in a watchtower setup, where watchtower process a block height
8613         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8614         // commitment at same time.
8615
8616         let chanmon_cfgs = create_chanmon_cfgs(2);
8617         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8618         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8619         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8620
8621         // Create some initial channel
8622         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8623         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8624
8625         // Rebalance the network to generate htlc in the two directions
8626         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8627
8628         // Route a HTLC from node 0 to node 1 (but don't settle)
8629         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8630
8631         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8632         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8633         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8634         let persister = test_utils::TestPersister::new();
8635         let watchtower = {
8636                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8637                 let monitor = monitors.get(&outpoint).unwrap();
8638                 let mut w = test_utils::TestVecWriter(Vec::new());
8639                 monitor.write(&mut w).unwrap();
8640                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8641                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8642                 assert!(new_monitor == *monitor);
8643                 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);
8644                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8645                 watchtower
8646         };
8647         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8648         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8649         // transaction lock time requirements here.
8650         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8651         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8652
8653         // Try to update ChannelMonitor
8654         assert!(nodes[1].node.claim_funds(preimage));
8655         check_added_monitors!(nodes[1], 1);
8656         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8657         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8658         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8659         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8660                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8661                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8662                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8663                 } else { assert!(false); }
8664         } else { assert!(false); };
8665         // Our local monitor is in-sync and hasn't processed yet timeout
8666         check_added_monitors!(nodes[0], 1);
8667         let events = nodes[0].node.get_and_clear_pending_events();
8668         assert_eq!(events.len(), 1);
8669 }
8670
8671 #[test]
8672 fn test_concurrent_monitor_claim() {
8673         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8674         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8675         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8676         // state N+1 confirms. Alice claims output from state N+1.
8677
8678         let chanmon_cfgs = create_chanmon_cfgs(2);
8679         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8680         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8681         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8682
8683         // Create some initial channel
8684         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8685         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8686
8687         // Rebalance the network to generate htlc in the two directions
8688         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8689
8690         // Route a HTLC from node 0 to node 1 (but don't settle)
8691         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8692
8693         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8694         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8695         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8696         let persister = test_utils::TestPersister::new();
8697         let watchtower_alice = {
8698                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8699                 let monitor = monitors.get(&outpoint).unwrap();
8700                 let mut w = test_utils::TestVecWriter(Vec::new());
8701                 monitor.write(&mut w).unwrap();
8702                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8703                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8704                 assert!(new_monitor == *monitor);
8705                 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);
8706                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8707                 watchtower
8708         };
8709         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8710         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8711         // transaction lock time requirements here.
8712         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8713         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8714
8715         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8716         {
8717                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8718                 assert_eq!(txn.len(), 2);
8719                 txn.clear();
8720         }
8721
8722         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8723         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8724         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8725         let persister = test_utils::TestPersister::new();
8726         let watchtower_bob = {
8727                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8728                 let monitor = monitors.get(&outpoint).unwrap();
8729                 let mut w = test_utils::TestVecWriter(Vec::new());
8730                 monitor.write(&mut w).unwrap();
8731                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8732                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8733                 assert!(new_monitor == *monitor);
8734                 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);
8735                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8736                 watchtower
8737         };
8738         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8739         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8740
8741         // Route another payment to generate another update with still previous HTLC pending
8742         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8743         {
8744                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8745                 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();
8746                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8747         }
8748         check_added_monitors!(nodes[1], 1);
8749
8750         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8751         assert_eq!(updates.update_add_htlcs.len(), 1);
8752         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8753         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8754                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8755                         // Watchtower Alice should already have seen the block and reject the update
8756                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8757                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8758                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8759                 } else { assert!(false); }
8760         } else { assert!(false); };
8761         // Our local monitor is in-sync and hasn't processed yet timeout
8762         check_added_monitors!(nodes[0], 1);
8763
8764         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8765         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8766         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8767
8768         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8769         let bob_state_y;
8770         {
8771                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8772                 assert_eq!(txn.len(), 2);
8773                 bob_state_y = txn[0].clone();
8774                 txn.clear();
8775         };
8776
8777         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8778         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8779         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);
8780         {
8781                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8782                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8783                 // the onchain detection of the HTLC output
8784                 assert_eq!(htlc_txn.len(), 2);
8785                 check_spends!(htlc_txn[0], bob_state_y);
8786                 check_spends!(htlc_txn[1], bob_state_y);
8787         }
8788 }
8789
8790 #[test]
8791 fn test_pre_lockin_no_chan_closed_update() {
8792         // Test that if a peer closes a channel in response to a funding_created message we don't
8793         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8794         // message).
8795         //
8796         // Doing so would imply a channel monitor update before the initial channel monitor
8797         // registration, violating our API guarantees.
8798         //
8799         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8800         // then opening a second channel with the same funding output as the first (which is not
8801         // rejected because the first channel does not exist in the ChannelManager) and closing it
8802         // before receiving funding_signed.
8803         let chanmon_cfgs = create_chanmon_cfgs(2);
8804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8806         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8807
8808         // Create an initial channel
8809         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8810         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8811         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8812         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8813         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8814
8815         // Move the first channel through the funding flow...
8816         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8817
8818         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8819         check_added_monitors!(nodes[0], 0);
8820
8821         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8822         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8823         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8824         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8825 }
8826
8827 #[test]
8828 fn test_htlc_no_detection() {
8829         // This test is a mutation to underscore the detection logic bug we had
8830         // before #653. HTLC value routed is above the remaining balance, thus
8831         // inverting HTLC and `to_remote` output. HTLC will come second and
8832         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8833         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8834         // outputs order detection for correct spending children filtring.
8835
8836         let chanmon_cfgs = create_chanmon_cfgs(2);
8837         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8838         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8839         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8840
8841         // Create some initial channels
8842         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8843
8844         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8845         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8846         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8847         assert_eq!(local_txn[0].input.len(), 1);
8848         assert_eq!(local_txn[0].output.len(), 3);
8849         check_spends!(local_txn[0], chan_1.3);
8850
8851         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8852         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8853         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8854         // We deliberately connect the local tx twice as this should provoke a failure calling
8855         // this test before #653 fix.
8856         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);
8857         check_closed_broadcast!(nodes[0], true);
8858         check_added_monitors!(nodes[0], 1);
8859         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8860
8861         let htlc_timeout = {
8862                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8863                 assert_eq!(node_txn[1].input.len(), 1);
8864                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8865                 check_spends!(node_txn[1], local_txn[0]);
8866                 node_txn[1].clone()
8867         };
8868
8869         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8870         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8871         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8872         expect_payment_failed!(nodes[0], our_payment_hash, true);
8873 }
8874
8875 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8876         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8877         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8878         // Carol, Alice would be the upstream node, and Carol the downstream.)
8879         //
8880         // Steps of the test:
8881         // 1) Alice sends a HTLC to Carol through Bob.
8882         // 2) Carol doesn't settle the HTLC.
8883         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8884         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8885         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8886         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8887         // 5) Carol release the preimage to Bob off-chain.
8888         // 6) Bob claims the offered output on the broadcasted commitment.
8889         let chanmon_cfgs = create_chanmon_cfgs(3);
8890         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8891         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8892         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8893
8894         // Create some initial channels
8895         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8896         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8897
8898         // Steps (1) and (2):
8899         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8900         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8901
8902         // Check that Alice's commitment transaction now contains an output for this HTLC.
8903         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8904         check_spends!(alice_txn[0], chan_ab.3);
8905         assert_eq!(alice_txn[0].output.len(), 2);
8906         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8907         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8908         assert_eq!(alice_txn.len(), 2);
8909
8910         // Steps (3) and (4):
8911         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8912         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8913         let mut force_closing_node = 0; // Alice force-closes
8914         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8915         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8916         check_closed_broadcast!(nodes[force_closing_node], true);
8917         check_added_monitors!(nodes[force_closing_node], 1);
8918         if go_onchain_before_fulfill {
8919                 let txn_to_broadcast = match broadcast_alice {
8920                         true => alice_txn.clone(),
8921                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8922                 };
8923                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8924                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8925                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8926                 if broadcast_alice {
8927                         check_closed_broadcast!(nodes[1], true);
8928                         check_added_monitors!(nodes[1], 1);
8929                 }
8930                 assert_eq!(bob_txn.len(), 1);
8931                 check_spends!(bob_txn[0], chan_ab.3);
8932         }
8933
8934         // Step (5):
8935         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8936         // process of removing the HTLC from their commitment transactions.
8937         assert!(nodes[2].node.claim_funds(payment_preimage));
8938         check_added_monitors!(nodes[2], 1);
8939         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8940         assert!(carol_updates.update_add_htlcs.is_empty());
8941         assert!(carol_updates.update_fail_htlcs.is_empty());
8942         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8943         assert!(carol_updates.update_fee.is_none());
8944         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8945
8946         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8947         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8948         if !go_onchain_before_fulfill && broadcast_alice {
8949                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8950                 assert_eq!(events.len(), 1);
8951                 match events[0] {
8952                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8953                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8954                         },
8955                         _ => panic!("Unexpected event"),
8956                 };
8957         }
8958         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8959         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8960         // Carol<->Bob's updated commitment transaction info.
8961         check_added_monitors!(nodes[1], 2);
8962
8963         let events = nodes[1].node.get_and_clear_pending_msg_events();
8964         assert_eq!(events.len(), 2);
8965         let bob_revocation = match events[0] {
8966                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8967                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8968                         (*msg).clone()
8969                 },
8970                 _ => panic!("Unexpected event"),
8971         };
8972         let bob_updates = match events[1] {
8973                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8974                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8975                         (*updates).clone()
8976                 },
8977                 _ => panic!("Unexpected event"),
8978         };
8979
8980         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8981         check_added_monitors!(nodes[2], 1);
8982         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8983         check_added_monitors!(nodes[2], 1);
8984
8985         let events = nodes[2].node.get_and_clear_pending_msg_events();
8986         assert_eq!(events.len(), 1);
8987         let carol_revocation = match events[0] {
8988                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8989                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8990                         (*msg).clone()
8991                 },
8992                 _ => panic!("Unexpected event"),
8993         };
8994         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8995         check_added_monitors!(nodes[1], 1);
8996
8997         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8998         // here's where we put said channel's commitment tx on-chain.
8999         let mut txn_to_broadcast = alice_txn.clone();
9000         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9001         if !go_onchain_before_fulfill {
9002                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9003                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9004                 // If Bob was the one to force-close, he will have already passed these checks earlier.
9005                 if broadcast_alice {
9006                         check_closed_broadcast!(nodes[1], true);
9007                         check_added_monitors!(nodes[1], 1);
9008                 }
9009                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9010                 if broadcast_alice {
9011                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9012                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9013                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9014                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9015                         // broadcasted.
9016                         assert_eq!(bob_txn.len(), 3);
9017                         check_spends!(bob_txn[1], chan_ab.3);
9018                 } else {
9019                         assert_eq!(bob_txn.len(), 2);
9020                         check_spends!(bob_txn[0], chan_ab.3);
9021                 }
9022         }
9023
9024         // Step (6):
9025         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9026         // broadcasted commitment transaction.
9027         {
9028                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9029                 if go_onchain_before_fulfill {
9030                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9031                         assert_eq!(bob_txn.len(), 2);
9032                 }
9033                 let script_weight = match broadcast_alice {
9034                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9035                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9036                 };
9037                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9038                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9039                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9040                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9041                 if broadcast_alice && !go_onchain_before_fulfill {
9042                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9043                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9044                 } else {
9045                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9046                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9047                 }
9048         }
9049 }
9050
9051 #[test]
9052 fn test_onchain_htlc_settlement_after_close() {
9053         do_test_onchain_htlc_settlement_after_close(true, true);
9054         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9055         do_test_onchain_htlc_settlement_after_close(true, false);
9056         do_test_onchain_htlc_settlement_after_close(false, false);
9057 }
9058
9059 #[test]
9060 fn test_duplicate_chan_id() {
9061         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9062         // already open we reject it and keep the old channel.
9063         //
9064         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9065         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9066         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9067         // updating logic for the existing channel.
9068         let chanmon_cfgs = create_chanmon_cfgs(2);
9069         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9070         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9071         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9072
9073         // Create an initial channel
9074         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9075         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9076         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9077         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()));
9078
9079         // Try to create a second channel with the same temporary_channel_id as the first and check
9080         // that it is rejected.
9081         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9082         {
9083                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9084                 assert_eq!(events.len(), 1);
9085                 match events[0] {
9086                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9087                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9088                                 // first (valid) and second (invalid) channels are closed, given they both have
9089                                 // the same non-temporary channel_id. However, currently we do not, so we just
9090                                 // move forward with it.
9091                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9092                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9093                         },
9094                         _ => panic!("Unexpected event"),
9095                 }
9096         }
9097
9098         // Move the first channel through the funding flow...
9099         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9100
9101         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9102         check_added_monitors!(nodes[0], 0);
9103
9104         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9105         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9106         {
9107                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9108                 assert_eq!(added_monitors.len(), 1);
9109                 assert_eq!(added_monitors[0].0, funding_output);
9110                 added_monitors.clear();
9111         }
9112         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9113
9114         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9115         let channel_id = funding_outpoint.to_channel_id();
9116
9117         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9118         // temporary one).
9119
9120         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9121         // Technically this is allowed by the spec, but we don't support it and there's little reason
9122         // to. Still, it shouldn't cause any other issues.
9123         open_chan_msg.temporary_channel_id = channel_id;
9124         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9125         {
9126                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9127                 assert_eq!(events.len(), 1);
9128                 match events[0] {
9129                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9130                                 // Technically, at this point, nodes[1] would be justified in thinking both
9131                                 // channels are closed, but currently we do not, so we just move forward with it.
9132                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9133                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9134                         },
9135                         _ => panic!("Unexpected event"),
9136                 }
9137         }
9138
9139         // Now try to create a second channel which has a duplicate funding output.
9140         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9141         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9142         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9143         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()));
9144         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9145
9146         let funding_created = {
9147                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9148                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9149                 let logger = test_utils::TestLogger::new();
9150                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9151         };
9152         check_added_monitors!(nodes[0], 0);
9153         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9154         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9155         // still needs to be cleared here.
9156         check_added_monitors!(nodes[1], 1);
9157
9158         // ...still, nodes[1] will reject the duplicate channel.
9159         {
9160                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9161                 assert_eq!(events.len(), 1);
9162                 match events[0] {
9163                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9164                                 // Technically, at this point, nodes[1] would be justified in thinking both
9165                                 // channels are closed, but currently we do not, so we just move forward with it.
9166                                 assert_eq!(msg.channel_id, channel_id);
9167                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9168                         },
9169                         _ => panic!("Unexpected event"),
9170                 }
9171         }
9172
9173         // finally, finish creating the original channel and send a payment over it to make sure
9174         // everything is functional.
9175         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9176         {
9177                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9178                 assert_eq!(added_monitors.len(), 1);
9179                 assert_eq!(added_monitors[0].0, funding_output);
9180                 added_monitors.clear();
9181         }
9182
9183         let events_4 = nodes[0].node.get_and_clear_pending_events();
9184         assert_eq!(events_4.len(), 0);
9185         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9186         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9187
9188         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9189         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9190         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9191         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9192 }
9193
9194 #[test]
9195 fn test_error_chans_closed() {
9196         // Test that we properly handle error messages, closing appropriate channels.
9197         //
9198         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9199         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9200         // we can test various edge cases around it to ensure we don't regress.
9201         let chanmon_cfgs = create_chanmon_cfgs(3);
9202         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9203         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9204         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9205
9206         // Create some initial channels
9207         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9208         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9209         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9210
9211         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9212         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9213         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9214
9215         // Closing a channel from a different peer has no effect
9216         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9217         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9218
9219         // Closing one channel doesn't impact others
9220         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9221         check_added_monitors!(nodes[0], 1);
9222         check_closed_broadcast!(nodes[0], false);
9223         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9224         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9225         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);
9226         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);
9227
9228         // A null channel ID should close all channels
9229         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9230         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9231         check_added_monitors!(nodes[0], 2);
9232         let events = nodes[0].node.get_and_clear_pending_msg_events();
9233         assert_eq!(events.len(), 2);
9234         match events[0] {
9235                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9236                         assert_eq!(msg.contents.flags & 2, 2);
9237                 },
9238                 _ => panic!("Unexpected event"),
9239         }
9240         match events[1] {
9241                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9242                         assert_eq!(msg.contents.flags & 2, 2);
9243                 },
9244                 _ => panic!("Unexpected event"),
9245         }
9246         // Note that at this point users of a standard PeerHandler will end up calling
9247         // peer_disconnected with no_connection_possible set to false, duplicating the
9248         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9249         // users with their own peer handling logic. We duplicate the call here, however.
9250         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9251         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9252
9253         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9254         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9255         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9256 }
9257
9258 #[test]
9259 fn test_invalid_funding_tx() {
9260         // Test that we properly handle invalid funding transactions sent to us from a peer.
9261         //
9262         // Previously, all other major lightning implementations had failed to properly sanitize
9263         // funding transactions from their counterparties, leading to a multi-implementation critical
9264         // security vulnerability (though we always sanitized properly, we've previously had
9265         // un-released crashes in the sanitization process).
9266         let chanmon_cfgs = create_chanmon_cfgs(2);
9267         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9268         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9269         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9270
9271         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9272         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()));
9273         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()));
9274
9275         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9276         for output in tx.output.iter_mut() {
9277                 // Make the confirmed funding transaction have a bogus script_pubkey
9278                 output.script_pubkey = bitcoin::Script::new();
9279         }
9280
9281         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9282         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()));
9283         check_added_monitors!(nodes[1], 1);
9284
9285         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()));
9286         check_added_monitors!(nodes[0], 1);
9287
9288         let events_1 = nodes[0].node.get_and_clear_pending_events();
9289         assert_eq!(events_1.len(), 0);
9290
9291         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9292         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9293         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9294
9295         confirm_transaction_at(&nodes[1], &tx, 1);
9296         check_added_monitors!(nodes[1], 1);
9297         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9298         assert_eq!(events_2.len(), 1);
9299         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9300                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9301                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9302                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9303                 } else { panic!(); }
9304         } else { panic!(); }
9305         assert_eq!(nodes[1].node.list_channels().len(), 0);
9306 }
9307
9308 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9309         // In the first version of the chain::Confirm interface, after a refactor was made to not
9310         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9311         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9312         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9313         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9314         // spending transaction until height N+1 (or greater). This was due to the way
9315         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9316         // spending transaction at the height the input transaction was confirmed at, not whether we
9317         // should broadcast a spending transaction at the current height.
9318         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9319         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9320         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9321         // until we learned about an additional block.
9322         //
9323         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9324         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9325         let chanmon_cfgs = create_chanmon_cfgs(3);
9326         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9327         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9328         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9329         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9330
9331         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9332         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9333         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9334         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9335         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9336
9337         nodes[1].node.force_close_channel(&channel_id).unwrap();
9338         check_closed_broadcast!(nodes[1], true);
9339         check_added_monitors!(nodes[1], 1);
9340         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9341         assert_eq!(node_txn.len(), 1);
9342
9343         let conf_height = nodes[1].best_block_info().1;
9344         if !test_height_before_timelock {
9345                 connect_blocks(&nodes[1], 24 * 6);
9346         }
9347         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9348                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9349         if test_height_before_timelock {
9350                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9351                 // generate any events or broadcast any transactions
9352                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9353                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9354         } else {
9355                 // We should broadcast an HTLC transaction spending our funding transaction first
9356                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9357                 assert_eq!(spending_txn.len(), 2);
9358                 assert_eq!(spending_txn[0], node_txn[0]);
9359                 check_spends!(spending_txn[1], node_txn[0]);
9360                 // We should also generate a SpendableOutputs event with the to_self output (as its
9361                 // timelock is up).
9362                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9363                 assert_eq!(descriptor_spend_txn.len(), 1);
9364
9365                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9366                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9367                 // additional block built on top of the current chain.
9368                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9369                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9370                 expect_pending_htlcs_forwardable!(nodes[1]);
9371                 check_added_monitors!(nodes[1], 1);
9372
9373                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9374                 assert!(updates.update_add_htlcs.is_empty());
9375                 assert!(updates.update_fulfill_htlcs.is_empty());
9376                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9377                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9378                 assert!(updates.update_fee.is_none());
9379                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9380                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9381                 expect_payment_failed!(nodes[0], payment_hash, false);
9382                 expect_payment_failure_chan_update!(nodes[0], chan_announce.contents.short_channel_id, true);
9383         }
9384 }
9385 #[test]
9386 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9387         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9388         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9389 }